Edit

Share via

Set-NetworkSwitchVlanProperty

  • Reference
Module:
NetworkSwitchManager

Modifies properties on a VLAN on a network switch.

Syntax

Set-NetworkSwitchVlanProperty
   -CimSession <CimSession>
   [-Property <Hashtable>]
   -VlanId <Int32[]>
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-NetworkSwitchVlanProperty
   -CimSession <CimSession>
   [-Property <Hashtable>]
   -InputObject <CimInstance[]>
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-NetworkSwitchVlanProperty cmdlet modifies settable properties on a virtual local area network (VLAN) on a network switch.

Examples

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.

Parameters

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

Type:CimSession
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Specifies the input object that is used in a pipeline command.

Type:CimInstance[]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Property

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

Type:Hashtable
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VlanId

Specifies an array of VLAN IDs of VLANs to modify.

Type:Int32[]
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

CimInstance[]

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

Outputs

Object