str
Specifies whether fast IP move is enabled, and if so, the
mechanism to achieve it. Supported values are: - DISABLED:
Fast IP Move is disabled. You can only use the
haPolicy.leader API to update the leader. - >GARP_RA:
Provides a method to very quickly define a new network
endpoint as the leader. This method is faster than updating
the leader using the haPolicy.leader API. Fast IP move works
as follows: The VM hosting the network endpoint that should
become the new leader sends either a Gratuitous ARP (GARP)
packet (IPv4) or an ICMPv6 Router Advertisement(RA) packet
(IPv6). Google Cloud immediately but temporarily associates
the forwarding rule IP address with that VM, and both new
and in-flight packets are quickly delivered to that VM. Note
the important properties of the Fast IP Move functionality:
- The GARP/RA-initiated re-routing stays active for
approximately 20 minutes. After triggering fast failover,
you must also appropriately set the haPolicy.leader. - The
new leader instance should continue to send GARP/RA packets
periodically every 10 seconds until at least 10 minutes
after updating the haPolicy.leader (but stop immediately if
it is no longer the leader). - After triggering a fast
failover, we recommend that you wait at least 3 seconds
before sending another GARP/RA packet from a different VM
instance to avoid race conditions. - Don't send GARP/RA
packets from different VM instances at the same time. If
multiple instances continue to send GARP/RA packets, traffic
might be routed to different destinations in an alternating
order. This condition ceases when a single instance issues a
GARP/RA packet. - The GARP/RA request always takes priority
over the leader API. Using the haPolicy.leader API to change
the leader to a different instance will have no effect until
the GARP/RA request becomes inactive. - The GARP/RA packets
should follow the GARP/RA Packet Specifications.. - When
multiple forwarding rules refer to a regional backend
service, you need only send a GARP or RA packet for a single
forwarding rule virtual IP. The virtual IPs for all
forwarding rules targeting the same backend service will
also be moved to the sender of the GARP or RA packet. The
following are the Fast IP Move limitations (that is, when
fastIPMove is not DISABLED): - Multiple forwarding rules
cannot use the same IP address if one of them refers to a
regional backend service with fastIPMove. - The regional
backend service must set the network field, and all NEGs
must belong to that network. However, individual NEGs can
belong to different subnetworks of that network. - The
maximum number of network endpoints across all backends of a
backend service with fastIPMove is 32. - The maximum number
of backend services with fastIPMove that can have the same
network endpoint attached to one of its backends is 64. -
The maximum number of backend services with fastIPMove in a
VPC in a region is 64. - The network endpoints that are
attached to a backend of a backend service with fastIPMove
cannot resolve to Gen3+ machines for IPv6. - Traffic
directed to the leader by a static route next hop will not
be redirected to a new leader by fast failover. Such traffic
will only be redirected once an haPolicy.leader update has
taken effect. Only traffic to the forwarding rule's virtual
IP will be redirected to a new leader by fast failover.
haPolicy.fastIPMove can be set only at backend service
creation time. Once set, it cannot be updated. By default,
fastIpMove is set to DISABLED. Check the FastIPMove enum for
the list of possible values.
This field is a member of oneof_ _fast_i_p_move.
leader
google.cloud.compute_v1.types.BackendServiceHAPolicyLeader
Selects one of the network endpoints attached
to the backend NEGs of this service as the
active endpoint (the leader) that receives all
traffic. When the leader changes, there is no
connection draining to persist existing
connections on the old leader. You are
responsible for selecting a suitable endpoint as
the leader. For example, preferring a healthy
endpoint over unhealthy ones. Note that this
service does not track backend endpoint health,
and selects the configured leader
unconditionally.
This field is a member of oneof_ _leader.
Classes
FastIPMove
FastIPMove(value)
Specifies whether fast IP move is enabled, and if so, the mechanism
to achieve it. Supported values are: - DISABLED: Fast IP Move is
disabled. You can only use the haPolicy.leader API to update the
leader. - >GARP_RA: Provides a method to very quickly define a new
network endpoint as the leader. This method is faster than updating
the leader using the haPolicy.leader API. Fast IP move works as
follows: The VM hosting the network endpoint that should become the
new leader sends either a Gratuitous ARP (GARP) packet (IPv4) or an
ICMPv6 Router Advertisement(RA) packet (IPv6). Google Cloud
immediately but temporarily associates the forwarding rule IP
address with that VM, and both new and in-flight packets are quickly
delivered to that VM. Note the important properties of the Fast IP
Move functionality: - The GARP/RA-initiated re-routing stays active
for approximately 20 minutes. After triggering fast failover, you
must also appropriately set the haPolicy.leader. - The new leader
instance should continue to send GARP/RA packets periodically every
10 seconds until at least 10 minutes after updating the
haPolicy.leader (but stop immediately if it is no longer the
leader). - After triggering a fast failover, we recommend that you
wait at least 3 seconds before sending another GARP/RA packet from a
different VM instance to avoid race conditions. - Don't send GARP/RA
packets from different VM instances at the same time. If multiple
instances continue to send GARP/RA packets, traffic might be routed
to different destinations in an alternating order. This condition
ceases when a single instance issues a GARP/RA packet. - The GARP/RA
request always takes priority over the leader API. Using the
haPolicy.leader API to change the leader to a different instance
will have no effect until the GARP/RA request becomes inactive. -
The GARP/RA packets should follow the GARP/RA Packet
Specifications.. - When multiple forwarding rules refer to a
regional backend service, you need only send a GARP or RA packet for
a single forwarding rule virtual IP. The virtual IPs for all
forwarding rules targeting the same backend service will also be
moved to the sender of the GARP or RA packet. The following are the
Fast IP Move limitations (that is, when fastIPMove is not DISABLED):
Multiple forwarding rules cannot use the same IP address if one of
them refers to a regional backend service with fastIPMove. - The
regional backend service must set the network field, and all NEGs
must belong to that network. However, individual NEGs can belong to
different subnetworks of that network. - The maximum number of
network endpoints across all backends of a backend service with
fastIPMove is 32. - The maximum number of backend services with
fastIPMove that can have the same network endpoint attached to one
of its backends is 64. - The maximum number of backend services with
fastIPMove in a VPC in a region is 64. - The network endpoints that
are attached to a backend of a backend service with fastIPMove
cannot resolve to Gen3+ machines for IPv6. - Traffic directed to the
leader by a static route next hop will not be redirected to a new
leader by fast failover. Such traffic will only be redirected once
an haPolicy.leader update has taken effect. Only traffic to the
forwarding rule's virtual IP will be redirected to a new leader by
fast failover. haPolicy.fastIPMove can be set only at backend
service creation time. Once set, it cannot be updated. By default,
fastIpMove is set to DISABLED.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-11 UTC."],[],[],null,["# Class BackendServiceHAPolicy (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/python/docs/reference/compute/latest/google.cloud.compute_v1.types.BackendServiceHAPolicy)\n- [1.34.0](/python/docs/reference/compute/1.34.0/google.cloud.compute_v1.types.BackendServiceHAPolicy)\n- [1.33.0](/python/docs/reference/compute/1.33.0/google.cloud.compute_v1.types.BackendServiceHAPolicy)\n- [1.32.0](/python/docs/reference/compute/1.32.0/google.cloud.compute_v1.types.BackendServiceHAPolicy)\n- [1.31.0](/python/docs/reference/compute/1.31.0/google.cloud.compute_v1.types.BackendServiceHAPolicy)\n- [1.30.0](/python/docs/reference/compute/1.30.0/google.cloud.compute_v1.types.BackendServiceHAPolicy)\n- [1.29.0](/python/docs/reference/compute/1.29.0/google.cloud.compute_v1.types.BackendServiceHAPolicy)\n- [1.28.0](/python/docs/reference/compute/1.28.0/google.cloud.compute_v1.types.BackendServiceHAPolicy)\n- [1.27.0](/python/docs/reference/compute/1.27.0/google.cloud.compute_v1.types.BackendServiceHAPolicy)\n- [1.26.0](/python/docs/reference/compute/1.26.0/google.cloud.compute_v1.types.BackendServiceHAPolicy)\n- [1.25.0](/python/docs/reference/compute/1.25.0/google.cloud.compute_v1.types.BackendServiceHAPolicy)\n- [1.24.0](/python/docs/reference/compute/1.24.0/google.cloud.compute_v1.types.BackendServiceHAPolicy)\n- [1.23.0](/python/docs/reference/compute/1.23.0/google.cloud.compute_v1.types.BackendServiceHAPolicy)\n- [1.22.0](/python/docs/reference/compute/1.22.0/google.cloud.compute_v1.types.BackendServiceHAPolicy)\n- [1.21.0](/python/docs/reference/compute/1.21.0/google.cloud.compute_v1.types.BackendServiceHAPolicy)\n- [1.20.1](/python/docs/reference/compute/1.20.1/google.cloud.compute_v1.types.BackendServiceHAPolicy)\n- [1.19.2](/python/docs/reference/compute/1.19.2/google.cloud.compute_v1.types.BackendServiceHAPolicy)\n- [1.18.0](/python/docs/reference/compute/1.18.0/google.cloud.compute_v1.types.BackendServiceHAPolicy)\n- [1.17.0](/python/docs/reference/compute/1.17.0/google.cloud.compute_v1.types.BackendServiceHAPolicy)\n- [1.16.1](/python/docs/reference/compute/1.16.1/google.cloud.compute_v1.types.BackendServiceHAPolicy)\n- [1.15.0](/python/docs/reference/compute/1.15.0/google.cloud.compute_v1.types.BackendServiceHAPolicy)\n- [1.14.1](/python/docs/reference/compute/1.14.1/google.cloud.compute_v1.types.BackendServiceHAPolicy)\n- [1.13.0](/python/docs/reference/compute/1.13.0/google.cloud.compute_v1.types.BackendServiceHAPolicy)\n- [1.12.1](/python/docs/reference/compute/1.12.1/google.cloud.compute_v1.types.BackendServiceHAPolicy)\n- [1.11.0](/python/docs/reference/compute/1.11.0/google.cloud.compute_v1.types.BackendServiceHAPolicy)\n- [1.10.1](/python/docs/reference/compute/1.10.1/google.cloud.compute_v1.types.BackendServiceHAPolicy)\n- [1.9.0](/python/docs/reference/compute/1.9.0/google.cloud.compute_v1.types.BackendServiceHAPolicy)\n- [1.8.0](/python/docs/reference/compute/1.8.0/google.cloud.compute_v1.types.BackendServiceHAPolicy)\n- [1.7.0](/python/docs/reference/compute/1.7.0/google.cloud.compute_v1.types.BackendServiceHAPolicy)\n- [1.6.1](/python/docs/reference/compute/1.6.1/google.cloud.compute_v1.types.BackendServiceHAPolicy)\n- [1.5.2](/python/docs/reference/compute/1.5.2/google.cloud.compute_v1.types.BackendServiceHAPolicy)\n- [1.4.0](/python/docs/reference/compute/1.4.0/google.cloud.compute_v1.types.BackendServiceHAPolicy)\n- [1.3.2](/python/docs/reference/compute/1.3.2/google.cloud.compute_v1.types.BackendServiceHAPolicy)\n- [1.2.0](/python/docs/reference/compute/1.2.0/google.cloud.compute_v1.types.BackendServiceHAPolicy)\n- [1.1.0](/python/docs/reference/compute/1.1.0/google.cloud.compute_v1.types.BackendServiceHAPolicy)\n- [1.0.0](/python/docs/reference/compute/1.0.0/google.cloud.compute_v1.types.BackendServiceHAPolicy)\n- [0.9.0](/python/docs/reference/compute/0.9.0/google.cloud.compute_v1.types.BackendServiceHAPolicy)\n- [0.8.0](/python/docs/reference/compute/0.8.0/google.cloud.compute_v1.types.BackendServiceHAPolicy)\n- [0.7.0](/python/docs/reference/compute/0.7.0/google.cloud.compute_v1.types.BackendServiceHAPolicy)\n- [0.6.0](/python/docs/reference/compute/0.6.0/google.cloud.compute_v1.types.BackendServiceHAPolicy)\n- [0.5.0](/python/docs/reference/compute/0.5.0/google.cloud.compute_v1.types.BackendServiceHAPolicy)\n- [0.4.2](/python/docs/reference/compute/0.4.2/google.cloud.compute_v1.types.BackendServiceHAPolicy)\n- [0.3.0](/python/docs/reference/compute/0.3.0/google.cloud.compute_v1.types.BackendServiceHAPolicy)\n- [0.2.1](/python/docs/reference/compute/0.2.1/google.cloud.compute_v1.types.BackendServiceHAPolicy)\n- [0.1.0](/python/docs/reference/compute/0.1.0/google.cloud.compute_v1.types.BackendServiceHAPolicy) \n\n BackendServiceHAPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\n.. _oneof: \u003chttps://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields\u003e\n\nClasses\n-------\n\n### FastIPMove\n\n FastIPMove(value)\n\nSpecifies whether fast IP move is enabled, and if so, the mechanism\nto achieve it. Supported values are: - DISABLED: Fast IP Move is\ndisabled. You can only use the haPolicy.leader API to update the\nleader. - \\\u003eGARP_RA: Provides a method to very quickly define a new\nnetwork endpoint as the leader. This method is faster than updating\nthe leader using the haPolicy.leader API. Fast IP move works as\nfollows: The VM hosting the network endpoint that should become the\nnew leader sends either a Gratuitous ARP (GARP) packet (IPv4) or an\nICMPv6 Router Advertisement(RA) packet (IPv6). Google Cloud\nimmediately but temporarily associates the forwarding rule IP\naddress with that VM, and both new and in-flight packets are quickly\ndelivered to that VM. Note the important properties of the Fast IP\nMove functionality: - The GARP/RA-initiated re-routing stays active\nfor approximately 20 minutes. After triggering fast failover, you\nmust also appropriately set the haPolicy.leader. - The new leader\ninstance should continue to send GARP/RA packets periodically every\n10 seconds until at least 10 minutes after updating the\nhaPolicy.leader (but stop immediately if it is no longer the\nleader). - After triggering a fast failover, we recommend that you\nwait at least 3 seconds before sending another GARP/RA packet from a\ndifferent VM instance to avoid race conditions. - Don't send GARP/RA\npackets from different VM instances at the same time. If multiple\ninstances continue to send GARP/RA packets, traffic might be routed\nto different destinations in an alternating order. This condition\nceases when a single instance issues a GARP/RA packet. - The GARP/RA\nrequest always takes priority over the leader API. Using the\nhaPolicy.leader API to change the leader to a different instance\nwill have no effect until the GARP/RA request becomes inactive. -\nThe GARP/RA packets should follow the GARP/RA Packet\nSpecifications.. - When multiple forwarding rules refer to a\nregional backend service, you need only send a GARP or RA packet for\na single forwarding rule virtual IP. The virtual IPs for all\nforwarding rules targeting the same backend service will also be\nmoved to the sender of the GARP or RA packet. The following are the\nFast IP Move limitations (that is, when fastIPMove is not DISABLED):\n\n- Multiple forwarding rules cannot use the same IP address if one of them refers to a regional backend service with fastIPMove. - The regional backend service must set the network field, and all NEGs must belong to that network. However, individual NEGs can belong to different subnetworks of that network. - The maximum number of network endpoints across all backends of a backend service with fastIPMove is 32. - The maximum number of backend services with fastIPMove that can have the same network endpoint attached to one of its backends is 64. - The maximum number of backend services with fastIPMove in a VPC in a region is 64. - The network endpoints that are attached to a backend of a backend service with fastIPMove cannot resolve to Gen3+ machines for IPv6. - Traffic directed to the leader by a static route next hop will not be redirected to a new leader by fast failover. Such traffic will only be redirected once an haPolicy.leader update has taken effect. Only traffic to the forwarding rule's virtual IP will be redirected to a new leader by fast failover. haPolicy.fastIPMove can be set only at backend service creation time. Once set, it cannot be updated. By default, fastIpMove is set to DISABLED."]]