Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Set-NetworkSwitchVlanProperty

Set-NetworkSwitchVlanProperty

networkswitchglobalsettingdata.psm1, networkswitchvlan.psm1, networkswitchethernetport.psm1, networkswitchfeature.psm1, networkswitchconfiguration.psm1

Synopsis

Modifies properties on a VLAN on a network switch.

Syntax

Set-NetworkSwitchVlanProperty [-InformationAction] [-InformationVariable] [-Property] [-CimSession] [-VlanId] [<CommonParameters>]

Set-NetworkSwitchVlanProperty [-InformationAction] [-InformationVariable] [-Property] [-CimSession] [<CommonParameters>]

Detailed Description

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

Parameters

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

Aliases

none

Required?

true

Position

named

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

-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

Aliases

infa

Required?

false

Position

named

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

-InformationVariable <System.String>

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

Aliases

iv

Required?

false

Position

named

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

-Property <Hashtable>

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

Aliases

none

Required?

false

Position

named

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

-VlanId <Int32[]>

Specifies an array of VLAN IDs of VLANs to modify.

Aliases

none

Required?

true

Position

named

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

CimInstance[]

Return Type

None

Notes

None

Examples

Example 1: Set properties for a VLAN

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.

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

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