Backend¶

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

Bases: object

The configuration of a backend server that is a member of a load balancer backend set. For more information, see Managing Backend Servers.

Methods:

__init__(**kwargs)

Initializes a new Backend object with values from keyword arguments.

Attributes:

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

__init__(**kwargs)¶

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

Parameters

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

property backup¶

[Required] Gets the backup of this Backend. 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 Backend.
Return type: bool

property drain¶

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

Example: false

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

property ip_address¶

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

Example: 10.0.0.3

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

property max_connections¶

Gets the max_connections of this Backend. The maximum number of simultaneous connections the load balancer can make to the backend. If this is not set or set to 0 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 Backend.
Return type: int

property name¶

[Required] Gets the name of this Backend. A read-only field showing the IP address and port that uniquely identify this backend server in the backend set.

Example: 10.0.0.3:8080

Returns: The name of this Backend.
Return type: str

property offline¶

[Required] Gets the offline of this Backend. Whether the load balancer should treat this server as offline. Offline servers receive no incoming traffic.

Example: false

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

property port¶

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

Example: 8080

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

property weight¶

[Required] Gets the weight of this Backend. 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 Backend.
Return type: int