BackendSetDetails¶

class oci.network_load_balancer.models.BackendSetDetails(**kwargs)¶

Bases: object

The configuration of a network load balancer backend set. For more information about backend set configuration, see Managing Backend Sets.

Caution: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Attributes

`IP_VERSION_IPV4`	A constant which can be used with the ip_version property of a BackendSetDetails.
`IP_VERSION_IPV6`	A constant which can be used with the ip_version property of a BackendSetDetails.
`POLICY_FIVE_TUPLE`	A constant which can be used with the policy property of a BackendSetDetails.
`POLICY_THREE_TUPLE`	A constant which can be used with the policy property of a BackendSetDetails.
`POLICY_TWO_TUPLE`	A constant which can be used with the policy property of a BackendSetDetails.
`backends`	Gets the backends of this BackendSetDetails.
`health_checker`	[Required] Gets the health_checker of this BackendSetDetails.
`ip_version`	Gets the ip_version of this BackendSetDetails.
`is_fail_open`	Gets the is_fail_open of this BackendSetDetails.
`is_instant_failover_enabled`	Gets the is_instant_failover_enabled of this BackendSetDetails.
`is_preserve_source`	Gets the is_preserve_source of this BackendSetDetails.
`policy`	Gets the policy of this BackendSetDetails.

Methods

__init__(**kwargs) Initializes a new BackendSetDetails object with values from keyword arguments.

IP_VERSION_IPV4 = 'IPV4'¶: A constant which can be used with the ip_version property of a BackendSetDetails. This constant has a value of “IPV4”

IP_VERSION_IPV6 = 'IPV6'¶: A constant which can be used with the ip_version property of a BackendSetDetails. This constant has a value of “IPV6”

POLICY_FIVE_TUPLE = 'FIVE_TUPLE'¶: A constant which can be used with the policy property of a BackendSetDetails. This constant has a value of “FIVE_TUPLE”

POLICY_THREE_TUPLE = 'THREE_TUPLE'¶: A constant which can be used with the policy property of a BackendSetDetails. This constant has a value of “THREE_TUPLE”

POLICY_TWO_TUPLE = 'TWO_TUPLE'¶: A constant which can be used with the policy property of a BackendSetDetails. This constant has a value of “TWO_TUPLE”

__init__(**kwargs)¶

Initializes a new BackendSetDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

policy (str) – The value to assign to the policy property of this BackendSetDetails. Allowed values for this property are: “TWO_TUPLE”, “THREE_TUPLE”, “FIVE_TUPLE”
ip_version (str) – The value to assign to the ip_version property of this BackendSetDetails. Allowed values for this property are: “IPV4”, “IPV6”
is_preserve_source (bool) – The value to assign to the is_preserve_source property of this BackendSetDetails.
is_fail_open (bool) – The value to assign to the is_fail_open property of this BackendSetDetails.
is_instant_failover_enabled (bool) – The value to assign to the is_instant_failover_enabled property of this BackendSetDetails.
backends (list[oci.network_load_balancer.models.Backend]) – The value to assign to the backends property of this BackendSetDetails.
health_checker (oci.network_load_balancer.models.HealthChecker) – The value to assign to the health_checker property of this BackendSetDetails.

backends¶

Gets the backends of this BackendSetDetails. An array of backends.

Returns:	The backends of this BackendSetDetails.
Return type:	list[oci.network_load_balancer.models.Backend]

health_checker¶

[Required] Gets the health_checker of this BackendSetDetails. The health check policy configuration.

Returns:	The health_checker of this BackendSetDetails.
Return type:	oci.network_load_balancer.models.HealthChecker

ip_version¶

Gets the ip_version of this BackendSetDetails. IP version associated with the backend set.

Allowed values for this property are: “IPV4”, “IPV6”

Returns:	The ip_version of this BackendSetDetails.
Return type:	str

is_fail_open¶

Gets the is_fail_open of this BackendSetDetails. If enabled, the network load balancer will continue to distribute traffic in the configured distribution in the event all backends are unhealthy. The value is false by default.

Returns:	The is_fail_open of this BackendSetDetails.
Return type:	bool

is_instant_failover_enabled¶

Gets the is_instant_failover_enabled of this BackendSetDetails. If enabled existing connections will be forwarded to an alternative healthy backend as soon as current backend becomes unhealthy.

Returns:	The is_instant_failover_enabled of this BackendSetDetails.
Return type:	bool

is_preserve_source¶

Gets the is_preserve_source of this BackendSetDetails. If this parameter is enabled, then the network load balancer preserves the source IP of the packet when it is forwarded to backends. Backends see the original source IP. If the isPreserveSourceDestination parameter is enabled for the network load balancer resource, then this parameter cannot be disabled. The value is true by default.

Returns:	The is_preserve_source of this BackendSetDetails.
Return type:	bool

policy¶

Gets the policy of this BackendSetDetails. The network load balancer policy for the backend set.

Example: FIVE_TUPLE

Allowed values for this property are: “TWO_TUPLE”, “THREE_TUPLE”, “FIVE_TUPLE”

Returns:	The policy of this BackendSetDetails.
Return type:	str