Add-VMSwitch
Adds a virtual switch to an Ethernet resource pool.
Syntax
NetworkByName (Default)
Add-VMSwitch
[-Name] <String[]>
[-ResourcePoolName] <String[]>
[-CimSession <CimSession[]>]
[-ComputerName <String[]>]
[-Credential <PSCredential[]>]
[<CommonParameters>]
NetworkByObject
Add-VMSwitch
[-VMSwitch] <VMSwitch[]>
[-ResourcePoolName] <String[]>
[<CommonParameters>]
Description
The Add-VMSwitch cmdlet adds a virtual switch to an Ethernet resource pool.
Examples
Example 1
PS C:\> Add-VMSwitch -Name Test -ResourcePoolName "Engineering Department"
Adds virtual switch Test to Ethernet resource pool Engineering Department.
Example 2
PS C:\> Get-VMSwitch -Name Test | Add-VMSwitch -ResourcePoolName "Engineering Department"
Adds virtual switch Test to Ethernet resource pool Engineering Department.
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
NetworkByName
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ComputerName
Specifies an array of Hyper-V hosts. The cmdlet adds the virtual switch on the Hyper-V hosts that you specify.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
NetworkByName
| 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
NetworkByName
| 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 the virtual switch to be added.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | SwitchName |
Parameter sets
NetworkByName
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ResourcePoolName
Specifies the name of the resource pool to which the virtual switch is to be added.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-VMSwitch
Specifies the virtual switch to be added to the Ethernet resource pool.
Parameter properties
| Type: | VMSwitch[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
NetworkByObject
| Position: | 0 |
| Mandatory: | True |
| 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.
Outputs
None
By default, this cmdlet doesn't return any output.
Microsoft.HyperV.PowerShell.VMNetwork
When you use the PassThru parameter, this cmdlet returns a Microsoft.HyperV.PowerShell.VMNetwork object.