HPlogo HP-UX Reference Volume 1 of 5 > p

pdpause(1)

» 

Technical documentation

Complete book in PDF

 » Table of Contents

 » Index

NAME

pdpause — pauses jobs, physical printers, servers, or queues

SYNOPSIS

pdpause -h

pdpause [-c ObjectClass] [ -m "MessageText" ] [ -x "AttributeValuePairs" ] [-X AttributesFileName] { LocalJobId ... | GlobalJobId ... | ServerName ... | [ServerName : ]PrinterName ... | [ServerName : ]QueueName ... }

pdpause -j [ -m "MessageText" ] [ -x "AttributeValuePairs" ] [-X AttributesFileName] [ServerName : ]PrinterName ...

DESCRIPTION

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

Objects that can be paused are as follows:

  • pending print jobs

  • held print jobs

  • currently-processing print jobs

  • physical printers

  • queues

  • servers (pauses all of the queues contained in a spooler or all physical printers contained in a supervisor)

To resume a paused object, use the pdresume command.

Note: The pdpause and pdresume commands control output, whereas the pdenable and pddisable commands control input.

Options

Use the following options with the pdpause command:

-c ObjectClass

Specify the object class that you want to pause. The ObjectClass can be one of the following:

printer (default) queue job server

Within the valid classes, printer is a physical printer, and a server is either a spooler or a supervisor. This option is equivalent to specifying the command-attribute class.

-h

Display a command-specific help message containing information about command syntax and options. This option cannot be used with another option or with an attribute.

-j

Only valid when used with object-class printer. Use this option to pause the currently printing job on the specified physical printer.

-m "MessageText"

Specify the message that is to be associated with the ObjectClass that is being paused: printer, queue, job, or server. You can use this message to indicate the reason that a pause has taken place or to provide other comments.

When pausing a supervisor, HPDPS propagates the message to the message attribute of the physical printers residing in a supervisor. The message attribute for the supervisor is not changed.

When pausing a spooler, the message is propagated to the message attribute of the queues residing in the spooler. The message attribute for the spooler is not changed.

If the command operates on a printer 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 the -m option is not specified, the message already stored with the printer, queue, job, or server remains unchanged.

This option is equivalent to specifying the command-attribute message.

-x "AttributeValuePairs"

A single attribute string, consisting of one or more attribute-value pairs.

-X AttributesFileName

The name of a file containing attribute-value pairs you want inserted at the current point in the command line. This option is equivalent to specifying the command-attribute attributes.

Command Attributes

You can specify these attributes in a -x "AttributeValuePairs" string or in an attributes file designated with the -X AttributesFileName option.

attributes=AttributesFileName

Specifies the designated attributes file that HPDPS is to read and insert at the current point in the command line. This file contains attribute and value pairs that HPDPS uses to expand on the command being entered.

class=ObjectClass

Specify the object class that you want to pause. Valid object class names for the pdpause command are: printer, queue, job, or server.

Within the valid classes, printer is a physical printer, and a server is either a spooler or a supervisor.

message="MessageText"

Specify the message that you want associated with the printer, queue, job, or server that is being paused. You can use this message to indicate the reason that a pause has taken place or to provide other comments.

When pausing a supervisor, HPDPS propagates the message to the message attribute of the physical printers residing in a supervisor. The message attribute for the supervisor is not changed. When pausing a spooler, the message is propagated to the message attribute of the queues residing in the spooler. The message attribute for the spooler is not changed.

If the command operates on a printer 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 the message attribute is not specified, the message that is already stored with the printer, queue, job, or server remains unchanged.

Object Attribute

There are no object attributes for this command.

Arguments

Use the argument to specify the object that you want to pause. If you specify multiple objects, all of the objects must be of the same class, and each must be separated by spaces.

You can use the following arguments with the pdpause command:

LocalJobID or GlobalJobId

Specify the jobs that you want to pause as determined by a local job identifier or global job identifier. Only you as an administrator have the authority to pause jobs and would generally use the global job identifier. However, for your own jobs, you can use the local job identifier. The following actions take place for these three cases:

A currently printing job is paused:
  • The job stops at a "pause" point.

    Note: A pause point may be the next page, sheet, document, or job boundary depending on the type of printer on which the job is being printed

  • The job-state changes to paused.

  • The printer remains available to accept work.

  • Other jobs can be assigned to the printer.

A pending job is paused:

The job is prevented from being scheduled but does not affect any printer.

A held job is paused:

The job is prevented from becoming pending, even if the reasons for the job being held are removed. For example, the specified print-after time expires.

Paused jobs remain in the queue until they are resumed or canceled. A paused job can be modified, but it cannot be resubmitted until a pdresume command is issued for the job.

[ServerName:]PrinterName

Specify the printers that you want to pause. The action taken differs whether the -j option is included in the command.

Without the -j option:

  • Any currently-printing job stops at a "pause" point

  • The printer-state is changed to paused

  • The job-state is left at processing; the job is still assigned to the printer.

The physical printer still accepts print jobs from its associated queue up to the maximum-concurrent-jobs limit, but will not print them.

With the -j option:

  • The job stops at a "pause" point,

Note: A pause point may be the next page, sheet, document, or job boundary depending on the type of printer on which the job is being printed

  • The job-state changes to paused

  • The printer remains available to accept work

  • Other jobs can be assigned to the printer

The physical printer may still accept print jobs from its associated queue and process them.

Note: Logical printers cannot be paused because they do not hold jobs.

[ServerName:]QueueName

Specify the queue that you want to pause.

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

ServerName

Specify the server on which you want the command to operate. A server does not have a paused state. Issuing the command against a spooler pauses all queues contained within the spooler. Issuing the command against a supervisor pauses all of physical printers contained within the supervisor.

EXAMPLES

Pause a Physical Printer

To pause physical printer 3828C and include a printer message as to why the printer is being paused, enter the following command:

pdpause -m "Toner is low, refilling" 3828C

Pause a Currently Printing Job

To pause the currently-printing job on printer 3828C, enter the following command:

pdpause -j 3828C

Pause a Queue

To pause the queue Div1Q2, enter the following command:

pdpause -c queue Div1Q2

To pause all of the queues in spooler DivSpool1, enter the following command:

pdpause -c server DivSpool1

STANDARDS CONFORMANCE

pdpause: POSIX 1387.4

© Hewlett-Packard Development Company, L.P.