Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Get-VMNetworkAdapterFailoverConfiguration

Last Updated: 3/8/2017

SYNOPSIS

Gets the IP address of a virtual network adapter configured to be used when a virtual machine fails over.

SYNTAX

VMName (Default)

Get-VMNetworkAdapterFailoverConfiguration [-CimSession <CimSession[]>] [-ComputerName <String[]>]
 [-Credential <PSCredential[]>] [-VMName] <String[]> [-VMNetworkAdapterName <String>] [<CommonParameters>]

VMObject

Get-VMNetworkAdapterFailoverConfiguration [-VM] <VirtualMachine[]> [-VMNetworkAdapterName <String>]
 [<CommonParameters>]

ResourceObject

Get-VMNetworkAdapterFailoverConfiguration [-VMNetworkAdapter] <VMNetworkAdapter[]> [<CommonParameters>]

DESCRIPTION

The Get-VMNetworkAdapterFailoverConfiguration cmdlet gets the IP address configuration of a virtual network adapter configured to be used when a virtual machine fails over.

EXAMPLES

Example 1

PS C:\> Get-VMNetworkAdapterFailoverConfiguration VM01

This example gets the failover IP address configuration of all virtual network adapters attached to a virtual machine named VM01.

Example 2

PS C:\> Get-VMNetworkAdapterFailoverConfiguration VM01 -VMNetworkAdapterName NetworkAdapter

This example gets the failover IP address configuration of a virtual network adapter named NetworkAdapter on a virtual machine named VM01.

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[]
Parameter Sets: VMName
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ComputerName

Specifies one or more Hyper-V hosts on which the IP address configuration of a virtual network adapter is to be retrieved. 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[]
Parameter Sets: VMName
Aliases: 

Required: False
Position: Named
Default value: None
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[]
Parameter Sets: VMName
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-VM

Specifies the virtual machine for which you want to get the IP address configuration of a virtual network adapter.

Type: VirtualMachine[]
Parameter Sets: VMObject
Aliases: 

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-VMName

Specifies the name of the virtual machine for which you want to get the IP address configuration of a virtual network adapter.

Type: String[]
Parameter Sets: VMName
Aliases: 

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-VMNetworkAdapter

Specifies the virtual network adapter whose IP address configuration you want to get.

Type: VMNetworkAdapter[]
Parameter Sets: ResourceObject
Aliases: 

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-VMNetworkAdapterName

Specifies the name of the virtual network adapter whose IP address configuration you want to get.

Type: String
Parameter Sets: VMName, VMObject
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

VMNetworkAdapterFailoverConfiguration

NOTES

© 2017 Microsoft