oci_load_balancer_backend - Add, modify and remove a backend from a load balancer in OCI Load Balancing Service¶

New in version 2.5.

Synopsis
- Requirements
Parameters
Notes
Examples
Return Values
Status
- Author

Synopsis ¶

Add a Backend server to OCI Load Balancer
Update a Backend server in a Load Balancer, if present, with any changed attribute
Delete a Backend server from OCI Load Balancer Backends, if present.

Requirements ¶

The below requirements are needed on the host that executes this module.

python >= 2.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io

Parameters ¶

Parameter	Choices/Defaults	Comments
api_user		The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_OCID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See `config_file_location`). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint		Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See `config_file_location`). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file		Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See `config_file_location`). If the key is encrypted with a pass-phrase, the `api_user_key_pass_phrase` option must also be provided.
api_user_key_pass_phrase		Passphrase used by the key referenced in `api_user_key_file`, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See `config_file_location`).
auth_type	Choices: api_key ← instance_principal	The type of authentication to use for making API requests. By default `auth_type="api_key"` based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use `auth_type="instance_principal"` to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
backend_set_name required		The name of the backend set to add the backend server to.
backup bool	Choices: no ← yes	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.
config_file_location		Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name	Default: DEFAULT	The profile to load from the config file referenced by `config_file_location`. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in `config_file_location`.
drain bool	Choices: no ← yes	Whether the load balancer should drain this server. Servers marked "drain" receive no new incoming traffic.
ip_address required		The IP address of the backend server.
load_balancer_id required		Identifier of the Load Balancer in which the Backend belongs. aliases: id
offline bool	Choices: no ← yes	Whether the load balancer should treat this server as offline. Offline servers receive no incoming traffic.
port required		The communication port for the backend server.
region		The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See `config_file_location`). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
state	Choices: present ← absent	Create,update or delete Load Balancer Backend. For state=present, if it does not exists, it gets added. If exists, it gets updated.
tenancy		OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See `config_file_location`). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm
wait bool	Choices: no yes ←	Whether to wait for create or delete operation to complete.
wait_timeout	Default: 1200	Time, in seconds, to wait when wait=yes.
wait_until		The lifecycle state to wait for the resource to transition into when wait=yes. By default, when wait=yes, we wait for the resource to get into ACTIVE/ATTACHED/AVAILABLE/PROVISIONED/ RUNNING applicable lifecycle state during create operation & to get into DELETED/DETACHED/ TERMINATED lifecycle state during delete operation.
weight		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.

Notes ¶

Note

For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html

Examples ¶

# Note: These examples do not set authentication details.
# Create Load Balancer Backend
- name: Create Load Balancer Backend
  oci_load_balancer_backend:
    load_balancer_id: "ocid1.loadbalancer.oc1.iad.xxxxxEXAMPLExxxxx"
    backend_set_name: "backend1"
    ip_address: "10.50.121.69"
    port: 8080
    backup: False
    drain: False
    offline: False
    weight: 3
    state: 'present'
# Update a Backend server by enabling drain
- name: Drain a backend server by updating the Backend and setting the 'drain' option
  oci_load_balancer_backend:
    load_balancer_id: "ocid1.loadbalancer.oc1.iad.xxxxxEXAMPLExxxxx"
    backend_set_name: "backend1"
    ip_address: "10.50.121.69"
    port: 8080
    drain: True
    state: 'present'
# Update a Backend server to make it offline
- name: Make a backend server offline
  oci_load_balancer_backend:
    load_balancer_id: "ocid1.loadbalancer.oc1.iad.xxxxxEXAMPLExxxxx"
    backend_set_name: "backend1"
    ip_address: "10.50.121.69"
    port: 8080
    offline: True
    state: 'present'
# Update a Backend server to backup state
- name: Change a backend server state as backup
  oci_load_balancer_backend:
    load_balancer_id: "ocid1.loadbalancer.oc1.iad.xxxxxEXAMPLExxxxx"
    backend_set_name: "backend1"
    ip_address: "10.50.121.69"
    port: 8080
    backup: True
    state: 'present'
# Update Load Balancer Backend
- name: Update Load Balancer Backend
  oci_load_balancer_backend:
    load_balancer_id: "ocid1.loadbalancer.oc1.iad.xxxxxEXAMPLExxxxx"
    backend_set_name: "backend1"
    ip_address: "10.50.121.69"
    port: 8080
    backup: True
    state: 'present'
# Delete Load Balancer Backend
- name: Update Load Balancer Backend
  oci_load_balancer_backend:
    load_balancer_id: "ocid1.loadbalancer.oc1.iad.xxxxxEXAMPLExxxxx"
    backend_set_name: "backend1"
    ip_address: "10.50.121.69"
    port: 8080
    state: 'absent'

Return Values ¶

Common return values are documented here, the following are the fields unique to this module:

Key		Returned	Description
backend complex		success	Attributes of the created/updated Load Balancer Backend. For delete, deleted Load Balancer Backend description will be returned. Sample: {'drain': False, 'name': '10.159.34.21:8181', 'weight': 3, 'ip_address': '10.159.34.21', 'offline': False, 'backup': False, 'port': 8181}
	drain boolean	always	The drain state of the Load Balancer Backend
	name string	always	Name of the Load Balancer Backend Sample: 10.45.121.59:8080
	weight integer	always	The weight of the Load Balancer Backend Sample: 1
	backup boolean	always	The backup state of the Load Balancer Backend
	offline boolean	always	The offline state of the Load Balancer Backend
	ip_address string	always	Ip Address of the Load Balancer Backend Sample: 10.45.121.69
	port string	always	Port of the Load Balancer Backend Sample: 8080

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author ¶

Debayan Gupta(@debayan_gupta)

Hint

If you notice any issues in this documentation you can edit this document to improve it.