Remove-PrinterPort

Removes the specified printer port from the specified computer.

Syntax

Remove-PrinterPort
      [-Name] <String[]>
      [-AsJob]
      [-CimSession <CimSession[]>]
      [-ComputerName <String>]
      [-Confirm]
      [-PassThru]
      [-ThrottleLimit <Int32>]
      [-WhatIf]
      [<CommonParameters>]
Remove-PrinterPort
      [-AsJob]
      [-CimSession <CimSession[]>]
      [-Confirm]
      -InputObject <CimInstance[]>
      [-PassThru]
      [-ThrottleLimit <Int32>]
      [-WhatIf]
      [<CommonParameters>]

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 credentials to run Remove-PrinterPort.

Examples

Example 1: Remove a specified printer port

PS C:\> Remove-PrinterPort -Name "LocalPort:"

This command removes the printer port named LocalPort: from the computer.

Required Parameters

-InputObject

Specifies the input object that is used in a pipeline command.

Type:CimInstance[]
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-Name

Specifies the name of the printer port to remove.

Type:String[]
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

Type:SwitchParameter
Position:Named
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False
-ComputerName

Specifies the name of the computer from which to remove the printer port.

Type:String
Aliases:CN
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
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.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
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
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_PrinterPort

This cmdlet accepts a printer port object.

Outputs

By default, this cmdlet produces no output objects.