Share via

Set-SCLogicalSwitch

Module:
VirtualMachineManager Module

Updates the properties of a logical switch.

Syntax

WithExtensions (Default) 

Set-SCLogicalSwitch
    [-LogicalSwitch] <LogicalSwitch>
    [-VirtualSwitchExtensions <VirtualSwitchExtension[]>]
    [-Description <String>]
    [-EnableSriov <Boolean>]
    [-SwitchUplinkMode <SwitchUplinkMode>]
    [-MinimumBandwidthMode <BandwidthMode>]
    [-VMMServer <ServerConnection>]
    [-Name <String>]
    [-EnablePacketDirect <Boolean>]
    [-RunAsynchronously]
    [-PROTipID <Guid>]
    [-JobVariable <String>]
    [<CommonParameters>]

RemoveAllExtensions 

Set-SCLogicalSwitch
    [-LogicalSwitch] <LogicalSwitch>
    [-Description <String>]
    [-EnableSriov <Boolean>]
    [-SwitchUplinkMode <SwitchUplinkMode>]
    [-MinimumBandwidthMode <BandwidthMode>]
    [-VMMServer <ServerConnection>]
    [-RemoveAllExtensions]
    [-Name <String>]
    [-EnablePacketDirect <Boolean>]
    [-RunAsynchronously]
    [-PROTipID <Guid>]
    [-JobVariable <String>]
    [<CommonParameters>]

Description

The Set-SCLogicalSwitch cmdlet updates the properties of a logical switch.

Examples

Example 1: Change the minimum bandwidth mode for a logical switch

PS C:\> Get-SCLogicalSwitch -Name "LogicalSwitch01" | Set-SCLogicalSwitch -MinimumBandwidthMode "Weight"

This command gets the logical switch object named LogicalSwitch01 and uses the pipeline operator to pass the object to Set-SCLogicalSwitch, which changes the minimum bandwitdth mode for logical switch object to Weight.

Example 2: Remove all virtual switch extensions from a logical switch

PS C:\> Get-SCLogicalSwitch -Name "LogicalSwitch01" | Set-SCLogicalSwitch -RemoveAllExtensions

This command gets the logical switch object named LogicalSwitch01 and uses the pipeline operator to pass the object to Set-SCLogicalSwitch, which removes all virtual switch extensions from the logical switch object.

Parameters

-Description

Specifies a description for the specified object.

Parameter properties

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

Parameter sets

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

-EnablePacketDirect

Specifies whether the cmdlet enables Packet Direct on the switch.

Parameter properties

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

Parameter sets

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

-EnableSriov

Indicates whether single-root I/O virtualization (SR-IOV) is enabled.

Parameter properties

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

Parameter sets

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

-JobVariable

Specifies a variable in which job progress is tracked and stored.

Parameter properties

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

Parameter sets

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

-LogicalSwitch

Specifies a logical switch object.

Parameter properties

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

Parameter sets

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

-MinimumBandwidthMode

Specifies the minimum bandwidth mode for the logical switch. The acceptable values for this parameter are:

  • Default
  • Weight
  • Absolute
  • None

Parameter properties

Type:BandwidthMode
Default value:None
Accepted values:Default, Weight, Absolute, None
Supports wildcards:False
DontShow:False

Parameter sets

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

-Name

Specifies the name of a Virtual Machine Manager (VMM) object.

Parameter properties

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

Parameter sets

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

-PROTipID

Specifies the ID of the Performance and Resource Optimization (PRO) tip that triggered this action. This allows for auditing of PRO tips.

Parameter properties

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

Parameter sets

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

-RemoveAllExtensions

Indicates that all virtual switch extensions are removed from the logical switch.

Parameter properties

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

Parameter sets

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

-RunAsynchronously

Indicates that the job runs asynchronously so that control returns to the command shell immediately.

Parameter properties

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

Parameter sets

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

-SwitchUplinkMode

Specifies a switch uplink mode object.

Parameter properties

Type:SwitchUplinkMode
Default value:None
Accepted values:NoTeam, Team, EmbeddedTeam
Supports wildcards:False
DontShow:False

Parameter sets

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

-VirtualSwitchExtensions

Specifies an array of virtual switch extension objects.

To get a virtual switch extension object, use the Get-SCVirtualSwitchExtension cmdlet.

Parameter properties

Type:

VirtualSwitchExtension[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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

-VMMServer

Specifies a VMM server object.

Parameter properties

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

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
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.