< Back

New-NetworkSwitchVlan

Tue Jan 29, 2019 10:30 pm

NAME New-NetworkSwitchVlan



SYNOPSIS

Creates a VLAN for a network switch.





SYNTAX

New-NetworkSwitchVlan [-CimSession] <CimSession> [[-Caption] <String>] [[-Description] <String>] [-VlanID] <Int32> [-Name] <String>

[-InformationAction {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend}] [-InformationVariable <System.String>] [<CommonParameters>]





DESCRIPTION

The New-NetworkSwitchVlan cmdlet creates a virtual local area network (VLAN) for a network switch.





PARAMETERS

-Caption [<String>]

Specifies a caption for the new VLAN.



Required? false

Position? 2

Default value none

Accept pipeline input? false

Accept wildcard characters? false



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



Required? true

Position? 1

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-Description [<String>]

Specifies a description of the new VLAN.



Required? false

Position? 3

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



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.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-Name <String>

Specifies a name to use as the VLAN ElementName. This is a friendly name.



Required? true

Position? 5

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-VlanID <Int32>

Specifies a VLAN ID for the new VLAN.



Required? true

Position? 4

Default value none

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

None









OUTPUTS

None



This cmdlet does not generate any output.





Example 1: Create a VLAN



PS C:\\>$Session = New-CimSession -ComputerName "NetworkSwitch08"

PS C:\\> New-NetworkSwitchVlan -Name "Contoso07VLAN" -Caption "VLAN 07" -CimSession $Session

Caption Description ElementName InstanceID VlanID PSComputerName

------- ----------- ----------- ---------- ------ --------------

VLAN 07 VLAN0004 Contoso:NetworkVL... 4 10.19.26.4



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 creates a VLAN for the switch NetworkSwitch08 by using the $Session object.







RELATED LINKS

Disable-NetworkSwitchVlan

Enable-NetworkSwitchVlan

Get-NetworkSwitchVlan

Remove-NetworkSwitchVlan

Set-NetworkSwitchVlanProperty