Set-Network Switch Port Mode

Module:
networkswitchmanager
Sets the port mode on a network switch.

Syntax 

Set-NetworkSwitchPortMode
   -CimSession <CimSession>
   [-AccessMode]
   -VlanID <Int32>
   -InputObject <CimInstance[]>
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-NetworkSwitchPortMode
   -CimSession <CimSession>
   [-RouteMode]
   -IpAddress <String>
   -SubnetAddress <String>
   -InputObject <CimInstance[]>
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-NetworkSwitchPortMode
   -CimSession <CimSession>
   [-TrunkMode]
   -VlanIDs <UInt16[]>
   -InputObject <CimInstance[]>
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-NetworkSwitchPortMode cmdlet sets the port mode to access, trunk or route on a network switch.

Examples

Example 1: Set a port to trunk mode 

PS C:\>$Session = New-CimSession -ComputerName "NetworkSwitch08"
PS C:\> Set-NetworkSwitchPortMode -CimSession $Session -TrunkMode -VlanIDs 2,17,22

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 command sets NetworkSwitch08 to use trunk mode by using the $Session object. The command specifies IDs for three VLANs.

Example 2: Set a port to route mode 

PS C:\>Set-NetworkSwitchPortMode -CimSession $Session -IpAddress "10.14.1.1" -RouteMode -SubnetAddress "255.255.0.0"

This command sets the port to route mode. The command specifies its IP address and the subnet mask. The command includes a CimSession , similar to the first example.

Required Parameters

-AccessMode

Indicates that this cmdlet sets the port to access mode.

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-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 .

Type: CimSession
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-InputObject

Specifies the input object that is used in a pipeline command.

Type: CimInstance[]
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-IpAddress

Specifies an IP address to set for the port in route mode.

Type: String
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RouteMode

Indicates that this cmdlet sets the port to route mode.

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SubnetAddress

Specifies the subnet mask to set for the port in route mode.

Type: String
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-TrunkMode

Indicates that this cmdlet sets the port to trunk mode.

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-VlanID

Specifies the virtual local area network (VLAN) ID of the VLAN to set for the port in access mode.

Type: Int32
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-VlanIDs

Specifies the VLAN IDs of the VLANs to set for the port in trunk mode.

Type: UInt16[]
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Optional Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Aliases: cf
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Aliases: wi
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Inputs

CimInstance[]

You can pipe an array of CimInstance objects that correspond to a network switch port to this cmdlet.

Outputs

None

This cmdlet does not generate any output.