BackendDetails¶

class oci.load_balancer.models.BackendDetails(**kwargs)¶

Bases: object

The load balancing configuration details of a backend server.

Methods

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

Attributes

`backup`	Gets the backup of this BackendDetails.
`drain`	Gets the drain of this BackendDetails.
`ip_address`	[Required] Gets the ip_address of this BackendDetails.
`max_connections`	Gets the max_connections of this BackendDetails.
`offline`	Gets the offline of this BackendDetails.
`port`	[Required] Gets the port of this BackendDetails.
`weight`	Gets the weight of this BackendDetails.

__init__(**kwargs)¶

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

Parameters:

ip_address (str) – The value to assign to the ip_address property of this BackendDetails.
port (int) – The value to assign to the port property of this BackendDetails.
weight (int) – The value to assign to the weight property of this BackendDetails.
max_connections (int) – The value to assign to the max_connections property of this BackendDetails.
backup (bool) – The value to assign to the backup property of this BackendDetails.
drain (bool) – The value to assign to the drain property of this BackendDetails.
offline (bool) – The value to assign to the offline property of this BackendDetails.

backup¶

Gets the backup of this BackendDetails. Whether the load balancer should treat this server as a backup unit. If true, the load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as “backup” fail the health check policy.

Note: You cannot add a backend server marked as backup to a backend set that uses the IP Hash policy.

Example: false

Returns:	The backup of this BackendDetails.
Return type:	bool

drain¶

Gets the drain of this BackendDetails. Whether the load balancer should drain this server. Servers marked “drain” receive no new incoming traffic.

Example: false

Returns:	The drain of this BackendDetails.
Return type:	bool

ip_address¶

[Required] Gets the ip_address of this BackendDetails. The IP address of the backend server.

Example: 10.0.0.3

Returns:	The ip_address of this BackendDetails.
Return type:	str

max_connections¶

Gets the max_connections of this BackendDetails. The maximum number of simultaneous connections the load balancer can make to the backend. If this is not set then the maximum number of simultaneous connections the load balancer can make to the backend is unlimited.

Example: 300

Returns:	The max_connections of this BackendDetails.
Return type:	int

offline¶

Gets the offline of this BackendDetails. Whether the load balancer should treat this server as offline. Offline servers receive no incoming traffic.

Example: false

Returns:	The offline of this BackendDetails.
Return type:	bool

port¶

[Required] Gets the port of this BackendDetails. The communication port for the backend server.

Example: 8080

Returns:	The port of this BackendDetails.
Return type:	int

weight¶

Gets the weight of this BackendDetails. The load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger proportion of incoming traffic. For example, a server weighted ‘3’ receives 3 times the number of new connections as a server weighted ‘1’. For more information on load balancing policies, see How Load Balancing Policies Work.

Example: 3

Returns:	The weight of this BackendDetails.
Return type:	int