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
 

Set-NetworkSwitchPortProperty

Set-NetworkSwitchPortProperty

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

Synopsis

Sets the port properties for a network switch.

Syntax

Set-NetworkSwitchPortProperty [-CimSession] [-Property] [-InformationAction] [-InformationVariable] [<CommonParameters>]

Detailed Description

The Set-NetworkSwitchPortProperty cmdlet sets the port properties for a network switch. This cmdlet can modify any property. If you run this cmdlet, you must specify at least one property to change. Otherwise, the command returns an error.

Parameters

-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

-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

-Property <Hashtable>

Specifies a hash table of name/value pairs. The cmdlet sets the properties that this parameter specifies.

Aliases

none

Required?

false

Position

2

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

CimInstance[]

Return Type

None

Notes

None

Examples

Example 1: Set properties for a port

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 $PortSpeed variable and the $Description variable. These are the values of the key/value pairs.

The final command sets a properties by using the $Session object. The command uses standard syntax to create a hash table that contains the key/value pairs as the value of the Property parameter.

PS C:\>$Session = New-CimSession -ComputerName "NetworkSwitch08"
PS C:\> $PortSpeed = 1
PS C:\> $Description = "Port on management device 02."
PS C:\> Set-NetworkSwitchPortProperty -CimSession $Session -Property @{Speed = $portSpeed; Description = $Description }

Set-NetworkSwitchVlanProperty