This is the built-in help made by Microsoft for the command 'Set-NetworkSwitchVlanProperty', 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.
Modifies properties on a VLAN on a network switch.
Set-NetworkSwitchVlanProperty [-InformationAction {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend}] [-InformationVariable [<System.String>]] [-Property
[<Hashtable>]] -CimSession <CimSession> -VlanId <Int32[]> [<CommonParameters>]
Set-NetworkSwitchVlanProperty [-InformationAction {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend}] [-InformationVariable [<System.String>]] [-Property
[<Hashtable>]] -CimSession <CimSession> [<CommonParameters>]
The Set-NetworkSwitchVlanProperty cmdlet modifies settable properties on a virtual local area network (VLAN) on a network switch.
<
Disable-NetworkSwitchVlan
Enable-NetworkSwitchVlan
Get-NetworkSwitchVlan
New-NetworkSwitchVlan
Remove-NetworkSwitchVlan
Set-NetworkSwitchPortProperty
<
Example 1: Set properties for a VLAN
PS C:\>$Session = New-CimSession -ComputerName "NetworkSwitch08"
PS C:\> $VlanName = "Contoso VLAN 07"
PS C:\> $Description = "This VLAN is used to create a virtual Contoso company LAN"
PS C:\> Set-NetworkSwitchVlanProperty -VlanId 12 -Property @{ElementName = $VlanName; Description = $Description} -CimSession $Session
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 and third commands assign values to the $VlanName variable and the $Description variable. These are the values of the key/value pairs.
The final command modifies the properties of the VLAN identified by the VLAN ID 5 to include the name/value pairs specified by the Property parameter. The command uses
standard syntax to create a hash table that contains the name/value pairs. The command operates on the network switch named NetworkSwitch08 by using the $Session object.