Edit

Share via


Connect-VMNetworkAdapter

Connects a virtual network adapter to a virtual switch.

Syntax

Name_SwitchName (Default)

Connect-VMNetworkAdapter
    [[-Name] <String[]>]
    [-SwitchName] <String>
    [-VMName] <String[]>
    [-Passthru]
    [-CimSession <CimSession[]>]
    [-ComputerName <String[]>]
    [-Credential <PSCredential[]>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Object_SwitchName

Connect-VMNetworkAdapter
    [-VMNetworkAdapter] <VMNetworkAdapter[]>
    [-SwitchName] <String>
    [-Passthru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Object_SwitchObject

Connect-VMNetworkAdapter
    [-VMNetworkAdapter] <VMNetworkAdapter[]>
    [-VMSwitch] <VMSwitch>
    [-Passthru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Object_UseAutomaticConnection

Connect-VMNetworkAdapter
    [-VMNetworkAdapter] <VMNetworkAdapter[]>
    [-UseAutomaticConnection]
    [-Passthru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Name_SwitchObject

Connect-VMNetworkAdapter
    [[-Name] <String[]>]
    [-VMSwitch] <VMSwitch>
    [-VMName] <String[]>
    [-Passthru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Name_UseAutomaticConnection

Connect-VMNetworkAdapter
    [[-Name] <String[]>]
    [-VMName] <String[]>
    [-UseAutomaticConnection]
    [-Passthru]
    [-CimSession <CimSession[]>]
    [-ComputerName <String[]>]
    [-Credential <PSCredential[]>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Connect-VMNetworkAdapter cmdlet connects a virtual network adapter to a virtual switch.

Examples

Example 1

PS C:\> Connect-VMNetworkAdapter -VMName Test1,Test2 -Name Internet -SwitchName InternetAccess

Connects a virtual network adapter named Internet in virtual machines Test1 and Test2 to a virtual switch InternetAccess.

Example 2

PS C:\> Get-VMNetworkAdapter -VMName Test1 | Connect-VMNetworkAdapter -SwitchName InternetAccess

Connects a virtual network adapter in virtual machine Test1 to virtual switch InternetAccess.

Example 3

PS C:\> Get-VMSwitch InternetAccess | Connect-VMNetworkAdapter -VMName Test1

Connects a virtual network adapter in virtual machine Test1 to switch InternetAccess.

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

Name_SwitchName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Name_UseAutomaticConnection
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 virtual machine hosts on which the virtual network adapter is to be connected. 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

Name_SwitchName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Name_UseAutomaticConnection
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
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

Name_SwitchName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Name_UseAutomaticConnection
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 network adapter to be connected.

Parameter properties

Type:

String[]

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

Parameter sets

Name_SwitchName
Position:1
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Name_SwitchObject
Position:1
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Name_UseAutomaticConnection
Position:1
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Passthru

Specifies that a Microsoft.HyperV.PowerShell.VMNetworkAdapter object is to be passed through to the pipeline representing the virtual network adapter to be connected.

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

-SwitchName

Specifies the name of the virtual switch to which the virtual network adapter is to be connected.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Name_SwitchName
Position:1
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Object_SwitchName
Position:1
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-UseAutomaticConnection

Specifies that the network adapter is to be connected to any virtual switch in the resource pool, rather than to a specific virtual switch.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Object_UseAutomaticConnection
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Name_UseAutomaticConnection
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-VMName

Specifies the name of the virtual machine in which the network adapter is to be connected.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Name_SwitchName
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Name_SwitchObject
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Name_UseAutomaticConnection
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-VMNetworkAdapter

Specifies the virtual network adapter to be connected.

Parameter properties

Type:

VMNetworkAdapter[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Object_SwitchName
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
Object_SwitchObject
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
Object_UseAutomaticConnection
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-VMSwitch

Specifies the virtual switch to which the virtual network adapter is to be connected.

Parameter properties

Type:VMSwitch
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Object_SwitchObject
Position:2
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
Name_SwitchObject
Position:2
Mandatory:True
Value from pipeline:True
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

None

Default

Microsoft.HyperV.PowerShell.VMNetworkAdapter

If -PassThru is specified.