Remove-VMSwitchTeamMember
Removes a member from a virtual machine switch team.
Syntax
Remove-VMSwitchTeamMember
[-ComputerName <String[]>]
[-VMSwitchName] <String[]>
[-NetAdapterName <String[]>]
[-Passthru]
[-CimSession <CimSession[]>]
[-Credential <PSCredential[]>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Remove-VMSwitchTeamMember
[-ComputerName <String[]>]
[-VMSwitchName] <String[]>
[-NetAdapterInterfaceDescription <String[]>]
[-Passthru]
[-CimSession <CimSession[]>]
[-Credential <PSCredential[]>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Remove-VMSwitchTeamMember
[-ComputerName <String[]>]
[-VMSwitch] <VMSwitch[]>
[-NetAdapterInterfaceDescription <String[]>]
[-Passthru]
[-CimSession <CimSession[]>]
[-Credential <PSCredential[]>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Remove-VMSwitchTeamMember
[-ComputerName <String[]>]
[-VMSwitch] <VMSwitch[]>
[-NetAdapterName <String[]>]
[-Passthru]
[-CimSession <CimSession[]>]
[-Credential <PSCredential[]>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Remove-VMSwitchTeamMember cmdlet removes virtual network adapters from a virtual machine switch team.
Examples
Example 1: Remove network adapters from a switch team
PS C:\> $VMSwitch = Get-VMSwitch -Name "Switch03"
PS C:\> Remove-VMSwitchTeamMember -VMSwitch $VMSwitch -NetAdapterName "Adapter01","Adapter04"The first command gets the virtual switch named Switch03, and then stores that object in the $VMSwitch variable.
The second command removes the network adapters named Adapter01 and Adapter04 as team members from the switch 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.
| 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 |
-NetAdapterInterfaceDescription
Specifies an array of interface descriptions of virtual network adapters that this cmdlet removes from a switch team.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NetAdapterName
Specifies an array of names of virtual network adapters that this cmdlet removes from a switch team.
| 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 modifies.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VMSwitch
Specifies an array of virtual switches from which this cmdlet removes network adapters. 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 |
-VMSwitchName
Specifies an array of names of virtual switches from which this cmdlet removes network adapters.
| Type: | String[] |
| Aliases: | SwitchName |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| 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: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Outputs
Microsoft.HyperV.PowerShell.VMSwitch[]
This cmdlet returns an array of VMSwitch objects, if you specify the Passthru parameter.