Get-VMNetworkAdapterFailoverConfiguration
Gets the IP address of a virtual network adapter configured to be used when a virtual machine fails over.
Syntax
VMName (Default)
Get-VMNetworkAdapterFailoverConfiguration
[-VMName] <String[]>
[-CimSession <CimSession[]>]
[-ComputerName <String[]>]
[-Credential <PSCredential[]>]
[-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.
Parameter properties
| Type: | CimSession[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
VMName
| 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 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.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
VMName
| 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
VMName
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-VM
Specifies the virtual machine for which you want to get the IP address configuration of a virtual network adapter.
Parameter properties
| Type: | VirtualMachine[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
VMObject
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-VMName
Specifies the name of the virtual machine for which you want to get the IP address configuration of a virtual network adapter.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
VMName
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-VMNetworkAdapter
Specifies the virtual network adapter whose IP address configuration you want to get.
Parameter properties
| Type: | VMNetworkAdapter[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ResourceObject
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-VMNetworkAdapterName
Specifies the name of the virtual network adapter whose IP address configuration you want to get.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
VMName
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
VMObject
| 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.