Set-NetworkSwitchVlanProperty
Modifies properties on a VLAN on a network switch.
Syntax
VlanIdSet
Set-NetworkSwitchVlanProperty
-CimSession <CimSession>
-VlanId <Int32[]>
[-Property <Hashtable>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
InputObjectSet
Set-NetworkSwitchVlanProperty
-CimSession <CimSession>
-InputObject <CimInstance[]>
[-Property <Hashtable>]
[-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.
Parameter properties
| Type: | CimSession |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InputObject
Specifies the input object that is used in a pipeline command.
Parameter properties
| Type: | CimInstance[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
InputObjectSet
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Property
Specifies a hash table of name/value pairs. The cmdlet sets the properties that this parameter specifies.
Parameter properties
| Type: | Hashtable |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-VlanId
Specifies an array of VLAN IDs of VLANs to modify.
Parameter properties
| Type: | Int32[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
VlanIdSet
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
CimInstance
You can pipe an array of CimInstance objects that represent VLANs to this cmdlet.