Get-Printer
Retrieves a list of printers installed on a computer.
Syntax
Default (Default)
Get-Printer
[[-Name] <String[]>]
[-ComputerName <String>]
[-Full]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]
Description
The Get-Printer cmdlet retrieves a list of printers installed on a computer. You can also use Get-Printer to retrieve the properties of a single printer, and then use that information as input into other cmdlets.
You can use wildcard characters with Get-Printer. You can use a Get-Printer in a Windows PowerShell remoting session.
You do not need administrator credentials to run Get-Printer.
Examples
Example 1: Get a list of printers
Get-Printer
This command retrieves a list of printers and printer connections on the local computer.
Example 2: Get the information for a specific printer
Get-Printer -Name "Microsoft XPS Document Writer"
This command retrieves information for one specific printer named Microsoft XPS Document Writer.
Example 3: Get the detailed information for a specific printer
Get-Printer -Name "Microsoft XPS Document Writer" | Format-List
This command retrieves detailed information for one specific printer named Microsoft XPS Document Writer.
Example 4: Get a list of printers on a remote computer
Get-Printer -ComputerName PrintServer
This command retrieves a list of printers from the computer named PrintServer.
Example 5: Get a list of printer objects and then rename the printers
$Printer = Get-Printer -Name "Microsoft XPS Document Writer"
Rename-Printer -InputObject $printer "MXDW"
The first command gets the printer named Microsoft XPS Document Writer, and then stores it in the $Printer variable.
The second command renames the printer in $Printer by using the Rename-Printer cmdlet.
Parameters
-AsJob
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | CimSession[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Session |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ComputerName
Specifies the name of the computer from which to retrieve the printer information.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | CN |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Full
Specifies all the printer parameters to retrieve including RenderingMode and PermissionSDDL.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
Specifies the name of the printer about which to retrieve information.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
String
Outputs
CimInstance
CimInstance
This cmdlet outputs one or more printer objects.