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
 

New-NetworkSwitchVlan

New-NetworkSwitchVlan

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

Synopsis

Creates a VLAN for a network switch.

Syntax

New-NetworkSwitchVlan [-CimSession] [-Caption] [-Description] [-VlanID] [-Name] [-InformationAction] [-InformationVariable] [<CommonParameters>]

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

Aliases

none

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.

Aliases

none

Required?

true

Position

1

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

-Description <String>

Specifies a description of the new VLAN.

Aliases

none

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

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

-Name <String>

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

Aliases

none

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.

Aliases

none

Required?

true

Position

4

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

None

Return Type

None

Notes

None

Examples

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

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  

Disable-NetworkSwitchVlan
Enable-NetworkSwitchVlan
Get-NetworkSwitchVlan
Remove-NetworkSwitchVlan
Set-NetworkSwitchVlanProperty