NAME
Remove-NetworkSwitchVlan
SYNOPSIS
Removes network switch VLANs.SYNTAX
Remove-NetworkSwitchVlan [-InformationAction {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend}]
[-InformationVariable
] [-InstanceId ] -CimSession [ ] Remove-NetworkSwitchVlan [-InformationAction {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend}]
[-InformationVariable
] [-Name ] -CimSession [ ] Remove-NetworkSwitchVlan [-InformationAction {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend}]
[-InformationVariable
] [-VlanId ] -CimSession [ ] Remove-NetworkSwitchVlan [-InformationAction {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend}]
[-InformationVariable
] -CimSession [ ] DESCRIPTION
The Remove-NetworkSwitchVlan cmdlet removes virtual local area networks (VLANs) from a network switch.
PARAMETERS
-CimSession
Specifies the CimSession that this cmdlet uses to connect to the network switch. For more information aboutCimSession objects, type Get-Help New-CimSession.
Required? true Position? named Default value none Accept pipeline input? false Accept wildcard characters? false-InformationAction [
Specifies how this cmdlet responds to an information event. The acceptable values for this parameter are:] -- SilentlyContinue
-- Stop
-- Continue
-- Inquire
-- Ignore
-- Suspend
Required? false Position? named Default value none Accept pipeline input? false Accept wildcard characters? false-InformationVariable [
Specifies a variable in which to store an information event message. Required? false Position? named Default value none Accept pipeline input? false Accept wildcard characters? false] -InstanceId [
Specifies the instance ID of a VLAN to remove. Required? false Position? named Default value none Accept pipeline input? false Accept wildcard characters? false] -Name [
Specifies a name for a VLAN to remove. You can use wildcard characters to select multiple VLANs to remove. Required? false Position? named Default value none Accept pipeline input? false Accept wildcard characters? false] -VlanId [
Specifies the ID of a VLAN to remove. Required? false Position? named Default value none Accept pipeline input? false Accept wildcard characters? false] This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216). INPUTS
CimInstance[] You can pipe an array of CimInstance objects that correspond to network switch VLANs to this cmdlet.OUTPUTS
None This cmdlet does not generate any output.Example 1: Remove a VLAN that has a specified ID
PS C:\>$Session = New-CimSession -ComputerName "NetworkSwitch08"
PS C:\> Remove-NetworkSwitchVlan -CimSession $Session -VlanID 2
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 removes the VLAN that has a VLAN ID of 2 for the switch NetworkSwitch08 by using the $Session
object.Example 2: Remove a VLAN for a specified instance ID
PS C:\>Remove-NetworkSwitchVlan -CimSession $Session -InstanceID "Contoso:NetworkVLAN:Vlan4"
This command removes the VLAN for the specified instance ID. The command includes a CimSession, similar to the first example.Example 3: Remove VLANs that have names that contain a string
PS C:\>Remove-NetworkSwitchVlan -CimSession $Session -Name "*Contoso*"
This command removes all VLANs that have friendly names that include the string Contoso. The command includes a CimSession, similar to the first example.RELATED LINKS
Disable-NetworkSwitchVlan
Enable-NetworkSwitchVlan
Get-NetworkSwitchVlan
New-NetworkSwitchVlan
Set-NetworkSwitchVlanProperty