Get-Printer
Get-Printer
Retrieves a list of printers installed on a computer.
Syntax
Parameter Set: __cmdletization_Query
Get-Printer [[-Name] <String> ] [-AsJob] [-CimSession <CimSession> ] [-ComputerName <String> ] [-Full] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Detailed 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 privileges to use Get-Printer.
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 printer information.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
local machine name |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Full
Specifies all the printer parameters to retrieve including RenderingMode and PermissionSDDL.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies the name of the printer about which to retrieve information.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
true |
-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_Printer
This cmdlet outputs one or more printer objects.
Examples
-------------------------- Example XAMPLE 1: GetReturn a list of printers and printer connections -------------------------- xample : Get a list of printers
This command retrieves a list of printers and printer connections on the local computer.
PS C:\> Get-Printer
Example 2: Get the information for a specific printer
This command retrieves information for one specific printer named "Microsoft XPS Document Writer".
PS C:\> Get-Printer –Name "Microsoft XPS Document Writer"
Example 3: Get the detailed information for a specific printer
This command retrieves detailed information for one specific printer named "Microsoft XPS Document Writer".
PS C:\> Get-Printer –Name "Microsoft XPS Document Writer" | Format-List
Example 4: Get a list of printers on a remote computer
This command retrieves a list of printers from the computer named PrintServer.
PS C:\> Get-Printer -ComputerName PrintServer
Example 5: Get a list of printer objects and then rename the printers
This set of commands retrieves a printer object into a variable ($Printer) and then passes the contents of the variable to Rename-Printer.
PS C:\> $Printer = Get-Printer -Name “Microsoft XPS Document Writer"
PS C:\> Rename-Printer -InputObject $printer "MXDW"