pdpause command: pauses jobs, actual destinations, servers, or queues

Syntax

pdpause [-H host:port] [-c destination] [-m "MessageText"] [-n]
[-x "attribute=value …"] [-X AttributesFileName]
[-w {now | after-current-copy | after-current-job}]
[ServerName:]DestinationName …

pdpause -j [-m "MessageText"]
[-x "attribute=value …"] [-X AttributesFileName]
[-w {now | after-current-copy}] [ServerName:]DestinationName …

pdpause -c job [-m "MessageText"] [-x "attribute=value …"]
[-X AttributesFileName] [-w {now | after-current-copy}]
{LocalJobID … | GlobalJobID …}

pdpause -c queue [-m "MessageText"] [-x "attribute=value …"]
[-X AttributesFileName] [ServerName:]QueueName …

pdpause -c server [-m "MessageText"] [-n]
[-x "attribute=value …"] [-X AttributesFileName]
[-w {now | after-current-copy | after-current-job}]
ServerName … 

pdpause -h

Description

Use the pdpause administrative command to pause an object that holds jobs or to pause a job.

You can pause these objects:

  • Jobs that are
    • pending
    • held
    • ripping
    • imposing
    • processing
    • printing
  • Actual destinations
  • Queues
  • Servers (pauses all of the queues and actual destinations contained in a server)

To resume a paused object, use the pdresume command.

    Note:
  1. Use the pdpause and pdresume commands to prevent or allow output from the object.
  2. Use the pddisable and pdenable commands to prevent or allow input to the object.
  3. You cannot pause PSF upload-TCP/IP-attached physical printers.
  4. You cannot pause jobs on a PSF-other or a PSF-command actual destination.
  5. You cannot pause an AnyPlace queue.

Flags

You can use these flags with the pdpause 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.

-c {destination | queue | job | server} DEFAULT=destination
Specifies the object class you want to pause. In the valid classes, destination is an actual destination.

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

-j
This flag is only valid when you use it with object-class destination. Use this flag to pause the currently printing job on the specified actual destination. The actual destination must be a physical printer, not an email destination.
-m "MessageText"
Specifies the message you want to associate with the specified destination, queue, job, or server that you are pausing. You can use this message to indicate the reason that you are pausing the object or to provide any other comments.

When pausing a server, InfoPrint propagates the message to the message attribute of the actual destinations and queues residing in the server.

If the command operates on a destination or a queue, you can list this message by specifying requested-attributes=message with the pdls command.

When the command operates on a job, the specified text becomes the value of the job-message-from-administrator attribute. You can list this message by specifying requested-attributes=job-message-from-administrator with the pdls command.

If you do not specify the -m flag, the message already stored with the destination, queue, job, or server remains unchanged.

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

-n
Causes the destination to do an NPRO (move the last printed page to the stacker). Using this flag is equivalent to specifying the command attribute non-process-runout=true.

This flag is valid only with object class destination or server. It is not valid with the -j flag. It is valid only for PSF physical printers and for servers containing them.

-w {now | after-current-copy | after-current-job} DEFAULT=now
Specifies when to pause the destination, job, or server. If you specify:
now
and the paused object is a:
destination
The destination pauses as soon as possible. How long this takes depends on the output device.
job
The job pauses as soon as possible. If the job is processing or printing, how long this takes depends on the output device.
Note: If you only want to get the job off the printer immediately, you can use the pdmod command:
pdmod -xjob-hold=true
This will send the job back to the held queue and reprint all the pages in the job.
server
The server pauses as soon as possible. How long this takes depends on the output devices represented by the destinations in the server.
after-current-copy
and the paused object is a:
destination
The destination pauses after the current copy of the current job finishes printing.
job
The job pauses after the current copy finishes printing.
server
The server pauses after the current copy of the current job on each actual destination in the server finishes printing.

This value is valid only for PSF physical printers, for jobs printing on PSF physical printers, and for servers containing PSF physical printers.

after-current-job
and the paused object is a:
destination
The destination pauses after the current job finishes printing.
server
The server pauses after the current job on each actual destination in the server finishes printing.

This value is not valid for jobs, including jobs paused with the -j flag. It is valid only for PSF physical printers and for servers containing PSF physical printers.

Specifying this flag is equivalent to specifying the command attribute when.

-x "attribute=value …"
A single attribute string, consisting of one or more attribute-value pairs.
-X AttributesFileName
Specifies the name of a file containing attribute and value pairs you want inserted 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. This flag and any other flag are mutually exclusive (if you use it 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 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 | queue | job | server} DEFAULT=destination
Specifies the object class that you want to pause. In the valid classes, destination is an actual destination.
message="MessageText"
Specifies the message that you want to associate with the specified destination, queue, job, or server that you are pausing. You can use this message to indicate the reason you are pausing the object or to provide any other comments.

When pausing a server, InfoPrint propagates the message to the message attribute of the actual destinations and queues residing in the server. InfoPrint does not change the server message attribute.

If the command operates on a destination or a queue, you can list this message by specifying requested-attributes=message with the pdls command.

When the command operates on a job, the specified text becomes the value of the job-message-from-administrator attribute. You can list this message by specifying requested-attributes=job-message-from-administrator with the pdls command.

If you do not specify the message attribute, the message already stored with the destination, queue, job, or server remains unchanged.

non-process-runout={true | false} DEFAULT=false
Specifies whether the destination should do an NPRO (move the last printed page to the stacker). This attribute is valid only with object class destination or server. It is not valid with the -j flag. It is valid only for PSF physical printers and for servers containing them.
when={now | after-current-copy | after-current-job} DEFAULT=now
Specifies when to pause the destination, job, or server. If you specify:
now
and the paused object is a:
destination
The destination pauses as soon as possible. How long this takes depends on the output device.
job
The job pauses as soon as possible. If the job is processing or printing, how long this takes depends on the output device.
Note: If you only want to get the job off the printer immediately, you can use the pdmod command:
pdmod -xjob-hold=true
This will send the job back to the held queue and reprint all the pages in the job.
server
The server pauses as soon as possible. How long this takes depends on the output devices represented by the destinations in the server.
after-current-copy
and the paused object is a:
destination
The destination pauses after the current copy of the current job finishes printing.
job
The job pauses after the current copy finishes printing.
server
The server pauses after the current copy of the current job on each actual destination in the server finishes printing.

This value is valid only for PSF physical printers, for jobs printing on PSF physical printers, and for servers containing PSF physical printers.

after-current-job
and the paused object is a:
destination
The destination pauses after the current job finishes printing.
server
The server pauses after the current job on each actual destination in the server finishes printing.

This value is not valid for jobs, including jobs paused with the -j flag. It is valid only for PSF physical printers and for servers containing PSF physical printers.

Arguments

Use the argument value to identify the specific object that you want to pause. If you specify multiple objects, all of the objects must belong to the same class and you must separate the object names with spaces.

You can use these arguments with the pdpause command:

LocalJobID… or GlobalJobID
Specifies the jobs that you want to pause as determined by a local job identifier or global job identifier. In most cases someone other than the job submitter will pause a job and must identify it by the global job ID. Job submitters who do have authority to pause jobs can identify their own jobs by the local job ID.

These actions take place when you cause InfoPrint to pause:

A ripping or imposing job:
  • The job stops. If the first pages of the job have started to print or send while the last pages are ripping or imposing, the job is treated like a printing job.
  • The job state changes to paused.
  • The destination remains available to accept work.
  • InfoPrint can assign other jobs to the destination.
A processing or printing job:
  • The job stops.
    • If you specify -w=after-current-copy, the job stops after the current copy finishes printing.
    • Otherwise, the job stops as soon as possible. How long this takes depends on the type of output device printing or sending the job.
      Note: If you only want to get the job off the printer immediately, you can use the pdmod command:
      pdmod -xjob-hold=true
      This will send the job back to the held queue and reprint all the pages in the job.
  • The job state changes to paused.
  • The destination remains available to accept work.
  • InfoPrint can assign other jobs to the destination.
A pending job:
InfoPrint prevents scheduling of the job but does not affect any destination.
A held job:
InfoPrint prevents the job from becoming pending, even if you or InfoPrint removes the reason for the job hold. For example, the specified job-print-after time expires.

Paused jobs remain in the queue until someone resumes or cancels them. InfoPrint allows modification of a paused job, but you cannot resubmit the job until you issue a pdresume command for the job.

Note: If you modify a paused job, it resumes at the beginning, not at the point where it paused.
[ServerName:]DestinationName
Specifies the destinations you want to pause. The action taken depends on whether you include the -j flag in the command.
Without the -j flag:
  • The destination stops.
    • If you specify -w=after-current-job, the destination stops after the current job finishes printing.
    • If you specify -w=after-current-copy, the destination stops after the current copy finishes printing.
    • Otherwise, the destination stops as soon as possible. How long this takes depends on the type of output device.
  • InfoPrint changes the destination state to paused.
  • InfoPrint leaves the job state unchanged; the job is still assigned to the destination.
The actual destination still accepts jobs from its associated queue up to the maximum-concurrent-jobs limit, but does not print them.
With the -j flag:
  • The job now printing on the destination stops.
    Note: The actual destination must be a physical printer, not an email destination.
    • If you specify -w=after-current-copy, the job stops after the current copy finishes printing.
    • Otherwise, the job stops as soon as possible. How long this takes depends on the type of printer device.
    • If you only want to get the job off the printer immediately, you can use the pdmod command:
      pdmod -xjob-hold=true
      This will send the job back to the held queue and reprint all the pages in the job
  • InfoPrint changes the job state to paused.
  • The destination remains available to accept work.
  • InfoPrint can assign other jobs to the destination.
The actual destination can still accept jobs from its associated queue and process them.
Note: You cannot pause logical destinations because they do not hold jobs.
[ServerName:]QueueName
Specifies the queues you want to pause.

Pausing a queue halts the distribution of jobs from the queue to the actual destinations associated with the queue. Pausing a queue does not prevent it from accepting jobs from its associated logical destinations.

ServerName
Specifies the server on which you want the command to operate. A server does not have a paused state. Issuing the command against a server pauses all queues and actual destinations contained in the server.

Examples

  • Pause an actual destination

    To pause actual destination molly-pp and include a message as to why you are pausing the destination, enter the command:

    pdpause -m "Toner is low, refilling" molly-pp

  • Pause a currently printing job

    To pause the currently printing job on destination molly-pp, enter the command:

    pdpause -j molly-pp

  • Pause a queue

    To pause the queue Div1Q2, enter the command:

    pdpause -c queue  Div1Q2

  • Pause all queues in a server

    To pause all of the queues in server DivServ1, enter the command:

    pdpause -c server DivServ1

  • Pause an actual destination after the current copy with NPRO

    To pause actual destination molly-pp after the current copy and move the last printed sheet to the stacker, enter the command:

    pdpause -w after-current-copy -n molly-pp

Suggested reading

For more information, see Attributes file.