pdrm command: removes jobs

Syntax

pdrm [-H host:port] [-m "MessageText"] [-r JobRetentionPeriod]     
[-x "attribute=value …"] [-X AttributesFileName]     
{LocalJobID … | GlobalJobID …}

pdrm -h

Description

Use the pdrm command to remove (delete) previously submitted jobs.

    Note:
  1. If the job you specify is currently printing or sending, InfoPrint can only remove it at a pausable point in the job. The pausable point at which the InfoPrint can remove the job depends on the type of output device. A pausable point might be immediate or it might be the next page, sheet, document, or job boundary. If there is no such point before the end of job, InfoPrint does not remove the job.
  2. When you request InfoPrint to remove a job with a non-zero value for the job-retention-period, job-retain-until, or retain-forever attribute, InfoPrint retains the job as specified by the retention-period attributes.
  3. You can remove your own jobs by specifying either the local ID or the global ID for the job. You can remove jobs belonging to another person by specifying the global ID for the job.

    InfoPrint issues a confirmation message before deleting jobs, unless the environment variable PD_CONFIRM_DELETE for the person requesting the job removal has a value of no.

Flags

You can use these flags with the pdrm command:

-H host: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.

-m "MessageText"
Specifies the message you that want to associate with the specified job. The specified text becomes the value of the job-message-from-administrator attribute. You can use it to provide the reason you are removing the job or to provide any other comments. If you do not specify the -m flag, the message already stored with the job remains unchanged.

You can list this message by specifying requested-attributes=job-message-from-administrator with the pdls command.

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

-r JobRetentionPeriod
Specifies the period of time you want the server to retain the job before InfoPrint deletes the job. If specified, this retention period takes precedence over the previous job-retention period set for the job. If you do not specify a retention period with the -r flag, InfoPrint uses the current value of the job-retain-until, job retention-period, or retain-forever attribute.

Using this flag is equivalent to specifying the job object attribute job-retention-period.

-x "attribute=value …"
Consists of a single attribute string, containing one or more attribute-value pairs.
-X AttributesFileName
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:

  1. Server host and server port specified with the -H parameter.
  2. Server host and server port specified with the PDHOST and PD_SOCKET envirnonment variables.
  3. 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 define these attributes in a -x "attribute=value …" string or in an attributes file designated in 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.
message="MessageText"
Specifies the message that you want InfoPrint to store in the job-message-from-administrator attribute. You can use it to provide the reason you are removing the job or to provide any other comments. If you do not specify the message attribute, the message already stored with the job remains unchanged.

You can list this message by specifying requested-attributes=job-message-from-administrator with the pdls command.

Arguments

Use the argument value to identify the specific job you want to remove. You must use one of these arguments for the pdrm command:

LocalJobID or GlobalJobID
Specifies the local ID or global ID of the job that you want InfoPrint to remove.

This argument must appear last in the command. To remove more than one job, separate the job identifiers with spaces.

Examples

  • Remove your own job

    To remove your job with the local ID of 15, enter the command:

    pdrm 15

  • Remove another user's job

    To remove the job with global ID Server1:1011223002 on server Server1, enter the command:

    pdrm Server1:1011223002

  • Remove job regardless of retention time

    To remove your job with the local ID of 10 as soon as possible, regardless of any previously specified job-retention-period attribute value, enter the command:

    pdrm -r 0 10