Set-NetworkSwitchPortProperty

Sets the port properties for a network switch.
Set-NetworkSwitchPortProperty [-CimSession*] <CimSession> [[-Property] [<Hashtable>]] [-InformationAction{SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend}] [-InformationVariable [<System.String>]][<CommonParameters>]

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>

  • This value is required

Specifies the CimSession that this cmdlet uses to connect to the network switch.

-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

-InformationVariable [<System.String>]

Specifies a variable in which to store an information event message.

-Property [<Hashtable>]

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

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,ErrorAction, ErrorVariable, WarningAction, WarningVariable,OutBuffer, PipelineVariable, and OutVariable.

Inputs

CimInstance[]

You can pipe an array of CimInstance objects to this cmdlet.

Outputs

None

This cmdlet does not generate any output.

Examples
  1. Set properties for a port:
    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 }
    

    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.

Related Links

Set-NetworkSwitchVlanProperty