Set-NetworkSwitchVlanProperty

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.

Parameters
-CimSession <CimSession>

  • This value is required

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

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

-Property [<Hashtable>]

Specifies a hash table of name/value pairs. The cmdlet sets the properties that this parameter specifies.

-VlanId <Int32[]>

  • This value is required

Specifies an array of VLAN IDs of VLANs to modify.

<CommonParameters>

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

Inputs

CimInstance[]

You can pipe an array of CimInstance objects that represent VLANs to this cmdlet.

Outputs

None

This cmdlet does not generate any output.

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

Related Links

Disable-NetworkSwitchVlan
Enable-NetworkSwitchVlan
Get-NetworkSwitchVlan
New-NetworkSwitchVlan
Remove-NetworkSwitchVlan
Set-NetworkSwitchPortProperty