Get-PrinterPort

Retrieves a list of printer ports installed on the specified computer.

Syntax

Get-PrinterPort
   [[-Name] <String[]>]
   [-ComputerName <String>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Description

The Get-PrinterPort cmdlet retrieves a list of printer ports that are installed on the specified computer.

You can use wildcard characters with Get-PrinterPort. You can use Get-PrinterPort in a Windows PowerShell remoting session.

You do not need administrator credentials to run Get-PrinterPort.

Examples

Example 1: Get a list of printer ports

PS C:\> Get-PrinterPort

This command retrieves a list of all the printer ports installed on the local computer.

Optional Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-CimSession

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ComputerName

Specifies the name of the computer from which to retrieve the list of printer ports.

Type:String
Aliases:CN
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Name

Specifies the name of the printer port about which to retrieve information. You can use wildcard characters to specify the printer port name.

Type:String[]
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ThrottleLimit

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

This cmdlet accepts no input objects.

Outputs

Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_PrinterPort

This cmdlet returns one or more printer port objects.