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-NetworkSwitchVlan

Disable-NetworkSwitchVlan

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

Synopsis

Disables a VLAN of a network switch.

Syntax

Disable-NetworkSwitchVlan [-InformationAction] [-InformationVariable] [-CimSession] [-InstanceId] [<CommonParameters>]

Disable-NetworkSwitchVlan [-InformationAction] [-InformationVariable] [-CimSession] [-Name] [<CommonParameters>]

Disable-NetworkSwitchVlan [-InformationAction] [-InformationVariable] [-CimSession] [-VlanID] [<CommonParameters>]

Detailed Description

The Disable-NetworkSwitchVlan cmdlet disables a virtual local area network (VLAN) of 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

-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

-InstanceId <String>

Specifies the instance ID of a VLAN to disable.

Aliases

none

Required?

true

Position

named

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

-Name <String>

Specifies the name of a VLAN to disable. This ElementName is a friendly name. It is not necessarily unique.

Aliases

none

Required?

true

Position

named

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

-VlanID <Int32>

Specifies VLAN ID of the VLAN to disable.

Aliases

none

Required?

true

Position

named

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

None

Return Type

None

Notes

None

Examples

Example 1: Disable a VLAN by using an instance ID

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.

The second command disables the VLAN that has the instance ID Vlan02 for the switch NetworkSwitch08 by using the $Session object.

PS C:\>$Session = New-CimSession -ComputerName "NetworkSwitch08"
PS C:\> Disable-NetworkSwitchVlan -InstanceID "Vlan02" -CimSession $Session 

Example 2: Disable a VLAN by using a name

This command disables the VLAN named VLAN22. The command includes a CimSession, similar to the first example.

PS C:\>Disable-NetworkSwitchVlan -CimSession $Session -Name "VLAN22"

Example 3: Disable a VLAN by using its ID

This command disables the VLAN that has the VLAN ID 74. The command includes a CimSession, similar to the first example.

PS C:\>Disable-NetworkSwitchVlan -CimSession $Session -VlanId 74 

Enable-NetworkSwitchVlan
Get-NetworkSwitchVlan
New-NetworkSwitchVlan
Remove-NetworkSwitchVlan
Set-NetworkSwitchVlanProperty