Share via


2.2.1.15.3 PortPrinter element

The <PortPrinter> inner element refers to a client's connection to a network printer using the LPR/LPD remote-printer protocol (as specified in [RFC1179]) or the "JetDirect raw TCP" protocol using TCP port 9100.

Attribute name

Description

action

(optional) If specified, the value MUST be C, D, R, or U, corresponding to Create, Delete, Replace, and Update. If unspecified, the default value is U.

  • Create: This action MUST be used to create a new TCP/IP printer connection. If a network printer with the same IP address exists, then the client MUST NOT perform an action, and an error MUST NOT be returned.

  • Delete: This action MUST be used to remove a TCP/IP printer connection with the same IP address. If a network printer with the same name does not exist, then the client MUST NOT perform an action, and an error MUST NOT be returned.

  • Replace: This action MUST be used to delete and re-create the TCP/IP printer connection. The net result of the Replace action MUST be to overwrite all existing settings associated with the TCP/IP printer connection. If the TCP/IP printer connection does not exist, then the Replace action MUST create a new TCP/IP printer connection.

  • Update: This action MUST be used to modify a TCP/IP printer connection. The action differs from Replace in that it MUST update the settings defined within the preference item. All other settings MUST remain as previously configured. If the TCP/IP printer connection does not exist, then the Update action MUST create a new TCP/IP printer connection.

ipAddress

MUST be set to the IP address of the remote printer, or set to the FQDN of the remote printer if UseDNS is set to 1.

useDNS

(optional) MUST be set to 1 if the ipAddress contains a Domain Name System (DNS) name.

localName

(optional) MUST be set to the local name of the targeted TCP/IP printer connection. A new TCP/IP printer connection with this name MUST be created if one does not exist. If a TCP/IP printer connection with this name exists, the TCP/IP printer with this name MUST be used as the target of the requested action.

path

MUST be set to a fully qualified UNC path of a shared printer connection. The shared connection MUST use this path as an installation point for the printer driver. The actual printer MUST be physically connected to the workstation.

default

(optional) MUST be set to 1 to make the targeted printer the default printer for the current user.

skipLocal

(optional) MUST be set to 1 to bypass changing the default printer if there is a local printer configured on the computer.

deleteAll

(optional) MUST be set to 1 to delete all TCP/IP printer connections for the current user.

location

(optional) MUST be set to Text that describes where the printer is located. This information appears in the printer's Location information.

comment

(optional) MUST be set to text that provides additional comments about the printer. This information appears in the printer's Comments information.

lprQueue

(optional) MUST be set to the LPR queue name. If supplied for a Raw TCP printer, the setting is ignored.

snmpCommunity

(optional) MUST be set to the Simple Network Management Protocol (SNMP) community name. This setting applies to both LPR and Raw TCP printers.

protocol

(optional) MUST be PROTOCOL_RAWTCP_TYPE or PROTOCOL_LPR_TYPE to specify a TCP or LPR type printer.

portNumber

(optional) MUST be set to the port number assigned to this printer. The value MUST be 515 for PROTOCOL_LPR_TYPE.

doubleSpool

(optional) MUST be set to 1 to enable double spooling.

snmpEnabled

(optional) MUST be set to 1 to enable SNMP support.

snmpDevIndex

(optional) MUST be set to an SNMP device index.