Remove-PrinterPort
Remove-PrinterPort
Removes the specified printer port from the specified computer.
Syntax
Parameter Set: __cmdletization_Query
Remove-PrinterPort [-Name] <String> [-AsJob] [-CimSession <CimSession> ] [-ComputerName <String> ] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: __cmdletization_InputObject
Remove-PrinterPort -InputObject <CimInstance> [-AsJob] [-CimSession <CimSession> ] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Remove-PrinterPort cmdlet removes the specified printer port from the specified computer.
You can remove a printer port by specifying the port name, or you can use a printer object retrieved using Get-PrinterPort.
You can use wildcard characters with Remove-PrinterPort. You can use Remove-PrinterPort in a Windows PowerShell remoting session.
You do not need administrator privileges to use Remove-PrinterPort.
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 remove the printer port.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-InputObject<CimInstance>
Specifies the printer port object which contains the printer port to remove.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies the name of the printer port to remove.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-PassThru
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
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 |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
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.
Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_PrinterPort
This cmdlet accepts a printer port object.
Outputs
The output type is the type of the objects that the cmdlet emits.
- By default, this cmdlet produces no output objects.
Examples
-------------------------- ExampleXAMPLE 1: -------------------------- RemoveDelete a specificspecified printer port on a computer xample: Remove a specified printer port
This command removes the printer port named LocalPort: from the computer.
PS C:\> Remove-PrinterPort -Name "LocalPort:"
Example 2: Remove a specified printer port using a printer port object
This set of commands retrieves a printer port object into a variable ($printerPort) using Get-PrinterPort, and then passes the variable to Remove-PrinterPort.
PS C:\> $printerPort = Get-PrinterPort -Name "LocalPort:"
PS C:\> Remove-PrinterPort –InputObject $printerPort