Edit

Share via

Set-NetworkSwitchPortMode

Module:
NetworkSwitchManager Module

Sets the port mode on a network switch.

Syntax

AccessSet 

Set-NetworkSwitchPortMode
    -CimSession <CimSession>
    -VlanID <Int32>
    -InputObject <CimInstance[]>
    [-AccessMode]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

RouteSet 

Set-NetworkSwitchPortMode
    -CimSession <CimSession>
    -IpAddress <String>
    -SubnetAddress <String>
    -InputObject <CimInstance[]>
    [-RouteMode]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

TrunkSet 

Set-NetworkSwitchPortMode
    -CimSession <CimSession>
    -VlanIDs <UInt16[]>
    -InputObject <CimInstance[]>
    [-TrunkMode]
    [-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.

Parameters

-AccessMode

Indicates that this cmdlet sets the port to access mode.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

AccessSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

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

(All)
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-IpAddress

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

RouteSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RouteMode

Indicates that this cmdlet sets the port to route mode.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

RouteSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SubnetAddress

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

RouteSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TrunkMode

Indicates that this cmdlet sets the port to trunk mode.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

TrunkSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-VlanID

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

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

AccessSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-VlanIDs

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

Parameter properties

Type:

UInt16[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

TrunkSet
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 correspond to a network switch port to this cmdlet.

Outputs

Object