This is the built-in help made by Microsoft for the command 'Set-VMNetworkAdapterFailoverConfiguration', in PowerShell version 3 - as retrieved from
Windows version 'Microsoft Windows Server 2012 Standard' PowerShell help files on 2016-06-23.
For PowerShell version 3 and up, where you have Update-Help, this command was run just before creating the web pages from the help files.
Configures the IP address of a virtual network adapter to be used when a virtual machine fails over.
Set-VMNetworkAdapterFailoverConfiguration [-VMName] <String> [-ClearFailoverIPv4Settings] [-ClearFailoverIPv6Settings] [-ComputerName
<String[]>] [-IPv4Address <String>] [-IPv4AlternateDNSServer <String>] [-IPv4DefaultGateway <String>] [-IPv4PreferredDNSServer <String>]
[-IPv4SubnetMask <String>] [-IPv6Address <String>] [-IPv6AlternateDNSServer <String>] [-IPv6DefaultGateway <String>] [-IPv6PreferredDNSServer
<String>] [-IPv6SubnetPrefixLength <Int32>] [-PassThru] [-VMNetworkAdapterName <String>] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-VMNetworkAdapterFailoverConfiguration [-VM] <VirtualMachine> [-ClearFailoverIPv4Settings] [-ClearFailoverIPv6Settings] [-IPv4Address
<String>] [-IPv4AlternateDNSServer <String>] [-IPv4DefaultGateway <String>] [-IPv4PreferredDNSServer <String>] [-IPv4SubnetMask <String>]
[-IPv6Address <String>] [-IPv6AlternateDNSServer <String>] [-IPv6DefaultGateway <String>] [-IPv6PreferredDNSServer <String>]
[-IPv6SubnetPrefixLength <Int32>] [-PassThru] [-VMNetworkAdapterName <String>] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-VMNetworkAdapterFailoverConfiguration [-VMNetworkAdapter] <VMNetworkAdapterBase> [-ClearFailoverIPv4Settings] [-ClearFailoverIPv6Settings]
[-IPv4Address <String>] [-IPv4AlternateDNSServer <String>] [-IPv4DefaultGateway <String>] [-IPv4PreferredDNSServer <String>] [-IPv4SubnetMask
<String>] [-IPv6Address <String>] [-IPv6AlternateDNSServer <String>] [-IPv6DefaultGateway <String>] [-IPv6PreferredDNSServer <String>]
[-IPv6SubnetPrefixLength <Int32>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>]
The Set-VMNetworkAdapterFailoverConfiguration cmdlet sets the configuration of an IP address of a virtual network adapter to be used when a
virtual machine fails over.
<
<
Example 1
PS C:\>Get-VMNetworkAdapter VM01 NetworkAdapter01 | Set-VMNetworkAdapterFailoverConfiguration –IPv4Address 10.100.1.100 –IPv4SubnetMask
255.255.255.0
This example configures a failover IPv4 address for virtual network adapter NetworkAdapter01 on virtual machine VM01.
Example 2
PS C:\>Get-VMNetworkAdapter VM01 NetworkAdapter01 | Set-VMNetworkAdapterFailoverConfiguration –ClearFailoverIPv4Settings
This example clears the current failover IPv4 settings on virtual network adapter NetworkAdapter01 for virtual machine VM01.
Example 3
PS C:\>Get-VMNetworkAdapter VM01 NetworkAdapter01 | Set-VMNetworkAdapterFailoverConfiguration –Ipv6Address
aaaa:aaaa:aaaa:aaaa:aaaa:aaaa:aaa:aaaa –Ipv6SubnetPrefixLength 12
This example configures an IPv6 address and a prefix length of 12 for a virtual network adapter NetworkAdapter01 for virtual machine VM01.
Example 4
PS C:\>Get-VMNetworkAdapter VM01 NetworkAdapter01 | Set-VMNetworkAdapterFailoverConfiguration –ClearFailoverIPv6Settings
This example clears the current failover IPv6 settings on a virtual network adapter NetworkAdapter01 for virtual machine VM01.