Set-VMNetworkAdapterFailoverConfiguration

Set-VMNetworkAdapterFailoverConfiguration

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

Syntax

Parameter Set: VMName
Set-VMNetworkAdapterFailoverConfiguration [-VMName] <String> [-CimSession <Microsoft.Management.Infrastructure.CimSession[]> ] [-ClearFailoverIPv4Settings] [-ClearFailoverIPv6Settings] [-ComputerName <String[]> ] [-Credential <System.Management.Automation.PSCredential[]> ] [-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>]

Parameter Set: ResourceObject
Set-VMNetworkAdapterFailoverConfiguration [-VMNetworkAdapter] <VMNetworkAdapter> [-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>]

Parameter Set: VMObject
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>]

Detaillierte Beschreibung

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.

Parameter

-CimSession<Microsoft.Management.Infrastructure.CimSession[]>

Das Cmdlet wird in einer Remotesitzung oder auf einem Remotecomputer ausgeführt. Geben Sie einen Computernamen oder ein Sitzungsobjekt ein, wie z. B. die Ausgabe eines New-CimSession oder Get-CimSession-Cmdlets. Der Standardwert ist die aktuelle Sitzung auf dem lokalen Computer.

Aliase	none
Erforderlich?	false
Position?	named
Standardwert	none
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-ClearFailoverIPv4Settings

Clears the configured IPv4 failover settings. The IPv4 address configured in the primary virtual machine (static or dynamic) will be used by the Replica virtual machine.

Aliase	none
Erforderlich?	false
Position?	named
Standardwert	none
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-ClearFailoverIPv6Settings

Clears the configured IPv6 failover settings. The IPv6 address configured in the primary virtual machine (static or dynamic) will be used by the Replica virtual machine.

Aliase	none
Erforderlich?	false
Position?	named
Standardwert	none
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-ComputerName<String[]>

Specifies one or more Hyper-V hosts on which the IP address configuration of a virtual network adapter is to be set. 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.

Aliase	none
Erforderlich?	false
Position?	named
Standardwert	none
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-Credential<System.Management.Automation.PSCredential[]>

Specifies one or more user accounts that have permission to perform this action. The default is the current user.

Aliase	none
Erforderlich?	false
Position?	named
Standardwert	none
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-Passthru

Specifies that a Microsoft.HyperV.PowerShell.VMNetworkAdapterFailoverConfiguration object is to be passed through to the pipeline representing the IP address configuration to be set.

Aliase	none
Erforderlich?	false
Position?	named
Standardwert	none
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-VM<VirtualMachine>

Specifies the virtual machine for which you want to configure the IP address.

Aliase	none
Erforderlich?	true
Position?	1
Standardwert	none
Pipelineeingaben akzeptieren?	True (ByValue)
Platzhalterzeichen akzeptieren?	false

-VMName<String>

Specifies the friendly name of the virtual machine for which you want to configure the IP address.

Aliase	none
Erforderlich?	true
Position?	1
Standardwert	none
Pipelineeingaben akzeptieren?	True (ByValue)
Platzhalterzeichen akzeptieren?	false

-VMNetworkAdapter<VMNetworkAdapter>

Specifies the virtual network adapter for which you want to configure the IP address.

Aliase	none
Erforderlich?	true
Position?	1
Standardwert	none
Pipelineeingaben akzeptieren?	True (ByValue, ByPropertyName)
Platzhalterzeichen akzeptieren?	false

-IPv4Address<String>

Specifies the IPv4 address to set on the VMNetworkAdapter for use on failover of the virtual machine. You must also specify the IPv4SubnetMask parameter when you specify this parameter.

Aliase	none
Erforderlich?	false
Position?	named
Standardwert	none
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-IPv4AlternateDNSServer<String>

Specifies the IPv4 alternate DNS server to be set on the VMNetworkAdapter for use on failover of the virtual machine.

Aliase	none
Erforderlich?	false
Position?	named
Standardwert	none
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-IPv4DefaultGateway<String>

Specifies the IPv4 default gateway to be set on VMNetworkAdapter for use on failover of the virtual machine..

Aliase	none
Erforderlich?	false
Position?	named
Standardwert	none
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-IPv4PreferredDNSServer<String>

Specifies the IPv4 preferred DNS server to be set on VMNetworkAdapter for use on failover of the virtual machine.

Aliase	none
Erforderlich?	false
Position?	named
Standardwert	none
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-IPv4SubnetMask<String>

Specifies the IPv4 subnet mask to be set on VMNetworkAdapter for use on failover of the virtual machine. You must specify the IPv4Address parameter when you specify this parameter.

Aliase	none
Erforderlich?	false
Position?	named
Standardwert	none
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-IPv6Address<String>

Specifies the IPv6 address to be set on VMNetworkAdapter for use on failover of the virtual machine. You must specify the IPv6SubnetPrefixLength parameter when you specify this parameter.

Aliase	none
Erforderlich?	false
Position?	named
Standardwert	none
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-IPv6AlternateDNSServer<String>

Specifies the IPv6 alternate DNS server to be set on VMNetworkAdapter for use on failover of the virtual machine.

Aliase	none
Erforderlich?	false
Position?	named
Standardwert	none
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-IPv6DefaultGateway<String>

Specifies the IPv6 default gateway to be set on VMNetworkAdapter for use on failover of the virtual machine.

Aliase	none
Erforderlich?	false
Position?	named
Standardwert	none
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-IPv6PreferredDNSServer<String>

Specifies the IPv6 preferred DNS server to be set on VMNetworkAdapter for use on failover of the virtual machine.

Aliase	none
Erforderlich?	false
Position?	named
Standardwert	none
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-IPv6SubnetPrefixLength<Int32]>

Specifies the IPv6 subnet prefix length to be set on VMNetworkAdapter for use on failover of the virtual machine. You must specify the IPv6Address parameter when you specify this parameter.

Aliase	none
Erforderlich?	false
Position?	named
Standardwert	none
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-VMNetworkAdapterName<String>

Specifies the name of the virtual network adapter for which you want to set the IP address.

Aliase	none
Erforderlich?	false
Position?	named
Standardwert	none
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-Confirm

Fordert Sie vor der Ausführung des Cmdlet zum Bestätigen auf.

Erforderlich?	false
Position?	named
Standardwert	false
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-WhatIf

Zeit, was passieren würde, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.

Erforderlich?	false
Position?	named
Standardwert	false
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

<CommonParameters>

Dieses Cmdlet unterstützt die allgemeinen Parameter: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer und -OutVariable. Weitere Informationen finden Sie unter about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Eingaben

Der Eingabetyp ist der Typ der Objekte, die Sie per Piping an das Cmdlet übergeben können.

Ausgaben

Der Ausgabetyp ist der Typ der Objekte, die vom Cmdlet ausgegeben werden.

• None by default; Microsoft.HyperV.PowerShell.VMNetworkAdapterFailoverConfiguration if –PassThru is specified.

Beispiele

Example 1

This example configures a failover IPv4 address for virtual network adapter NetworkAdapter01 on virtual machine VM01.

PS C:\> Get-VMNetworkAdapter VM01 NetworkAdapter01 | Set-VMNetworkAdapterFailoverConfiguration –IPv4Address 10.100.1.100 –IPv4SubnetMask 255.255.255.0

Example 2

This example clears the current failover IPv4 settings on virtual network adapter NetworkAdapter01 for virtual machine VM01.

PS C:\> Get-VMNetworkAdapter VM01 NetworkAdapter01 | Set-VMNetworkAdapterFailoverConfiguration –ClearFailoverIPv4Settings

Example 3

This example configures an IPv6 address and a prefix length of 12 for a virtual network adapter NetworkAdapter01 for virtual machine VM01.

PS C:\> Get-VMNetworkAdapter VM01 NetworkAdapter01 | Set-VMNetworkAdapterFailoverConfiguration –Ipv6Address aaaa:aaaa:aaaa:aaaa:aaaa:aaaa:aaa:aaaa –Ipv6SubnetPrefixLength 12

Example 4

This example clears the current failover IPv6 settings on a virtual network adapter NetworkAdapter01 for virtual machine VM01.

PS C:\> Get-VMNetworkAdapter VM01 NetworkAdapter01 | Set-VMNetworkAdapterFailoverConfiguration –ClearFailoverIPv6Settings