Windows PowerShell command on Get-command Set-NetworkSwitchVlanProperty

NAME

Set-NetworkSwitchVlanProperty

SYNOPSIS

Modifies properties on a VLAN on a network switch.

SYNTAX

Set-NetworkSwitchVlanProperty [-InformationAction {SilentlyContinue | Stop | Continue | Inquire | Ignore |

Suspend}] [-InformationVariable ] [-Property ] -CimSession -VlanId

[]

Set-NetworkSwitchVlanProperty [-InformationAction {SilentlyContinue | Stop | Continue | Inquire | Ignore |

Suspend}] [-InformationVariable ] [-Property ] -CimSession

[]

DESCRIPTION

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

network switch.

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.

Required? true Position? named Default value none Accept pipeline input? false Accept wildcard characters? false

-InformationAction []

Specifies how this cmdlet responds to an information event. The acceptable values for this parameter are:

-- SilentlyContinue

-- Stop

-- Continue

-- Inquire

-- Ignore

-- Suspend

Required? false Position? named Default value none Accept pipeline input? false Accept wildcard characters? false

-InformationVariable []

Specifies a variable in which to store an information event message. Required? false Position? named Default value none Accept pipeline input? false Accept wildcard characters? false

-Property []

Specifies a hash table of name/value pairs. The cmdlet sets the properties that this parameter specifies. Required? false Position? named Default value none Accept pipeline input? false Accept wildcard characters? false

-VlanId

Specifies an array of VLAN IDs of VLANs to modify. Required? true Position? named Default value none Accept pipeline input? false Accept wildcard characters? false This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).

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.

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.