pdshutdown command: stops servers or actual destinations

Syntax

pdshutdown [-H host:port] [-c server] [-m "MessageText"] [-w time]
[-x "attribute=value …"] [-X AttributesFileName]
ServerName

pdshutdown [-c destination] [-m "MessageText"]
[-x "attribute=value …"] [-X AttributesFileName]
[-s [-n]] [ServerName:]DestinationName

pdshutdown -h

Description

Use the pdshutdown administrative command to terminate a server process or shut down a PSF physical printer, or email destination.

You can shut down a server either immediately or after it finishes processing some or all of its current jobs.

InfoPrint prevents the server from accepting new jobs while the server is shutting down and after it has shut down. Destinations in the server that were enabled at shut down time are enabled when the server restarts. Destinations in the server that were disabled at shut down time are disabled when the server restarts.

Shutting down an actual destination:

  • Terminates all communication with the output device
  • Pauses the job printing or sending on the actual destination
  • Terminates all jobs processing on the actual destination and puts these jobs in the pending state
  • Releases jobs assigned to the actual destination so that you can reschedule them on another actual destination
  • Disables the actual destination

You can shut down a PSF physical printer either immediately or after synchronizing the current job's checkpoint data with the pages that have actually printed.

    Note:
  1. To restart an actual destination after shut down, use the pdenable command. See pdenable command: enables destinations to accept jobs and logs to log. See the pdenable man page.
  2. Synchronize the checkpoint data for a controlled shut down, for example, when you want to do maintenance that will take some time.
  3. If InfoPrint cannot communicate with the output device, shut down the actual destination so that you can reschedule the jobs assigned to it. Do not synchronize the checkpoint data. If you try, the command will hang, waiting for the output device to respond.

    If you shut down without synchronization, the shut down will take effect and allow any previously hung commands to complete.

  4. A job paused by a destination shut down without synchronization can reprint some pages when printing is resumed.
  5. To interrupt the actual destination for only a short time, consider pausing it rather than shutting it down. When you pause an actual destination, scheduled jobs remain scheduled. When you shut down an actual destination, scheduled jobs are requeued.

Flags

You can use these flags with the pdshutdown 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 {server | destination} DEFAULT=server
Specifies the object class you want to shut down. In the valid classes, destination is a PSF physical printer, or email destination.

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

-m "MessageText"
Specifies the message that you want to associate with the server or actual destination being shut down. You can use this message to indicate the reason for the shut down or to provide any other comments.

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.

-n
Causes the PSF physical printer 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, and only if you also specify -s. It is not valid for email destinations.

-s
Synchronizes the checkpoint data for the current job with the pages that have actually printed. This permits the job to resume at the point of synchronization. Using this flag is equivalent to specifying the command attribute synchronize=true. Do not use this flag if InfoPrint cannot communicate with the printer device.

This flag is valid only with object class destination. It is not valid for email destinations.

-w {after-current | now | after-all} DEFAULT=after-current
Specifies when you want a server to shut down. When the value is:
now
InfoPrint cancels and requeues any currently printing jobs, then shuts down the server. You must resubmit the jobs using the pdresubmit command when the server restarts.
after-current
The server continues to accept requests other than print requests until the currently-printing jobs finish printing, then the server shuts down.
after-all
The server continues to accept all requests except print requests until all scheduled jobs finish printing, then the server shuts down.

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

This flag is valid only with object class server.

-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 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 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={server | destination} DEFAULT=server
Specifies the object class you want to shut down. In the valid classes, destination is a PSF physical printer, or email destination.
message="MessageText"
Specifies the message you want associated with the server or actual destination being shut down. You can use this message to indicate the reason for the shut down or to provide any other comments.

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.

non-process-runout={true | false} DEFAULT=false
Specifies whether the PSF physical printer should do an NPRO (move the last printed page to the stacker).

This attribute is valid only with object class destination, and only if you also specify synchronize=true. It is not valid for email destinations.

synchronize={true | false} DEFAULT=false
Specifies whether to synchronize the checkpoint data for the current job with the pages that have actually printed. A value of true permits the job to resume at the point of synchronization. Do not specify synchronize=true if InfoPrint cannot communicate with the printer device.

This attribute is valid only with object class destination. It is not valid for email destinations.

when={after-current | now | after-all} DEFAULT=after-current
Specifies when you want a server to shut down. When the value is:
now
InfoPrint cancels and requeues any currently printing jobs, then shuts down the server. You must resubmit the jobs using the pdresubmit command when the server restarts.
after-current
The server continues to accept requests other than print requests until the currently-printing jobs finish printing, then the server shuts down.
after-all
The server continues to accept all requests except print requests until all scheduled jobs finish printing, then the server shuts down.

This attribute is valid only with object class server.

Argument

Use the argument value to identify the specific server or actual destination that you want to shut down.

You can use these argument values with the pdshutdown command:

ServerName
Specifies the server that you want to shut down.
[ServerName:]DestinationName
Specifies the actual destination that you want to shut down.

Examples

  • Shut down a server

    To shut down server Server1, to abort all jobs that are currently printing, and to set a message, Down for maintenance, enter the command:

    pdshutdown -w now -m "Down for maintenance" Server1

  • Shut down an actual destination

    To shut down actual destination Serv9-ad, enter the command:

    pdshutdown -c destination Serv9-ad

  • Shut down a PSF physical printer and update job checkpoint data

    To shut down PSF physical printer Serv9-pp after synchronizing the printer with the currently printing job's checkpoint data, enter the command:

    pdshutdown -c printer -s Serv9-pp

    Note: The PSF physical printer must be able to communicate with the printer device to perform the synchronize function.
  • Shut down a PSF physical printer, update job checkpoint sata, and do NPRO

    To shut down PSF physical printer Serv9-pp after synchronizing the currently printing job's checkpoint data and do an NPRO, enter the command:

    pdshutdown -c destination -s -n Serv9-pp

Suggested reading

For information about Attributes file, see Attributes file.