Set-SCLogicalSwitch
Set-SCLogicalSwitch
Updates the properties of a logical switch.
Syntax
Parameter Set: WithExtensions
Set-SCLogicalSwitch [-LogicalSwitch] <LogicalSwitch> [-Description <String> ] [-EnableSriov <Boolean> ] [-JobVariable <String> ] [-MinimumBandwidthMode <BandwidthMode> {Default | Weight | Absolute | None} ] [-Name <String> ] [-PROTipID <Guid> ] [-RunAsynchronously] [-SwitchUplinkMode <SwitchUplinkMode> {NoTeam | Team} ] [-VirtualSwitchExtensions <VirtualSwitchExtension[]> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Parameter Set: RemoveAllExtensions
Set-SCLogicalSwitch [-LogicalSwitch] <LogicalSwitch> -RemoveAllExtensions [-Description <String> ] [-EnableSriov <Boolean> ] [-JobVariable <String> ] [-MinimumBandwidthMode <BandwidthMode> {Default | Weight | Absolute | None} ] [-Name <String> ] [-PROTipID <Guid> ] [-RunAsynchronously] [-SwitchUplinkMode <SwitchUplinkMode> {NoTeam | Team} ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Detailed Description
The Set-SCLogicalSwitch cmdlet updates the properties of a logical switch.
Parameters
-Description<String>
States a description for the specified object.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-EnableSriov<Boolean>
Specifies whether single-root I/O virtualization (SR-IOV) is enabled.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-JobVariable<String>
Specifies that job progress is tracked and stored in the variable named by this parameter.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-LogicalSwitch<LogicalSwitch>
Specifies a logical switch object.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-MinimumBandwidthMode<BandwidthMode>
Specifies the minimum bandwith mode for the logical swtich. Valid values are: Default, Weight, Absolute, None.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies the name of a VMM object.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-PROTipID<Guid>
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-RemoveAllExtensions
Indicates that all virtual switch extensions are removed from the logical switch.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-RunAsynchronously
Indicates that the job runs asynchronously so that control returns to the command shell immediately.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-SwitchUplinkMode<SwitchUplinkMode>
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VirtualSwitchExtensions<VirtualSwitchExtension[]>
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-VMMServer<ServerConnection>
Specifies a VMM server object.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
1: Change the minimum bandwidth mode for a logical switch.
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.
PS C:\> Get-SCLogicalSwitch -Name "LogicalSwitch01" | Set-SCLogicalSwitch -MinimumBandwidthMode "Weight"
2: Remove all virtual switch extensions from a logical switch.
This command gets the logical switch object named LogicalSwtich01 and uses the pipeline operator to pass the object to Set-SCLogicalSwitch which removes all virtual swich extensions from the logical switch object.
PS C:\> Get-SCLogicalSwitch -Name "LogicalSwitch01" | Set-SCLogicalSwitch -RemoveAllExtensions