Command attributes

You can specify these attributes in a -x"attribute=value ..." string or in an attributes file designated with the -XAttributesFileName 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.
associated-actual-destinations=true|false
Specifies whether you want to have information displayed for a logical destination's associated actual destinations as well as the logical destination specified as the command argument. Associated actual destinations are defined as those listed on a logical destinations default job's actual-destinations-requested attribute, or if no actual destinations are listed, then all the actual destinations associated with the same queue as the logical destination.
operation-class={job | associated-actual-destination | auxiliary-sheet | document | initial-value-document | initial-value-job | log | medium | destination | queue | resource-context| transform | server}
Specifies the object class of the object whose attributes you want listed. All object classes are valid.
filter="FilterCriteria"
Specifies the selection criteria you want InfoPrint to use to select a subset from the candidate objects (if you request attribute values for multiple objects). A filter is a logical expression consisting of relations of attributes to attribute values. Among the objects you specify, InfoPrint returns only objects whose attribute values match the filter expression.

You can only use attributes for the object class (job, auxiliary-sheet, document, initial-value-document, initial-value-job, log, medium, destination, queue, resource-context, transform, or server) that you specify in the command. The filter can contain an attribute other than one of those you are requesting.

Attribute operators for filters

Operation Operator Strings Integers Time Format
Equal == Yes Yes Yes
Match first part of a value =* Yes Yes Yes
Match last part of a value *= Yes Yes Yes
Match any part of a value; such as a sub-string *=* Yes Yes Yes
Attribute present (any value) ==* Yes Yes Yes
Note: When you test for attribute presence, InfoPrint evaluates the filter item as true when the attribute has a value, not just when the attribute exists. You might need a false value to satisfy the requirement, as long as the false value conforms to the general syntax.
Match approximately; for case-insensitive sub-string ~= Yes No No
    Note:
  1. An approximate match occurs when at least half of the target string, regardless of starting position, matches the filter value.
  2. A case-insensitive match occurs when the target string can have a mix of uppercase and lowercase characters, but the characters do match.
Match a value greater than that specified > No Yes Yes
Match a value less than that specified < No Yes Yes

This list shows the filter syntax:

  1. A filter item consisting of an attribute name, operator, and value. Attribute operators for filters shows the operators and the data formats you can use to separate the attribute and value.
  2. In Attribute operators for filters, the attribute-present operation consists of an attribute name followed by the equality operator followed by an * in place of an attribute value. For example: 
    -f "media-ready==*"
    If the attribute has no value, InfoPrint evaluates the filter item as false. InfoPrint evaluates the filter item as true if the attribute has any assigned value.
  3. InfoPrint can compare each attribute in a filter item to only one attribute value. To compare an attribute to more than one value, or to filter more than one attribute, separate the filter items with one of these operators:
    The AND operator ("&&")
    FilterItem && FilterItem

    The expression evaluates to true only if both filter items evaluate to true.

    The OR operator ("||")
    FilterItem || FilterItem

    The expression evaluates to true if either of the filter items evaluate to true.

  4. To evaluate a filter item as false, use the NOT operator before the filter item and enclose the filter item in parentheses.
    Note: With InfoPrint Manager for AIX or InfoPrint Manager for Linux, depending on the shell you are using, you might need to place quotation marks before and after the parentheses.
    The NOT operator !
    ! (FilterItem)

    If the filter item evaluates to true, the expression is false.

    If the filter item evaluates to false, the expression is true.

  5. When you use multiple logical operators in a filter, InfoPrint evaluates them in an order of precedence. You can override the order of precedence by using parentheses, ( ).
    Note: Depending on the shell you are using, you might need to place quotation marks before and after the parentheses. See Filter syntax for the order of precedence.

The next table summarizes the filter syntax. The table lists the operators in the order of precedence from highest to lowest.

Filter syntax

Operators Placement
Parentheses: ( ) Around filter items
Relational operators: > < Between attribute and value
Equality operators: == Between attribute and value
String matching: =* *= *=* ~= Between attribute and value
NOT Operator: ! Before (filter-item) only
AND operator: && Between two filter items
OR operator: || Between two filter items
headings= {true| false} DEFAULT=true
Specifies whether you want the output displayed with or without headings.
message-count=number
When you request the log-messages log attribute, this specifies the number of previous messages you want to see starting from the last message logged. The value you can specify for number can be an integer from 1 through 2147483647.

Use this command attribute with the log-messages log attribute to query for error log information. For example: 

pdls -c log -r log-messages -x "message-count=4" Serv1:
displays the last four messages contained in the error log for server Serv1.

requested-attributes={brief | verbose | archive | "attribute ...:"all | all-device | none} DEFAULT=brief
Specifies the group of attributes you want to display for the specified job, auxiliary-sheet, document, default document, default job, log, medium, destination, queue, resource-context, or server object.
brief
Displays a small subset of important attributes for each object.
verbose
Displays a larger subset of important attributes for each object.
archive
Writes only initially settable and resettable attributes to an archive file (see Create an archive file).
attribute …
Displays the attributes you specify.
all
Displays all attributes.
all-device
Displays all device attributes from the device associated with an actual destination.
none
Displays no attributes.

If you specify more than one of these values, InfoPrint displays all the attributes requested.

retained-jobs-only= {true| false}
Displays information for retained jobs only.
style={column | doccol | line} DEFAULT={ column | line }
The format in which you want the attributes displayed.
column
Attribute values are displayed in tabular format, so that values of the same attribute for multiple objects line up in columns. This is the default for requested-attributes=brief and requested-attributes=verbose.
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. This is the default for requested-attributes=all, requested-attributes="attribute …:", and requested-attributes=archive.
when=now
When you specify when=now with object class destination, the InfoPrint Server returns its current information regarding the destinations instead of performing SNMP queries to get any updates. If you have many SNMP destinations, the use of this command attribute improves the performance of your pdls request.

For example, to list the brief attributes of all the destinations in Server1 and request that Server1 does not make SNMP queries to get the latest information but just returns its most current information, use this command: 

pdls -c dest -xwhen=now Server1:

Parent topic: pdls command: lists selected attribute values