Home Reference WMI Reference root CIMV2 Win32_TCPIPPrinterPort
 

Win32_TCPIPPrinterPort

The Win32_TCPIPPrinterPort class represents a TCP//IP service access point. For example a TCP/IP printer port.

Note: The SE_LOAD_DRIVER_PRIVILEGE privilege is required on this class.

Quick Start

Properties

In this WMI class, all WMI properties are read-only. You can only read values but not change them.

Access

Data type Object

ByteCount

Data type Boolean

The ByteCount property, when $true, causes the computer to count the number of bytes in a document before sending them to the printer and the printer to report back the number of bytes actually read. This is used for diagnostics when one discovers that bytes are missing from the print output.

Caption

Data type String

The Caption property is a short textual description (one-line string) of the object.

CreationClassName

Data type String

CreationClassName indicates the name of the class or the subclass used in the creation of an instance. When used with the other key properties of this class, this property allows all instances of this class and its subclasses to be uniquely identified.

Description

Data type String

The Description property provides a textual description of the object.

HostAddress

Data type String

The HostAddress property indicates the address of device or print server

InstallDate

Data type DateTime

The InstallDate property is datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.

MaximumAllowed

Data type UInt32

Name

Data type String

The Name property uniquely identifies the service access point and provides an indication of the functionality that is managed. This functionality is described in more detail in the object’s Description property.

PortNumber

Data type UInt32

The PortNumber property indicates the number of the TCP port used by the port monitor to communitcate with the device.

Protocol

Data type UInt32

The Protocol property has two values: ‘Raw’ indicates printing directly to a device and ‘Lpr’ indicates printing to device or print server; LPR is a legacy protocol, which will eventually be replaced by RAW. Some printers support only LPR.

Queue

Data type String

The Queue property is used with the LPR protocol to indicate the name of the print queue on the server.

SNMPCommunity

Data type String

The SNMPCommunity property contains a security level value for the device. For example ‘public’.

SNMPDevIndex

Data type UInt32

The property SNMPDevIndex indicates the SNMP index number of this device for the SNMP agent.

SNMPEnabled

Data type Boolean

The SNMPEnabled property, when $true, indicates that this printer supports RFC1759 (Simple Network Management Protocol) and can provide rich status information from the device.

Status

Data type String

The Status property is a string indicating the current status of the object. Various operational and non-operational statuses can be defined. Operational statuses are “OK”, “Degraded” and “Pred Fail”. “Pred Fail” indicates that an element may be functioning properly but predicting a failure in the near future. An example is a SMART-enabled hard drive. Non-operational statuses can also be specified. These are “Error”, “Starting”, “Stopping” and “Service”. The latter, “Service”, could apply during mirror-resilvering of a disk, reload of a user permissions list, or other administrative work. Not all such work is on-line, yet the managed element is neither “OK” nor in one of the other states.

'OK','Error','Degraded','Unknown','Pred Fail','Starting','Stopping','Service','Stressed','NonRecover','No Contact','Lost Comm'

SystemCreationClassName

Data type String

The scoping system’s creation class name.

SystemName

Data type String

The scoping system’s name.

Type

Data type UInt32

The Type property indicates the type of SAP such as ‘attached’ or ‘Redirected’.

$Write=1
$Read=2
$Redirected=4
$Net_Attached=8
$unknown=16

$Type = $Read + $Net_Attached

Methods

Examples

Help and Questions

  Community Content

You are cordially invited to add knowledge to this page. If you have sample code or additional information related to this WMI class, please share it. Use the comment form to send your information. We will edit and incorparate it into the reference library. Thank you!

Please do not use the comment form to submit questions. If you have questions or need assistance, visit our free forum: Help me with WMI.

Content last updated: 2013-12-27 12:21:50 (UTC).

Facebooktwittergoogle_pluspinterestlinkedinFacebooktwittergoogle_pluspinterestlinkedin