dslpadmin Command

Purpose

Configure directory-enabled print service for a System V print subsystem.

Syntax

dslpadmin [ [ -q PrintQueueName [ -D QueueDescription ] [ -n LocalQueueName] [ -o banner | nobanner ] [ -A mail | none ] [ -F FaultRecovery ] [ [ -P PhysicalPrinterName ] [ -s NetworkEntityName ] ] ] [ -P PhysicalPrinterName [ -T PrinterType ] [ -l Location ] [ -L PDLList ] ] [ -q PrintQueueName -P PhysicalPrinterName [ -I ContentType ] [ [ -i InterfaceScript ] | [ -m [ Standard | PS ] ] ] [ -o PrintOptions ] ] [ -q PrintQueueName [ -I ContentType ] ] ] [ -q PrintQueueName -s NetworkEntityName [ -a PrintSystemDNSName | PrinterSystemAddress ] [ -t BSD | HPNP ]]

dslpadmin [ -q PrintQueueName [ -u PhysicalPrinterName] [ -U ObjectRDN ] ]

dslpadmin [ -x PrintQueueName] [ -X PhysicalPrinterName ] [ -r NetworkEntityName ]

dslpadmin [ -h ]

Description

The dslpadmin command is used to perform the following functions in order to configure a directory-enabled print service:
  • Add print queues and physical printers to the system.
  • Modify print queues and physical printers.
  • Remove print queues and physical printers from the system.
  • Add and delete network entity objects for networked printers.

The dslpadmin command provides directory-aware versions of the functionality supplied by lpadmin (which is not directory-aware), and continues to use the traditional ``flat file'' configuration system. Note that where both systems are in use, the printer subsystem employs information found in the directory first. It is the responsibility of the administrator to ensure that naming conflicts do not arise between the two configuration systems.

The directory-enabled commands use Relative Distinguished Names (RDNs), rather than Distinguished Names (DNs). For example, to create a directory-enabled queue with a DN of "cn=test,ou=printq,ou=print,cn=aixdata", only the RDN® "test" is to be used for the PrintQueueName.

When configuring a print queue where the administrator is not on the system that is to host the print queue, the InterfaceScript parameter of -i and the PrinterType parameter of -T are not checked. This is because the remote system cannot be accessed in order to do the checks. It is therefore the administrator's responsibility to ensure that the specified InterfaceScript and PrinterType exist on the remote hosting system.

A command line can contain any combinations of the -q , -P and -s flags, or any combination of the -x, -X and -r flags, but only one of each flag. When multiple directory objects are simultaneously created or modified, appropriate links are set up between the three object types (printers, print queues and network entities).

Flags

Item Description
-a PrinterSystemDNSName | PrinterSystemAddress Associates a DNS name or network address with the system. If the argument given can be interpreted as an IPv4 or IPv6 address, it is an address, if not it is assumed to be a DNS name. The -a flag causes the network entity object specified by -s to be modified, or else created if it does not already exist. The administrator should ensure that network entity objects are given unique names, so as to avoid modifying existing UNIX system objects instead of adding new print system objects. This flag requires the -s flag.
-A [ mail | none ] Instructs the print system to generate a mail message if a print request fails. The mail is sent to the owner of the physical printer, or to the root user of the system hosting the print queue, if the printer has no owner or the user has no mail address. The default is none. This flag requires the -q flag.
-D QueueDescription Defines a description comment for the print queue object specified with the -q flag. This description is displayed whenever a user asks for a full description of a print queue using the lpstat command. Strings containing whitespace should be double quoted. This flag requires the -q flag.
-F FaultRecovery Defines the print queue's fault recovery mode. This flag specifies the recovery to be used if the printer on a print queue fails while printing a print request. The value of FaultRecovery can be any of the following:
continue
Continue printing on the top of the page where printing stopped. This requires a filter to wait for the fault to clear before automatically continuing.
beginning
Start printing the request again from the beginning.
wait
Disable printing on PhysicalPrinterName and wait for the administrator or a user to enable printing again.

During the wait the administrator or the user who submitted the stopped print request can issue a change request that specifies where printing should resume. If no change request is made before printing is enabled, printing resumes at the top of the page where it stopped, if the filter allows; otherwise, the request is printed from the beginning.

The default value of FaultRecovery is beginning. This flag requires the -q flag.
-h Displays a brief help screen.
-i InterfaceScript Pathname for the printer's InterfaceScript when accessed through the specified print queue. This flag is not valid if the -P flag has not been specified. The interface scripts are usually supplied by the user. This flag cannot be used when -m has also been specified. This flag requires both the -q and the -P flags.
-I ContentType[, ContentType, ...] Specifies the print queue's content types. Allows the print queue to handle print requests with the content types in the list. If the list contains more than one ContentType, the ContentType parameters must be separated by commas. See the lpadmin manual page for a full description of the format. This also requires the -P flag and the -q flag.
-l Location Defines the printer's location. This is a string identifying where a printer is physically located, for example "Building X, Room 6". It can be searched on by the dslpsearch command. Once set, this value can only be overwritten, not removed. This flag requires the -P flag.
-L PDL[, PDL, ...] Specifies the list of Page Description Languages (PDLs) supported by the printer. This is used to advertise any PDL the printer supports, and can be searched on, using the dslpsearch command. The AUTOSW, PCL, PCLXL, POSTSCRIPT, TEXT, ESCP, PJL, SIMPLE, and OTHER PDLs are supported. If the -L flag is used to modify an existing physical printer object, the list replaces the existing list. This flag requires the -P flag.
-m [ standard | PS ] Model interface program for the printer when accessed through the specified print queue. It selects the model interface script to be used by the print queue. When a physical printer object is being created, and neither the -m nor the -i flag has been specified, the default is standard. This flag cannot be used when -i has also been specified. This flag requires both the -q and the -P flags.
-n LocalQueueName Defines the local name of a print queue. This name normally only differs from the queue's RDN when the queue is on a non-directory-enabled host. It is used by incoming remote network connections to identify the print queue on the receiving system. The default value is the print queue's RDN. This flag requires the -q flag.
-o [ banner | nobanner ] Defines if a banner page will always be produced by this print queue. The default value, banner, forces a banner page to be printed for all print requests, whereas nobanner allows the user to submit a print job specifying that no banner page is to be printed. This flag requires the -q flag.
-o PrintOption=Value[, ...] Specifies values for print options. See the lpadmin documentation for a detailed description of the print options available with the -o flag. This flag requires both the -q and the -P flags.
-P PhysicalPrinterName Create or modify a physical printer object. The PhysicalPrinterName argument specifies the RDN of a printer object. If the object does not already exist, dslpadmin creates it.
-q PrintQueueName dlspadmin Creates or modifies a print queue object. The PrintQueueName argument specifies the RDN of a print queue object. When adding a new print queue, you must specify the -s and -P flags so the command knows the NetworkEntityName and PhysicalPrinterName for the print queue being added. If the print queue object does not exist, dslpadmin creates it.

A command line can contain any combinations of the -q, -P and -sflags , or any combination of the -x, -X and -r flags, but only one of each flag. When multiple directory objects are simultaneously created or modified, appropriate links are set up between the three object types (printers, print queues and network entities).
-r NetworkEntityName Delete the network entity system object. Care needs to be taken not to delete a non-printer system object. It is the responsibility of the administrator to ensure that the correct object is deleted.
-s NetworkEntityName Specifies the network entity system object that hosts the print queue. If -a is also given, the object is created or modified. The NetworkEntityName argument specifies the RDN of an object in the current directory context. The network entity object defines the network address that remote clients need to use to access the print queue.
-t [ BSD | HPNP ] Defines the print protocol used by this "networked printer" print queue. Retry and timeout values are set to their default values for a networked printer. To change these values, the dslpprotocol command should be used. Note that this flag should only be used for networked printers supporting the BSD or HPNP protocol. This flag requires the -q flag.
-T PrinterType[, PrinterType, ...] List of printer types. It identifies the printer as being of one or more printer types, for example "hplaserjet". See the lpadmin manual page for details. This flag requires the -P flag.
-u PhysicalPrinterName Unlinks the named physical printer from the print queue (specified with the -q flag) without deleting its object. This flag requires the -q flag.
-U ObjectRDN Unlinks either the physical printer or the print queue object (specified by ObjectRDN) from the print queue (specified with the -q flag), without deleting its object. This flag requires the -q flag.
-x PrintQueueName Delete a print queue object.
-X PhysicalPrinterName Delete a physical printer object.

Exit Status

0
Indicates success
255 (or -1)
Indicates an error in configuration. Error messages are displayed to explain the error or failure.

Examples

The following examples illustrate use of the dslpadmin command, when the user is logged on to a directory-enabled UNIX system.

  1. The following adds an HP LaserJet network printer that uses the BSD remote print protocol, with a print queue RDN of "denlj5n", and a physical printer RDN of "denplj5n". It gives the print queue a description of "HP JetDirect (PostScript)", the printer type "PS-b", and the model interface script as "PS". The printer has a network address of "p_hplj.ibm.com": 
    dslpadmin -q denlj5n -P denplj5n -T PS-b -D "HP JetDirect (Postscript)" \
-I PS -m PS -A mail -o nobanner  -s denslj5n -a p_hplj.ibm.com -t BSD
    The print system will allow print requests of content type PS for this print queue, and allow disabling of banner pages.
  2. The following adds an HP LaserJet PostScript network printer, using the HPNP remote print protocol, with a print queue RDN of "dehpnp", and a physical printer RDN of "dephpnp". It gives the print queue a description of "HPNP (PCL)", the printer type "hplaserjet", and the model interface script as "standard". The printer has a network address of "p_hplj.ibm.com": 
    dslpadmin -q dehpnp -P dephpnp -T hplaserjet -D "HPNP (PCL)" -I pcl \
-m standard -A mail -s deshpnp -a p_hplj.ibm.com -t HPNP
    The print system will allow print requests of content type PCL for this print queue, and reject requests if no banner page is requested. If a printer fault occurs, the print system will mail the owner of the printer.
  3. The following deletes an HP LaserJet PostScript printer: 
    dslpadmin -x delj5n  -X deplj5n
  4. The following deletes an HPNP printer: 
    dslpadmin -x dehpnp  -X dephpnp -r deshpnp