Get-VMNetwork Adapter Failover Configuration

Module:
hyper-v
Gets the IP address of a virtual network adapter configured to be used when a virtual machine fails over.

Syntax 

Get-VMNetworkAdapterFailoverConfiguration
   [-CimSession <CimSession[]>]
   [-ComputerName <String[]>]
   [-Credential <PSCredential[]>]
   [-VMName] <String[]>
   [-VMNetworkAdapterName <String>]
   [<CommonParameters>]
Get-VMNetworkAdapterFailoverConfiguration
   [-VM] <VirtualMachine[]>
   [-VMNetworkAdapterName <String>]
   [<CommonParameters>]
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.

Required Parameters

-VM

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

Type: VirtualMachine[]
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[]
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[]
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

Optional 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
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[]
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[]
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-VMNetworkAdapterName

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

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

Outputs

VMNetworkAdapterFailoverConfiguration