PowerShell Logo Small

Remove-NetworkSwitchVlan



This is the built-in help made by Microsoft for the command 'Remove-NetworkSwitchVlan', in PowerShell version 5 - as retrieved from Windows version 'Microsoft Windows Server 2012 R2 Standard' PowerShell help files on 2016-06-23.

For PowerShell version 3 and up, where you have Update-Help, this command was run just before creating the web pages from the help files.

SYNOPSIS

Removes network switch VLANs.

SYNTAX


Remove-NetworkSwitchVlan [-InformationAction {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend}] [-InformationVariable [<System.String>]] [-InstanceId
[<String>]] -CimSession <CimSession> [<CommonParameters>]
Remove-NetworkSwitchVlan [-InformationAction {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend}] [-InformationVariable [<System.String>]] [-Name [<String>]]
-CimSession <CimSession> [<CommonParameters>]
Remove-NetworkSwitchVlan [-InformationAction {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend}] [-InformationVariable [<System.String>]] [-VlanId [<Int32>]]
-CimSession <CimSession> [<CommonParameters>]
Remove-NetworkSwitchVlan [-InformationAction {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend}] [-InformationVariable [<System.String>]] -CimSession
<CimSession> [<CommonParameters>]



Search powershellhelp.space

DESCRIPTION


The Remove-NetworkSwitchVlan cmdlet removes virtual local area networks (VLANs) from a network switch.



<

RELATED LINKS

Disable-NetworkSwitchVlan
Enable-NetworkSwitchVlan
Get-NetworkSwitchVlan
New-NetworkSwitchVlan
Set-NetworkSwitchVlanProperty

REMARKS

<

Examples


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.