Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Disable-NetworkSwitchEthernetPort

Disable-NetworkSwitchEthernetPort

networkswitchconfiguration.psm1, networkswitchethernetport.psm1, networkswitchfeature.psm1, networkswitchglobalsettingdata.psm1, networkswitchvlan.psm1

Synopsis

Disables an Ethernet port on a network switch.

Syntax

Disable-NetworkSwitchEthernetPort [-InformationAction] [-InformationVariable] [-CimSession] [-DeviceID] [<CommonParameters>]

Disable-NetworkSwitchEthernetPort [-InformationAction] [-InformationVariable] [-CimSession] [-PortNumber] [<CommonParameters>]

Disable-NetworkSwitchEthernetPort [-InformationAction] [-InformationVariable] [-CimSession] [<CommonParameters>]

Detailed Description

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

Parameters

-CimSession <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.

Aliases

none

Required?

true

Position

named

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

-DeviceID <String>

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

Aliases

none

Required?

true

Position

named

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

-InformationAction <System.Management.Automation.ActionPreference>

Specifies how this cmdlet responds to an information event. The acceptable values for this parameter are: -- SilentlyContinue -- Stop -- Continue -- Inquire -- Ignore -- Suspend

Aliases

infa

Required?

false

Position

named

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

-InformationVariable <System.String>

Specifies a variable in which to store an information event message.

Aliases

iv

Required?

false

Position

named

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

-PortNumber <Int32>

Specifies a port to disable.

Aliases

none

Required?

true

Position

named

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

CimInstance[]

Return Type

None

Notes

None

Examples

Example 1: Disable a port

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.

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

Example 2: Disable a port by using a device ID

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

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

Enable-NetworkSwitchEthernetPort
Get-NetworkSwitchEthernetPort