Disable-NetworkSwitchVlan
Disables a VLAN of a network switch.
Syntax
InstanceIdSet
Disable-NetworkSwitchVlan
-CimSession <CimSession>
-InstanceId <String>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
NameSet
Disable-NetworkSwitchVlan
-CimSession <CimSession>
-Name <String>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
VlanIdSet
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.
Parameter properties
| Type: | CimSession |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InstanceId
Specifies the instance ID of a VLAN to disable.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
InstanceIdSet
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
Specifies the name of a VLAN to disable. This ElementName is a friendly name. It is not necessarily unique.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
NameSet
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-VlanID
Specifies VLAN ID of the VLAN to disable.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
VlanIdSet
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.