oracle.oci.oci_network_load_balancer_backend_set – Manage a BackendSet resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.11.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_network_load_balancer_backend_set.

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create, update and delete a BackendSet resource in Oracle Cloud Infrastructure

  • For state=present, adds a backend set to a network load balancer.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
api_user
string
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID 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
string
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
string
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
string
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_purpose
string
    Choices:
  • service_principal
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_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.
backends
list / elements=dictionary
An array of backends to be associated with the backend set.
This parameter is updatable.
ip_address
string
The IP address of the backend server.
Example: `10.0.0.3`
is_backup
boolean
    Choices:
  • no
  • yes
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`
is_drain
boolean
    Choices:
  • no
  • yes
Whether the network load balancer should drain this server. Servers marked "isDrain" receive no incoming traffic.
Example: `false`
is_offline
boolean
    Choices:
  • no
  • yes
Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic.
Example: `false`
name
string
A read-only field showing the IP address/OCID and port that uniquely identify this backend server in the backend set.
Example: `10.0.0.3:8080`, or `ocid1.privateip..oc1.<var>&lt;unique_ID&gt;</var>:443` or `10.0.0.3:0`
port
integer / required
The communication port for the backend server.
Example: `8080`
target_id
string
The IP OCID/Instance OCID associated with the backend server. Example: `ocid1.privateip..oc1.<var>&lt;unique_ID&gt;</var>`
weight
integer
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`
cert_bundle
string
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
config_file_location
string
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
string
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.
force_create
boolean
    Choices:
  • no ←
  • yes
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
health_checker
dictionary
Required for create using state=present.
This parameter is updatable.
interval_in_millis
integer
The interval between health checks, in milliseconds. The default value is 10000 (10 seconds).
Example: `10000`
port
integer
The backend server port against which to run the health check. If the port is not specified, then the network load balancer uses the port information from the `Backend` object. The port must be specified if the backend port is 0.
Example: `8080`
protocol
string / required
    Choices:
  • HTTP
  • HTTPS
  • TCP
  • UDP
The protocol the health check must use; either HTTP or HTTPS, or UDP or TCP.
Example: `HTTP`
request_data
string
Base64 encoded pattern to be sent as UDP or TCP health check probe.
response_body_regex
string
A regular expression for parsing the response body from the backend server.
Example: `^((?!false).|\s)*$`
response_data
string
Base64 encoded pattern to be validated as UDP or TCP health check probe response.
retries
integer
The number of retries to attempt before a backend server is considered "unhealthy". This number also applies when recovering a server to the "healthy" state. The default value is 3.
Example: `3`
return_code
integer
The status code a healthy backend server should return. If you configure the health check policy to use the HTTP protocol, then you can use common HTTP status codes such as "200".
Example: `200`
timeout_in_millis
integer
The maximum time, in milliseconds, to wait for a reply to a health check. A health check is successful only if a reply returns within this timeout period. The default value is 3000 (3 seconds).
Example: `3000`
url_path
string
The path against which to run the health check.
Example: `/healthcheck`
ip_version
string
    Choices:
  • IPV4
  • IPV6
IP version associated with the backend set.
This parameter is updatable.
is_preserve_source
boolean
    Choices:
  • no
  • yes
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.
This parameter is updatable.
key_by
list / elements=string
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
name
string / required
A user-friendly name for the backend set that must be unique and cannot be changed.
Valid backend set names include only alphanumeric characters, dashes, and underscores. Backend set names cannot contain spaces. Avoid entering confidential information.
Example: `example_backend_set`
network_load_balancer_id
string / required
The OCID of the network load balancer to update.

aliases: id
policy
string
    Choices:
  • TWO_TUPLE
  • THREE_TUPLE
  • FIVE_TUPLE
The network load balancer policy for the backend set.
Example: `FIVE_TUPLE``
Required for create using state=present.
This parameter is updatable.
region
string
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
string
    Choices:
  • present ←
  • absent
The state of the BackendSet.
Use state=present to create or update a BackendSet.
Use state=absent to delete a BackendSet.
tenancy
string
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
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Examples

- name: Create backend_set
  oci_network_load_balancer_backend_set:
    # required
    policy: TWO_TUPLE
    health_checker:
      # required
      protocol: HTTP

      # optional
      port: 56
      retries: 56
      timeout_in_millis: 56
      interval_in_millis: 56
      url_path: url_path_example
      response_body_regex: response_body_regex_example
      return_code: 56
      request_data: request_data_example
      response_data: response_data_example
    network_load_balancer_id: "ocid1.networkloadbalancer.oc1..xxxxxxEXAMPLExxxxxx"
    name: name_example

    # optional
    is_preserve_source: true
    ip_version: IPV4
    backends:
    - # required
      port: 56

      # optional
      name: name_example
      ip_address: ip_address_example
      target_id: "ocid1.target.oc1..xxxxxxEXAMPLExxxxxx"
      weight: 56
      is_backup: true
      is_drain: true
      is_offline: true

- name: Update backend_set
  oci_network_load_balancer_backend_set:
    # required
    network_load_balancer_id: "ocid1.networkloadbalancer.oc1..xxxxxxEXAMPLExxxxxx"
    name: name_example

    # optional
    policy: TWO_TUPLE
    is_preserve_source: true
    ip_version: IPV4
    backends:
    - # required
      port: 56

      # optional
      name: name_example
      ip_address: ip_address_example
      target_id: "ocid1.target.oc1..xxxxxxEXAMPLExxxxxx"
      weight: 56
      is_backup: true
      is_drain: true
      is_offline: true
    health_checker:
      # required
      protocol: HTTP

      # optional
      port: 56
      retries: 56
      timeout_in_millis: 56
      interval_in_millis: 56
      url_path: url_path_example
      response_body_regex: response_body_regex_example
      return_code: 56
      request_data: request_data_example
      response_data: response_data_example

- name: Delete backend_set
  oci_network_load_balancer_backend_set:
    # required
    network_load_balancer_id: "ocid1.networkloadbalancer.oc1..xxxxxxEXAMPLExxxxxx"
    name: name_example
    state: absent

Return Values

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

Key Returned Description
backend_set
complex
on success
Details of the BackendSet resource acted upon by the current operation

Sample:
{'backends': [{'ip_address': 'ip_address_example', 'is_backup': True, 'is_drain': True, 'is_offline': True, 'name': 'name_example', 'port': 56, 'target_id': 'ocid1.target.oc1..xxxxxxEXAMPLExxxxxx', 'weight': 56}], 'health_checker': {'interval_in_millis': 56, 'port': 56, 'protocol': 'HTTP', 'request_data': None, 'response_body_regex': 'response_body_regex_example', 'response_data': None, 'retries': 56, 'return_code': 56, 'timeout_in_millis': 56, 'url_path': 'url_path_example'}, 'ip_version': 'IPV4', 'is_preserve_source': True, 'name': 'name_example', 'policy': 'TWO_TUPLE'}
 
backends
complex
on success
Array of backends.

   
ip_address
string
on success
The IP address of the backend server. Example: `10.0.0.3`

Sample:
ip_address_example
   
is_backup
boolean
on success
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`

Sample:
True
   
is_drain
boolean
on success
Whether the network load balancer should drain this server. Servers marked "isDrain" receive no incoming traffic.
Example: `false`

Sample:
True
   
is_offline
boolean
on success
Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic.
Example: `false`

Sample:
True
   
name
string
on success
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>&lt;unique_ID&gt;</var>:443` or `10.0.0.3:0`

Sample:
name_example
   
port
integer
on success
The communication port for the backend server.
Example: `8080`

Sample:
56
   
target_id
string
on success
The IP OCID/Instance OCID associated with the backend server. Example: `ocid1.privateip..oc1.<var>&lt;unique_ID&gt;</var>`

Sample:
ocid1.target.oc1..xxxxxxEXAMPLExxxxxx
   
weight
integer
on success
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`

Sample:
56
 
health_checker
complex
on success

   
interval_in_millis
integer
on success
The interval between health checks, in milliseconds. The default value is 10000 (10 seconds).
Example: `10000`

Sample:
56
   
port
integer
on success
The backend server port against which to run the health check. If the port is not specified, then the network load balancer uses the port information from the `Backend` object. The port must be specified if the backend port is 0.
Example: `8080`

Sample:
56
   
protocol
string
on success
The protocol the health check must use; either HTTP or HTTPS, or UDP or TCP.
Example: `HTTP`

Sample:
HTTP
   
request_data
string
on success
Base64 encoded pattern to be sent as UDP or TCP health check probe.

Sample:
null
   
response_body_regex
string
on success
A regular expression for parsing the response body from the backend server.
Example: `^((?!false).|\s)*$`

Sample:
response_body_regex_example
   
response_data
string
on success
Base64 encoded pattern to be validated as UDP or TCP health check probe response.

Sample:
null
   
retries
integer
on success
The number of retries to attempt before a backend server is considered "unhealthy". This number also applies when recovering a server to the "healthy" state. The default value is 3.
Example: `3`

Sample:
56
   
return_code
integer
on success
The status code a healthy backend server should return. If you configure the health check policy to use the HTTP protocol, then you can use common HTTP status codes such as "200".
Example: `200`

Sample:
56
   
timeout_in_millis
integer
on success
The maximum time, in milliseconds, to wait for a reply to a health check. A health check is successful only if a reply returns within this timeout period. The default value is 3000 (3 seconds).
Example: `3000`

Sample:
56
   
url_path
string
on success
The path against which to run the health check.
Example: `/healthcheck`

Sample:
url_path_example
 
ip_version
string
on success
IP version associated with the backend set.

Sample:
IPV4
 
is_preserve_source
boolean
on success
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.

Sample:
True
 
name
string
on success
A user-friendly name for the backend set that must be unique and cannot be changed.
Valid backend set names include only alphanumeric characters, dashes, and underscores. Backend set names cannot contain spaces. Avoid entering confidential information.
Example: `example_backend_set`

Sample:
name_example
 
policy
string
on success
The network load balancer policy for the backend set.
Example: `FIVE_TUPLE`

Sample:
TWO_TUPLE


Authors

  • Oracle (@oracle)