Edit

Remove-PrinterPort

  • Reference
Module:
PrintManagement

Removes the specified printer port from the specified computer.

Syntax

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

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.

Examples

-------------------------- Example 1: -------------------------- RemoveDelete a specificspecified printer port on a computer

xample: Remove a specified printer port

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

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

Example 2: Remove a specified printer port using a printer port object

PS C:\>$printerPort = Get-PrinterPort -Name "LocalPort:"



PS C:\>Remove-PrinterPort -InputObject $printerPort

This set of commands retrieves a printer port object into a variable ($printerPort) using Get-PrinterPort, and then passes the variable to Remove-PrinterPort.

Parameters

-AsJob

ps_cimcommon_asjob

Type:SwitchParameter
Position:Named
Default value:None
Required:False
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-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. The default is the current session on the local computer.

Type:CimSession
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ComputerName

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

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-InputObject

Specifies the printer port object which contains the printer port to remove.

Type:CimInstance
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

Specifies the name of the printer port to remove.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
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
Required:False
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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

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

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

Inputs

CimInstance

This cmdlet accepts a printer port object.

Outputs

By default, this cmdlet produces no output objects.