Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Add-VMNetworkAdapter
- Module:
- Hyper-V Module
Adds a virtual network adapter to a virtual machine.
Syntax
VMName (Default)
Add-VMNetworkAdapter
[-VMName] <String[]>
[-CimSession <CimSession[]>]
[-ComputerName <String[]>]
[-Credential <PSCredential[]>]
[-SwitchName <String>]
[-IsLegacy <Boolean>]
[-Name <String>]
[-DynamicMacAddress]
[-StaticMacAddress <String>]
[-Passthru]
[-ResourcePoolName <String>]
[-DeviceNaming <OnOffState>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ManagementOS
Add-VMNetworkAdapter
[-CimSession <CimSession[]>]
[-ComputerName <String[]>]
[-Credential <PSCredential[]>]
[-ManagementOS]
[-SwitchName <String>]
[-Name <String>]
[-DynamicMacAddress]
[-StaticMacAddress <String>]
[-Passthru]
[-DeviceNaming <OnOffState>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
VMObject
Add-VMNetworkAdapter
[-VM] <VirtualMachine[]>
[-SwitchName <String>]
[-IsLegacy <Boolean>]
[-Name <String>]
[-DynamicMacAddress]
[-StaticMacAddress <String>]
[-Passthru]
[-ResourcePoolName <String>]
[-DeviceNaming <OnOffState>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Add-VMNetworkAdapter cmdlet adds a virtual network adapter to a virtual machine.
Examples
Example 1
PS C:\> Add-VMNetworkAdapter -VMName Redmond -Name "Redmond NIC1"
This example adds a virtual network adapter named Redmond NIC1 to a virtual machine named Redmond.
Example 2
PS C:\> Add-VMNetworkAdapter -VMName Test -SwitchName Network
This example adds a virtual network adapter to a virtual machine named Test and connects it to a virtual switch named Network.
Example 3
PS C:\> Get-VM Test | Add-VMNetworkAdapter -IsLegacy $true -Name Bootable
This example uses two cmdlets and the pipeline in one command to perform the operation.
Example 4
PS C:\> Add-VMNetworkAdapter -ManagementOS -Name Secondary
This example adds a second virtual network adapter in the management operating system.
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
-ComputerName
Specifies one or more Hyper-V hosts on which the virtual network adapter is to be added. 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 |
Parameter sets
-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
-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
-DeviceNaming
The Add-VMNetworkAdapter cmdlet adds a virtual network adapter to a virtual machine.
Parameter properties
| Type: | OnOffState |
| Default value: | None |
| Accepted values: | On, Off |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-DynamicMacAddress
Assigns a dynamically generated MAC address to the new virtual network adapter.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-IsLegacy
Specifies whether the virtual network adapter is the legacy type.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ManagementOS
Specifies the management operating system.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Name
Specifies a name for the new virtual network adapter. The default value is "Network Adapter."
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | VMNetworkAdapterName |
Parameter sets
-Passthru
Specifies that an object is to be passed through to be pipeline representing the network adapter to be added. If you specify -ManagementOS, the object passed is a Microsoft.HyperV.PowerShell.VMInternalNetworkAdapter; otherwise the object passed is a Microsoft.HyperV.PowerShell.VMNetworkAdapter.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ResourcePoolName
Specifies the friendly name of a resource pool.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-StaticMacAddress
Assigns a specific MAC address to the new virtual network adapter.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-SwitchName
Specifies the name of the virtual switch to connect to the new network adapter. If the switch name is not unique, then the operation fails.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-VM
Specifies the virtual machine on which the network adapter is to be added.
Parameter properties
| Type: | VirtualMachine[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-VMName
Specifies the name of the virtual machine on which the network adapter is to be added.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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
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.
Inputs
None
Outputs
None
By default, this cmdlet doesn't return any output.
Microsoft.HyperV.PowerShell.VMNetworkAdapter
If PassThru is specified, a Microsoft.HyperV.PowerShell.VMNetworkAdapter object is output by default.
Microsoft.HyperV.PowerShell.VMInternalNetworkAdapter
If PassThru and ManagementOS is specified, then Microsoft.HyperV.PowerShell.VMInternalNetworkAdapter is output.
Feedback
Was this page helpful?