Edit

Share via

Disable-NetworkSwitchVlan

  • Reference
Module:
NetworkSwitchManager

Disables a VLAN of a network switch.

Syntax

Disable-NetworkSwitchVlan
       -CimSession <CimSession>
       -InstanceId <String>
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Disable-NetworkSwitchVlan
       -CimSession <CimSession>
       -Name <String>
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Disable-NetworkSwitchVlan
       -CimSession <CimSession>
       -VlanID <Int32>
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Description

The Disable-NetworkSwitchVlan cmdlet disables a virtual local area network (VLAN) of a network switch.

Examples

Example 1: Disable a VLAN by using an instance ID

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

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.

Example 2: Disable a VLAN by using a name

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

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

Example 3: Disable a VLAN by using its ID

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

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

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
Required:True
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:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InstanceId

Specifies the instance ID of a VLAN to disable.

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

-Name

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

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

-VlanID

Specifies VLAN ID of the VLAN to disable.

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

Inputs

None

Outputs

Object