Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Get-PrintConfiguration

Windows Server 2012 R2 and Windows 8.1

Updated: October 17, 2013

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Get-PrintConfiguration

Gets the configuration information of a printer.

Syntax

Parameter Set: PrinterName
Get-PrintConfiguration [-PrinterName] <String> [-AsJob] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: PrinterObject
Get-PrintConfiguration [-PrinterObject] <CimInstance> [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]




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

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.


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

Session

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


Aliases

Computer,CN

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-PrinterName<String>

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


Aliases

PN

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-PrinterObject<CimInstance>

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


Aliases

Printer

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByValue, 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.

Inputs

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

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

    This cmdlet accepts one printer object.


Outputs

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

  • Microsoft.Management.Infrastructure.CimInstance#MSFT_PrinterConfiguration

    This cmdlet returns a printer configuration object.


Examples

Example 1: Get the printer configuration

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


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

Example 2: Get the print configuration for all printers

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


PS C:\> $printers = get-printer * foreach ($printer in $printers){     Get-printconfiguration –printerName $printer.name –duplexingMode “TwoSidedLongEdge”}

Related topics

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.