BackendSummary¶

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

Bases: object

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

Methods

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

Attributes

`ip_address`	Gets the ip_address of this BackendSummary.
`is_backup`	Gets the is_backup of this BackendSummary.
`is_drain`	Gets the is_drain of this BackendSummary.
`is_offline`	Gets the is_offline of this BackendSummary.
`name`	Gets the name of this BackendSummary.
`port`	[Required] Gets the port of this BackendSummary.
`target_id`	Gets the target_id of this BackendSummary.
`weight`	Gets the weight of this BackendSummary.

__init__(**kwargs)¶

Initializes a new BackendSummary 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 BackendSummary.
ip_address (str) – The value to assign to the ip_address property of this BackendSummary.
target_id (str) – The value to assign to the target_id property of this BackendSummary.
port (int) – The value to assign to the port property of this BackendSummary.
weight (int) – The value to assign to the weight property of this BackendSummary.
is_drain (bool) – The value to assign to the is_drain property of this BackendSummary.
is_backup (bool) – The value to assign to the is_backup property of this BackendSummary.
is_offline (bool) – The value to assign to the is_offline property of this BackendSummary.

ip_address¶

Gets the ip_address of this BackendSummary. The IP address of the backend server. Example: 10.0.0.3

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

is_backup¶

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

Example: false

Returns:	The is_backup of this BackendSummary.
Return type:	bool

is_drain¶

Gets the is_drain of this BackendSummary. Whether the network load balancer should drain this server. Servers marked “isDrain” receive no incoming traffic.

Example: false

Returns:	The is_drain of this BackendSummary.
Return type:	bool

is_offline¶

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

Example: false

Returns:	The is_offline of this BackendSummary.
Return type:	bool

name¶

Gets the name of this BackendSummary. A read-only field showing the IP address/IP OCID and port that uniquely identify this backend server in the backend set.

Example: 10.0.0.3:8080, or ocid1.privateip..oc1.<var><unique_ID></var>:443 or 10.0.0.3:0

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

port¶

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

Example: 8080

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

target_id¶

Gets the target_id of this BackendSummary. The IP OCID/Instance OCID associated with the backend server. Example: ocid1.privateip..oc1.<var><unique_ID></var>

Returns:	The target_id of this BackendSummary.
Return type:	str

weight¶

Gets the weight of this BackendSummary. The network 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 three times the number of new connections as a server weighted ‘1’. For more information about load balancing policies, see How Network Load Balancing Policies Work.

Example: 3

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