Get-NetworkSwitchVlan
Gets VLANs for a network switch.
Syntax
NameSet (Default)
Get-NetworkSwitchVlan
-CimSession <CimSession>
[-Name <String>]
[<CommonParameters>]
VlanIdSet
Get-NetworkSwitchVlan
-CimSession <CimSession>
-VlanId <Int32>
[<CommonParameters>]
InstanceIdSet
Get-NetworkSwitchVlan
-CimSession <CimSession>
-InstanceId <String>
[<CommonParameters>]
CaptionSet
Get-NetworkSwitchVlan
-CimSession <CimSession>
-Caption <String>
[<CommonParameters>]
DescriptionSet
Get-NetworkSwitchVlan
-CimSession <CimSession>
-Description <String>
[<CommonParameters>]
Description
The Get-NetworkSwitchVlan cmdlet gets available virtual local area networks (VLANs) for a network switch.
Examples
Example 1: Get all VLANs for a network switch
PS C:\>$Session = New-CimSession -ComputerName "NetworkSwitch08"
PS C:\> Get-NetworkSwitchVlan -CimSession $Session
Caption Description Name InstanceID VlanID PSComputerName
------- ----------- ----------- ---------- ------ --------------
Vlan_description default Contoso:NetworkVL... 1 10.19.246.18
Vlan_description VLAN0002 Contoso:NetworkVL... 2 10.19.246.18
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 gets all VLAN for the switch NetworkSwitch08 by using the $Session object.
Example 2: Get a VLAN by using a name
PS C:\>Get-NetworkSwitchVlan -CimSession $Session -Name "VLAN22"
Caption Description Name InstanceID VlanID PSComputerName
------- ----------- ----------- ---------- ------ --------------
Vlan_description VLAN22 Contoso:NetworkVL... 1 10.19.236.49
This command gets the VLAN named VLAN22. The command includes a CimSession, similar to the first example.
Parameters
-Caption
Specifies the caption of a VLAN to get.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
CaptionSet
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-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 |
-Description
Specifies the description of a VLAN to get.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
DescriptionSet
| Position: | Named |
| Mandatory: | True |
| 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 get.
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 get. 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: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-VlanId
Specifies the VLAN ID of the VLAN to get.
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 |
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.