Get-PrinterPort

Get-PrinterPort

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

Syntax

Parameter Set: __cmdletization_Query
Get-PrinterPort [[-Name] <String> ] [-AsJob] [-CimSession <CimSession> ] [-ComputerName <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Detailed 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 privileges to use Get-PrinterPort.

Parameters

-AsJob

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-CimSession<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.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ComputerName<String>

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

Aliases

none

Required?

false

Position?

named

Default Value

local machine name

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Name<String>

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

Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-ThrottleLimit<Int32>

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.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • None

    This cmdlet accepts no input objects.

Outputs

The output type is the type of the objects that the cmdlet emits.

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

    This cmdlet returns one or more printer port objects.

Examples

-------------------------- EXAMPLExample 1: GetRetrieves the a list of printer ports installed -------------------------- xample: Get a list of printer ports

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

PS C:\> Get-PrinterPort

Add-PrinterPort

Remove-PrinterPort