Set-VMSwitchTeam

  • Reference
Module:
Hyper-V

Configures a virtual switch team.

Syntax

Set-VMSwitchTeam
   [-ComputerName <String[]>]
   [-Name] <String[]>
   [-NetAdapterName <String[]>]
   [-TeamingMode <VMSwitchTeamingMode>]
   [-LoadBalancingAlgorithm <VMSwitchLoadBalancingAlgorithm>]
   [-Passthru]
   [-CimSession <CimSession[]>]
   [-Credential <PSCredential[]>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-VMSwitchTeam
   [-ComputerName <String[]>]
   [-Name] <String[]>
   [-NetAdapterInterfaceDescription <String[]>]
   [-TeamingMode <VMSwitchTeamingMode>]
   [-LoadBalancingAlgorithm <VMSwitchLoadBalancingAlgorithm>]
   [-Passthru]
   [-CimSession <CimSession[]>]
   [-Credential <PSCredential[]>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-VMSwitchTeam
   [-ComputerName <String[]>]
   [-VMSwitch] <VMSwitch[]>
   [-NetAdapterInterfaceDescription <String[]>]
   [-TeamingMode <VMSwitchTeamingMode>]
   [-LoadBalancingAlgorithm <VMSwitchLoadBalancingAlgorithm>]
   [-Passthru]
   [-CimSession <CimSession[]>]
   [-Credential <PSCredential[]>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-VMSwitchTeam
   [-ComputerName <String[]>]
   [-VMSwitch] <VMSwitch[]>
   [-NetAdapterName <String[]>]
   [-TeamingMode <VMSwitchTeamingMode>]
   [-LoadBalancingAlgorithm <VMSwitchLoadBalancingAlgorithm>]
   [-Passthru]
   [-CimSession <CimSession[]>]
   [-Credential <PSCredential[]>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-VMSwitchTeam cmdlet configures a virtual switch team.

Examples

Example 1: Configure a switch team to user dynamic load balancing

PS C:\> Set-VMSwitchTeam -Name "SwitchTeam07" -LoadBalancingAlgorithm Dynamic

This command configures the switch team named SwitchTeam07 to use a dynamic load balancing algorithm.

Parameters

-CimSession

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Type:CimSession[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ComputerName

Specifies one or more Hyper-V hosts that run this cmdlet. NetBIOS names, IP addresses, and fully qualified domain names are allowable. The default is the local computer. Use localhost or a dot (.) to specify the local computer explicitly.

Type:String[]
Aliases:PSComputerName
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-Credential

Specifies one or more user accounts that have permission to perform this action. The default is the current user.

Type:PSCredential[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LoadBalancingAlgorithm

Specifies the load balancing algorithm that this switch team uses. The acceptable values for this parameter are: Dynamic and HyperVPort. The default value is Dynamic.

Type:VMSwitchLoadBalancingAlgorithm
Accepted values:HyperVPort, Dynamic
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Specifies an array of names of virtual switches that this cmdlet configures for teaming.

Type:String[]
Aliases:SwitchName
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-NetAdapterInterfaceDescription

Specifies an array of interface descriptions of the virtual network adapters that this cmdlet includes in the switch team. This value replaces the existing members.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-NetAdapterName

Specifies an array of names of the virtual network adapters that this cmdlet includes in the switch team. This value replaces the existing members.

Type:String[]
Aliases:InterfaceAlias
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Passthru

Indicates that this cmdlet returns the Microsoft.HyperV.PowerShell.VMSwitch object that it configures.

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

-TeamingMode

Specifies the teaming mode. Currently, the only option is SwitchIndependent.

Type:VMSwitchTeamingMode
Accepted values:SwitchIndependent
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VMSwitch

Specifies an array of virtual switches that this cmdlet configures for teaming. To obtain a VMSwitch object, use the Get-VMSwitch cmdlet.

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

Outputs

Microsoft.HyperV.PowerShell.VMSwitch

This cmdlet returns a VMSwitch object, if you specify the Passthru parameter.