Get-NetworkSwitchVlan

Gets VLANs for a network switch.
Get-NetworkSwitchVlan [-InformationAction {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend}][-InformationVariable [<System.String>]] -Caption* <String> -CimSession* <CimSession> [<CommonParameters>]
Get-NetworkSwitchVlan [-InformationAction {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend}][-InformationVariable [<System.String>]] [-Name [<String>]] -CimSession* <CimSession> [<CommonParameters>]
Get-NetworkSwitchVlan [-InformationAction {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend}][-InformationVariable [<System.String>]] -CimSession* <CimSession> -VlanId* <Int32> [<CommonParameters>]
Get-NetworkSwitchVlan [-InformationAction {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend}][-InformationVariable [<System.String>]] -CimSession* <CimSession> -InstanceId* <String> [<CommonParameters>]
Get-NetworkSwitchVlan [-InformationAction {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend}][-InformationVariable [<System.String>]] -CimSession* <CimSession> -Description* <String> [<CommonParameters>]

The Get-NetworkSwitchVlan cmdlet gets available virtual local area networks (VLANs) for a network switch.

Parameters
-Caption <String>

  • This value is required

Specifies the caption of a VLAN to get.

-CimSession <CimSession>

  • This value is required

Specifies the CimSession that this cmdlet uses to connect to the network switch.

-Description <String>

  • This value is required

Specifies the description of a VLAN to get.

-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

-InformationVariable [<System.String>]

Specifies a variable in which to store an information event message.

-InstanceId <String>

  • This value is required

Specifies the instance ID of a VLAN to get.

-Name [<String>]

Specifies the name of a VLAN to get. This ElementName is a friendly name. It is not necessarily unique.

-VlanId <Int32>

  • This value is required

Specifies the VLAN ID of the VLAN to get.

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,ErrorAction, ErrorVariable, WarningAction, WarningVariable,OutBuffer, PipelineVariable, and OutVariable.

Inputs

None

Outputs

CimInstance[]

This cmdlet returns an array of CimInstance objects for network switch VLANs.

Examples
  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.

  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.

Related Links

Disable-NetworkSwitchVlan
Enable-NetworkSwitchVlan
New-NetworkSwitchVlan
Remove-NetworkSwitchVlan
Set-NetworkSwitchVlanProperty