pdset command: defines attribute values

Syntax

pdset [-H host:port] [-c ObjectClass] [-g] [-m "MessageText"] 
[-r "attribute …"] [-s StyleName] 
[-x "attribute=value …"] [-X AttributesFileName] 
{ServerName … |  ServerName:AuxiliarySheetName … | 
ServerName:DefaultDocumentName … | 
ServerName:DefaultJobName … | 
[ServerName:]DestinationName … | ServerName:LogName … | 
ServerName:MediumName … |[ServerName:]QueueName … | 
ServerName:ResourceContextName … | 
ServerName:TransformName … | 
LocalJobID … | 
GlobalJobID …}

pdset -h

Description

Use the pdset administrative command to define or modify the values of object attributes.

If SNMPv1 is enabled on an actual destination and the snmp-write-community-name attribute on the actual destination is set properly, you can set information directly on the device associated with the actual destination by setting device-specific actual destination attributes. If SNMPv3 is enabled on an actual destination and the snmpv3-username attribute on the actual destination is set properly, you can set information directly on the device associated with the actual destination by setting device-specific actual destination attributes. For more information about device-specific attributes, see “About SNMP communication” in the RICOH InfoPrint Manager for AIX: Procedures, RICOH InfoPrint Manager for Linux: Procedures, or RICOH InfoPrint Manager for Windows: Procedures. For a description of the individual device-specific actual destination attributes, see InfoPrint Manager object attributes.

You must disable an actual destination before you can modify its attributes. However, you do not need to disable an actual destination to change values for device-specific information, such as the device-contact or device-location attributes.

You cannot set actual destination and device-specific attributes in the same pdset command.

For more information about device-specific attributes, see “Working with SNMP Printers” in RICOH InfoPrint Manager for AIX: Procedures, RICOH InfoPrint Manager for Linux: Procedures, or RICOH InfoPrint Manager for Windows: Procedures.

The next table lists the four modification operators.

pdset operators

Operator	Syntax	Description
Replace	attribute=value	Replaces the entire value of the attribute with value or adds the attribute to the object, if not already present.
Add values	attribute+=value	Adds the value to the attribute. You cannot add values to single-valued attributes. InfoPrint honors an add request that duplicates values on a multi-valued attribute without warning.
Remove values	attribute-=value	Removes the value from the attribute. InfoPrint ignores a remove request for a nonexistent value, without warning or error. A remove request for the last or only value of an attribute is equivalent to a reset-to-default request.
Reset to default	attribute==	Sets the attribute value to the default. If you supply values with a reset-to-default request, InfoPrint ignores them.

If you do not specify a value with a replace, add, or remove request, InfoPrint issues an error and rejects the request to change the object.

You can only use the Replace operator of the pdset command with device-specific attributes.

You can only change values for resettable attributes using the pdset command. Using this command for non-settable or initially settable attributes results in an error.

See InfoPrint Manager object attributes for lists of all resettable attributes by object and a description of each attribute.

Changes made to objects are permanent and remain changed even if you shut down and then restart the system (except for logs).

If the ignore-ivo-values attribute is set to true on the server and the request is to default or remove a value and there are no values left for that attribute, InfoPrint Manager ignores the value of the job and document default attribute when setting its value. See the ignore-ivo-values attribute.

Flags

You can use these flags with the pdset command:

-Hhost:port

Identifies the host and port of the InfoPrint Manager server used for communication. When not specified, the command follows the Configuration logic to define the host and socket.

-c {destination | job | server | queue | auxiliary-sheet | document | initial-value-job | initial-value-document | medium | resource-context | transform | log} DEFAULT=destination

Specifies the object class that you want for this command. In the valid classes, destination is for a logical destination or actual destination.

Using this flag is equivalent to specifying the command attribute operation-class.

-g

Turns off headings.

Using this flag is equivalent to specifying the command attribute headings=false.

-m"MessageText"

Specifies the message that you want to associate with the object that you want to modify. You can use this message to indicate the reason why you are modifying or setting object attributes or to provide any other comments.

If the command operates on a job, you can list this message by specifying requested-attributes=job-message-from-administrator with the pdls command. Otherwise, you can list this message by specifying requested-attributes=message with the pdls command.

If you do not specify the -m flag, the message already stored with the object remains unchanged.

Using this flag is equivalent to specifying the command attribute message.

-r {none | brief | verbose} DEFAULT=none

Specifies the attribute values you want to display for the specified object.

none: Displays no attributes.
brief: Displays a small subset of important attributes for each object.
verbose: Displays a larger subset of important attributes for each object.

Using this flag is equivalent to specifying the command attribute requested-attributes.

-s {column | doccol | line} DEFAULT=column

Specifies the format in which you want InfoPrint to display the attributes.

column: Attribute values are displayed in tabular format, so that values of the same attribute for multiple objects line up in columns.
doccol: For jobs only, job attribute values and the document attribute values for the first document in the job are displayed in column format on the same line.
line: Each attribute is displayed on a separate line.

Using this flag is equivalent to specifying the command attribute style.

-x"attribute=value …"

A single attribute string, consisting of one or more attribute-value pairs. Prefix the attribute value with the replace operator, = , to replace a value, the add-value operator, += , to add a value or the remove-value operator, -= , to remove a value. Use the reset-to-default operator, == , with no attribute value to set the value to its default.

-XAttributesFileName

Specifies the name of a file containing attribute and value pairs that you want InfoPrint to insert at the current point in the command.

Using this flag is equivalent to specifying the command attribute attributes.

-h

Displays a command-specific help message containing information about command syntax and flags. If you use this flag with any other flag or attribute, InfoPrint recognizes only the -h flag.

Configuration logic

The command determines which server host and server port to use based on this sequence:

Server host and server port specified with the -H parameter.
Server host and server port specified with the PDHOST and PD_SOCKET envirnonment variables.
Uses the defaults for PDHOST=localhost and PD_SOCKET=6874.

Note: This configuration logic enables multiple commands to run on a single machine communicating with one or more InfoPrint Manager servers.

Command attributes

You can specify these attributes in a -x "attribute=value …" string or in an attributes file designated with the -X AttributesFileName flag.

attributes=AttributesFileName

Specifies the designated attributes file that InfoPrint reads and inserts at the current point in the command. This file contains attribute and value pairs that InfoPrint uses to expand the command.

operation-class={destination | job | server | queue | auxiliary-sheet | document | initial-value-job | initial-value-document | medium | resource-context | transform | log} DEFAULT=destination

Specifies the object class you want for this command. In the valid classes, destination is for a logical destination or actual destination.

headings={true | false} DEFAULT=true

Specifies if you want InfoPrint to display headings on the output.

message="MessageText"

Specifies the message that you want to associate with the object you are modifying. You can use this message to indicate the reason that you are modifying the object attributes or to provide any other comments.

If the command operates on a job, you can list this message by specifying requested-attributes=job-message-from-administrator with the pdls command. Otherwise, you can list this message by specifying requested-attributes=message with the pdls command.

If you do not specify the message attribute, the message already stored with the object remains unchanged.

requested-attributes={none | verbose | brief} DEFAULT=none

Specifies the attribute values you want to display for the specified object.

none: Displays no attributes.
brief: Displays a small subset of important attributes for each object.
verbose: Displays a larger subset of important attributes for each object.

style={column | doccol | line} DEFAULT=column

Specifies the presentation format in which you want the output displayed.

column: Attribute values are displayed in tabular format, so that values of the same attribute for multiple objects line up in columns.
doccol: For jobs only, job attribute values and the document attribute values for the first document in the job are displayed in column format on the same line.
line: Each attribute is displayed on a separate line.

Arguments

Use the argument value to identify the specific object for which you want to set or modify attributes. If you specify multiple objects, separate the object names with spaces.

You can use these arguments with the pdset command:

ServerName:AuxiliarySheetName
ServerName:DefaultJobName
ServerName:DefaultDocumentName
ServerName:MediumName
ServerName:LogName
[ServerName:]DestinationName
[ServerName:]QueueName
ServerName:ResourceContextName
ServerName:TransformName
ServerName
LocalJobID
GlobalJobID

By default, end users do not have permission to modify jobs. Therefore, in most cases someone other than the job submitter will modify a job and must identify the job by the global job ID. Job submitters who do have permission to modify jobs can identify their own jobs by the local job ID.

Examples

Specify a descriptor for a server
To set a description for the server Server1 and identify the processor name containing it and the TCP/IP address for the processor, enter the command:
```
pdset -c server -x "descriptor='Server Server1 is installed on 
   cowboy.  The TCP/IP address for cowboy is 9.99.9.143.'" Server1
```
Change the operator to receive messages
To identify a new person to receive start and stop messages for actual destination Serv4-pp, enter the command:
```
pdset -c destination -x "notify-operator=electronic-mail:ro@cowboy" 
   Serv4-pp
```
Set the job size range
To set the size of jobs that users can submit to actual destination small-pp, enter the command:
```
pdset -x "job-size-range-supported=0:10000 
   job-size-range-ready=0:10000" small-pp
```
Specify media supported by an actual destination
To specify the media supported by a given actual destination and the media currently loaded in the printer device, enter the command:
```
pdset -x "media-supported=letter na-letter-colored
    legal na-legal-colored A4 A4-colored
    psf-tray-characteristics=top:letter
    bottom:A4" Serv4-pp
```
Set a message
To set the message for server Serv2, enter the command:
```
pdset -c server -m "printing system now ok" Serv2
```
Setting the snmp-write-community-name
If SNMPv1 is active, to set the snmp-write-community-name, enter:
```
pdset -cp -x s-w-c-n=ibmpsc_admin ip21 
```
Setting the snmpv3-username
If SNMPv3 is active, to set the snmpv3-username, enter:
```
pdset -cp -x s-u=ibmpsc_admin ip21 
```
Setting the device location
If SNMPv1 is active and snmp-write-community-name is set appropriately or if SNMPv3 is active and snmpv3-username is set appropriately, and you want to set the device location on the device associated with the prt5-ad actual destination, enter:
```
pdset -x"device-location='First floor, Bldg 005/Boulder, Colorado'"  
   prt5-ad  
```

RICOH InfoPrint Manager™ for Linux