Edit

Share via

Get-PrintConfiguration

  • Reference
Module:
PrintManagement

Gets the configuration information of a printer.

Syntax

Get-PrintConfiguration
   [-ComputerName <String>]
   [-PrinterName] <String>
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Get-PrintConfiguration
   [-PrinterObject] <CimInstance>
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Description

The Get-PrintConfiguration cmdlet gets the configuration information of the specified printer. Using Get-PrintConfiguration cmdlet, you can manage the configuration of the following features:

  • Collate
  • Color
  • Duplexing Mode
  • N-Up
  • Paper Size

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

You do not need administrator privileges to use Get-PrintConfiguration.

Examples

Example 1: Get the printer configuration

PS C:\> Get-PrintConfiguration -PrinterName "Microsoft XPS Document Writer"

This command returns the printer configuration for the printer named "Microsoft XPS Document Writer".

Example 2: Get the print configuration for all printers

PS C:\>$Printers = Get-Printer *
PS C:\>Foreach ($Printer in $Printers){Get-PrintConfiguration -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.

The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet.

For more information about Windows PowerShell background jobs, see about_Jobs.

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 configuration information.

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

-PrinterName

Specifies the name of the printer from which to retrieve the configuration information.

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

-PrinterObject

Specifies the object which contains the printer from which to retrieve configuration information.

Type:CimInstance
Aliases:Printer
Position:0
Default value:None
Required:True
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

CimInstance

This cmdlet accepts one printer object.

Outputs

CimInstance

This cmdlet returns a printer configuration object.