Remove-NetworkSwitchVlan
Removes network switch VLANs.
Syntax
InstanceIdSet
Remove-NetworkSwitchVlan
-CimSession <CimSession>
[-InstanceId <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
NameSet
Remove-NetworkSwitchVlan
-CimSession <CimSession>
[-Name <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
VlanIdSet
Remove-NetworkSwitchVlan
-CimSession <CimSession>
[-VlanId <Int32>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
InputObjectSet
Remove-NetworkSwitchVlan
-CimSession <CimSession>
-InputObject <CimInstance[]>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Remove-NetworkSwitchVlan cmdlet removes virtual local area networks (VLANs) from a network switch.
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.
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 |
-InputObject
Specifies the input object that is used in a pipeline command.
Parameter properties
| Type: | CimInstance[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
InputObjectSet
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InstanceId
Specifies the instance ID of a VLAN to remove.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
InstanceIdSet
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
Specifies a name for a VLAN to remove. You can use wildcard characters to select multiple VLANs to remove.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
NameSet
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-VlanId
Specifies the ID of a VLAN to remove.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
VlanIdSet
| Position: | Named |
| Mandatory: | False |
| 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.
Inputs
CimInstance
You can pipe an array of CimInstance objects that correspond to network switch VLANs to this cmdlet.