Edit

Share via


Add-VMSwitchTeamMember

Adds members to a virtual switch team.

Syntax

SwitchName_NetAdapterName (Default)

Add-VMSwitchTeamMember
    [-VMSwitchName] <String[]>
    [-ComputerName <String[]>]
    [-NetAdapterName <String[]>]
    [-Passthru]
    [-CimSession <CimSession[]>]
    [-Credential <PSCredential[]>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SwitchName_NetAdapterInterfaceDescription

Add-VMSwitchTeamMember
    [-VMSwitchName] <String[]>
    [-ComputerName <String[]>]
    [-NetAdapterInterfaceDescription <String[]>]
    [-Passthru]
    [-CimSession <CimSession[]>]
    [-Credential <PSCredential[]>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SwitchObject_NetAdapterInterfaceDescription

Add-VMSwitchTeamMember
    [-VMSwitch] <VMSwitch[]>
    [-ComputerName <String[]>]
    [-NetAdapterInterfaceDescription <String[]>]
    [-Passthru]
    [-CimSession <CimSession[]>]
    [-Credential <PSCredential[]>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SwitchObject_NetAdapterName

Add-VMSwitchTeamMember
    [-VMSwitch] <VMSwitch[]>
    [-ComputerName <String[]>]
    [-NetAdapterName <String[]>]
    [-Passthru]
    [-CimSession <CimSession[]>]
    [-Credential <PSCredential[]>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Add-VMSwitchTeamMember cmdlet adds adapters as members to a virtual switch team.

Examples

Example 1: Add network adapters to a switch team

PS C:\> $VMSwitch = Get-VMSwitch -Name "Switch03"
PS C:\> Add-VMSwitchTeamMember -VMSwitch $VMSwitch -NetAdapterName "Adapter01","Adapter04"

The first command gets the virtual switch team named Switch03, and then stores it in the $VMSwitch variable.

The second command adds the network adapters named Adapter01 and Adapter04 as team members to the switch team in $VMSwitch.

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.

Parameter properties

Type:

CimSession[]

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

-ComputerName

Specifies one or more Hyper-V hosts that runs 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.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:PSComputerName

Parameter sets

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

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

-Credential

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

Parameter properties

Type:

PSCredential[]

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

-NetAdapterInterfaceDescription

Specifies an array of interface descriptions of the virtual network adapters that this cmdlet adds to the switch team.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SwitchName_NetAdapterInterfaceDescription
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
SwitchObject_NetAdapterInterfaceDescription
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NetAdapterName

Specifies an array of names of virtual network adapters that this cmdlet adds to the switch team.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:InterfaceAlias

Parameter sets

SwitchName_NetAdapterName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
SwitchObject_NetAdapterName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Passthru

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

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

-VMSwitch

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

Parameter properties

Type:

VMSwitch[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SwitchObject_NetAdapterInterfaceDescription
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
SwitchObject_NetAdapterName
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-VMSwitchName

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

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:SwitchName

Parameter sets

SwitchName_NetAdapterName
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
SwitchName_NetAdapterInterfaceDescription
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

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

Outputs

Microsoft.HyperV.PowerShell.VMSwitch

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