Edit

Set-NetworkSwitchPortProperty

  • Reference
Module:
NetworkSwitchManager

Sets the port properties for a network switch.

Syntax

Set-NetworkSwitchPortProperty
   [-CimSession] <CimSession>
   [[-Property] <Hashtable>]
   [-InputObject] <CimInstance[]>
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

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.

Examples

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

Parameters

-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:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-InputObject

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

Type:CimInstance[]
Position:2
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Property

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

Type:Hashtable
Position:1
Default value:None
Required:False
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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

CimInstance[]

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

Outputs

Object