Disable-NetworkSwitchEthernetPort

Disables an Ethernet port on a network switch.

Syntax

Disable-NetworkSwitchEthernetPort
       -CimSession <CimSession>
       [-Confirm]
       -DeviceID <String>
       [-WhatIf]
       [<CommonParameters>]
Disable-NetworkSwitchEthernetPort
       -CimSession <CimSession>
       [-Confirm]
       -InputObject <CimInstance[]>
       [-WhatIf]
       [<CommonParameters>]
Disable-NetworkSwitchEthernetPort
       -CimSession <CimSession>
       [-Confirm]
       -PortNumber <Int32>
       [-WhatIf]
       [<CommonParameters>]

Description

The Disable-NetworkSwitchEthernetPort cmdlet disables an Ethernet port on a network switch.

Examples

Example 1: Disable a port

PS C:\>$Session = New-CimSession -ComputerName "NetworkSwitch08"
PS C:\> Disable-NetworkSwitchEthernetPort -CimSession $Session -PortNumber 21

The first command creates a CimSession for a network switch, and then stores it in the $Session variable. For more information about CimSession objects, type Get-Help New-CimSession.

This command disables port 21 for NetworkSwitch08 by using the $Session object.

Example 2: Disable a port by using a device ID

PS C:\>Disable-NetworkSwitchEthernetPort -CimSession $Session -DeviceId "Ethernet17"

This command disables an Ethernet port with device ID Ethernet17 on a network switch. The command uses a CimSession, similar to the first example.

Required Parameters

-CimSession

Specifies the CimSession that this cmdlet uses to connect to the network switch. For more information about CimSession objects, type Get-Help New-CimSession.

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

Specifies a device ID. This cmdlet disables a port on a device that this parameter specifies.

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

Specifies a port to disable.

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

Optional Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
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:None
Accept pipeline input:False
Accept wildcard characters:False

Inputs

CimInstance[]

You can pipe an array of CimInstance objects that correspond to an Ethernet port to this cmdlet.

Outputs

None

This cmdlet does not generate any output.