Edit

Share via

Get-PrinterProperty

  • Reference
Module:
PrintManagement

Retrieves printer properties for the specified printer.

Syntax

Get-PrinterProperty
   [[-PropertyName] <String[]>]
   [-ComputerName <String>]
   [-PrinterName] <String>
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Description

The Get-PrinterProperty cmdlet retrieves one or more printer properties for the specified printer.

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

You need administrator credentials to run Get-PrinterProperty.

Examples

Example 1: Get printer properties

Get-PrinterProperty -PrinterName "Printer name"

This command returns a list of properties for the printer specified by the PrinterName parameter.

Example 2: Get printer properties for all installed printers

PS C:\>$printers = get-printer *
foreach ($printer in $printers)
{
    get-printerproperty -printerName $printer.name
}

This command gets all the printers into a variable $Printers and then loops through all the printers and displays the properties.

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
Required:False
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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ComputerName

Specifies the name of the computer from which to retrieve the printer properties.

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

-PrinterName

Specifies the name of the printer from which to retrieve the printer properties.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-PropertyName

Specifies the property name to retrieve.

Type:String[]
Position:1
Default value:None
Required:False
Accept pipeline input:True
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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

String[]

String

Outputs

CimInstance

CimInstance

This cmdlet returns a printer property object.