HPlogo HP-UX Reference Volume 1 of 5 > p

pddelete(1)

» 

Technical documentation

Complete book in PDF

 » Table of Contents

 » Index

NAME

pddelete — deletes print objects

SYNOPSIS

pddelete -h

pddelete [-c ObjectClass] [ -m "MessageText" ] [ -x "AttributeValuePairs" ] [-X AttributesFileName] { ServerName ... | ServerName : InitialValueDocumentName ... | ServerName : InitialValueJobName ... | [ServerName : ]PrinterName ... | [ServerName : ]QueueName ... }

pddelete -c job [ -m "MessageText" ] [-r JobRetentionPeriod] [ -x "AttributeValuePairs" ] [-X AttributesFileName] LocalJobId ... | GlobalJobId ...

DESCRIPTION

Use this administrative command, pddelete, to permanently delete print objects from the printing system.

A confirmation message is issued before deleting objects, unless the PD_CONFIRM_DELETE environment variable is set to no.

Options

Use the following options with the pddelete command:

-c ObjectClass

Specify the object class that the command is to operate upon. The ObjectClass can be one of the following:

printer (default) job queue initial-value-job initial-value-document server

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 cannot be used with another option or an attribute.

-m "MessageText"

Specify the message that is to be associated with the ObjectClass that is being deleted: printer, job, queue, initial-value-job, or initial-value-document. You can use this message to indicate the reason for deleting the printer, job, queue, initial-value-job, or initial-value-document, or to provide other comments.

If the command is to operate on a job with a non-zero job-retention-period, list this message by specifying requested-attributes=job-message-from-administrator with the pdls command. If the command is to operate on a printer, queue, initial-value-job, initial-value-document, or job with a job-retention-period of zero (0), this message is deleted with the object and cannot be retrieved.

If the -m is not specified, the message already stored with the object remains unchanged and is deleted as just described.

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

-r JobRetentionPeriod

Can only be used if object-class is job. The command will be rejected if used with any other class.

If the job currently has a retention-period or is currently retained, this option must be specified with a zero (0) value to delete the job. If not specified, the present retention-period for the job is used.

This option is equivalent to specifying the object-attribute job-retention-period.

-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 may specify these attributes in a -x "AttributeValuePairs" string or in an attributes file designated with the -X AttributesFileName option.

attributes=AttributesFileName

Cause the designated attributes file to be read.

class=ObjectClass

Specify the ObjectClass that you want for this command. Valid object class names for the pddelete command are: printer (default), job, queue, initial-value-job, initial-value-document, and server.

message="MessageText"

Specify the message that you want associated with the printer, job, queue, initial-value-job, or initial-value-document, that is being deleted. You can use this message to indicate the reason for deleting the printer, job, queue, initial-value-job, initial-value-document, or to provide other comments.

If the command is to operate on a job with a non-zero job-retention-period, you can list this message by specifying a value of requested-attributes=job-message-from-administrator with the pdls command. If the command is to operate on printer, job, queue, initial-value-job, initial-value-document, or job with job-retention-period of zero (0), this message is deleted with the object and cannot be retrieved.

If the message attribute is not specified, the message stored with the object remains unchanged and is deleted as just described.

Object Attribute

You can only use the object-attribute if object-class is job. This command will be rejected if used with any other class. You may specify this attribute in a -x "AttributeValuePairs" string or in an attributes file designated with the -X AttributesFileName option.

job-retention-period=time

If the job currently has a retention-period or is currently retained, this attribute must be specified with a zero (0) value to delete the job. If not specified, the present retention-period for the job is used.

Arguments

Use the argument to specify the object to delete. If you specify multiple objects, each must be separated by spaces.

You can use the following arguments with the pddelete command:

ServerName

You must remove all jobs contained within the named server before you can delete the server.

ServerName:InitialValueDocumentName

If any of the logical printers that reference this initial value document are enabled, you cannot delete this initial value document.

ServerName:InitialValueJobName

If any of the logical printers that reference this initial value job are enabled, you cannot delete this initial value job.

LocalJobID or GlobalJobId

A job object is deleted based on the specified value in its job-retention-period attribute.

[ServerName:]PrinterName

All the jobs must be removed from physical printers. Physical and logical printers must be disabled before they can be deleted.

[ServerName:]QueueName

You must disable all logical and physical printers associated with the queue before you can delete the queue. Before disabling physical printers, you must first remove all of the jobs from them. All of the jobs (including paused jobs) must be removed from the queue before the queue can be deleted.

EXAMPLES

Delete a job using a Local ID

To delete job 5, enter the command:

pddelete -c job 5

Delete Logical Printers

To delete logical printers lp11 and lp15, enter the command:

pddelete lp11 lp15

Delete an IVO

To delete the initial-value-job object, IVJ_2, from the spooler, DivSPOOL2, enter the command:

pddelete -c initial-value-job DivSPOOL2:IVJ_2

Delete a Server

To delete the server SPOOL1, enter the command:

pddelete -c server SPOOL1

STANDARDS CONFORMANCE

pddelete: POSIX 1387.4

© Hewlett-Packard Development Company, L.P.