PowerShell Logo Small

Get-NetworkSwitchVlan



This is the built-in help made by Microsoft for the command 'Get-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

Gets VLANs for a network switch.

SYNTAX


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>]



Search powershellhelp.space

DESCRIPTION


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



<

RELATED LINKS

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

REMARKS

<

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.