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
 

Remove-NetworkSwitchVlan

Remove-NetworkSwitchVlan

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

Synopsis

Removes network switch VLANs.

Syntax

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

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

Remove-NetworkSwitchVlan [-InformationAction] [-InformationVariable] [-VlanId] [-CimSession] [<CommonParameters>]

Remove-NetworkSwitchVlan [-InformationAction] [-InformationVariable] [-CimSession] [<CommonParameters>]

Detailed Description

The Remove-NetworkSwitchVlan cmdlet removes virtual local area networks (VLANs) from 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 remove.

Aliases

none

Required?

false

Position

named

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

-Name <String>

Specifies a name for a VLAN to remove. You can use wildcard characters to select multiple VLANs to remove.

Aliases

none

Required?

false

Position

named

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

-VlanId <Int32>

Specifies the ID of a VLAN to remove.

Aliases

none

Required?

false

Position

named

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

CimInstance[]

Return Type

None

Notes

None

Examples

Example 1: Remove a VLAN that has a specified 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 removes the VLAN that has a VLAN ID of 2 for the switch NetworkSwitch08 by using the $Session object.

PS C:\>$Session = New-CimSession -ComputerName "NetworkSwitch08"
PS C:\> Remove-NetworkSwitchVlan -CimSession $Session -VlanID 2

Example 2: Remove a VLAN for a specified instance ID

This command removes the VLAN for the specified instance ID. The command includes a CimSession, similar to the first example.

PS C:\>Remove-NetworkSwitchVlan -CimSession $Session -InstanceID "Contoso:NetworkVLAN:Vlan4"

Example 3: Remove VLANs that have names that contain a string

This command removes all VLANs that have friendly names that include the string Contoso. The command includes a CimSession, similar to the first example.

PS C:\>Remove-NetworkSwitchVlan -CimSession $Session -Name "*Contoso*" 

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