Get-VMNetworkAdapterFailoverConfiguration
Get-VMNetworkAdapterFailoverConfiguration
Gets the IP address of a virtual network adapter configured to be used when a virtual machine fails over.
Syntax
Parameter Set: VMName
Get-VMNetworkAdapterFailoverConfiguration [-VMName] <String[]> [-ComputerName <String[]> ] [-VMNetworkAdapterName <String> ] [ <CommonParameters>]
Parameter Set: ResourceObject
Get-VMNetworkAdapterFailoverConfiguration [-VMNetworkAdapter] <VMNetworkAdapterBase[]> [ <CommonParameters>]
Parameter Set: VMObject
Get-VMNetworkAdapterFailoverConfiguration [-VM] <VirtualMachine[]> [-VMNetworkAdapterName <String> ] [ <CommonParameters>]
Detailed 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.
Parameters
-ComputerName<String[]>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
. |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VM<VirtualMachine[]>
Specifies the virtual machine for which you want to get the IP address configuration of a virtual network adapter.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-VMName<String[]>
Specifies the name of the virtual machine for which you want to get the IP address configuration of a virtual network adapter.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
true |
-VMNetworkAdapter<VMNetworkAdapterBase[]>
Specifies the virtual network adapter whose IP address configuration you want to get.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-VMNetworkAdapterName<String>
Specifies the name of the virtual network adapter whose IP address configuration you want to get.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
- VMNetworkAdapterFailoverConfiguration
Examples
Example 1
This example gets the failover IP address configuration of all virtual network adapters attached to a virtual machine named VM01.
PS C:\> Get-VMNetworkAdapterFailoverConfiguration VM01
Example 2
This example gets the failover IP address configuration of a virtual network adapter named NetworkAdapter on a virtual machine named VM01.
PS C:\> Get-VMNetworkAdapterFailoverConfiguration VM01 –VMNetworkAdapterName NetworkAdapter