oracle / oracle.oci / 4.2.0 / module / oci_network_load_balancer_backend_set Manage a BackendSet resource in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_network_load_balancer_backend_set (4.2.0) — module
Install with ansible-galaxy collection install oracle.oci:==4.2.0
collections: - name: oracle.oci version: 4.2.0
This module allows the user to create, update and delete a BackendSet resource in Oracle Cloud Infrastructure
For I(state=present), adds a backend set to a network load balancer.
- 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
name: description: - 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`' required: true type: str wait: default: true description: Whether to wait for create or delete operation to complete. type: bool state: choices: - present - absent default: present description: - The state of the BackendSet. - Use I(state=present) to create or update a BackendSet. - Use I(state=absent) to delete a BackendSet. required: false type: str key_by: description: 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. elements: str type: list policy: choices: - TWO_TUPLE - THREE_TUPLE - FIVE_TUPLE description: - The network load balancer policy for the backend set. - 'Example: `FIVE_TUPLE``' - Required for create using I(state=present). - This parameter is updatable. type: str region: description: - 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 C(config_file_location)). Please refer to U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm) for more information on OCI regions. type: str tenancy: description: - 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 C(config_file_location)). To get the tenancy OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm) type: str api_user: description: - 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 C(config_file_location)). To get the user's OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). type: str backends: description: - An array of backends to be associated with the backend set. - This parameter is updatable. elements: dict suboptions: ip_address: description: - The IP address of the backend server. - 'Example: `10.0.0.3`' type: str is_backup: description: - 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`' type: bool is_drain: description: - Whether the network load balancer should drain this server. Servers marked "isDrain" receive no incoming traffic. - 'Example: `false`' type: bool is_offline: description: - Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic. - 'Example: `false`' type: bool name: description: - 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`' type: str port: description: - The communication port for the backend server. - 'Example: `8080`' required: true type: int target_id: description: - 'The IP OCID/Instance OCID associated with the backend server. Example: `ocid1.privateip..oc1.<var>&lt;unique_ID&gt;</var>`' type: str weight: description: - 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 L(How Network Load Balancing Policies Work,https://docs.cloud.oracle.com/Content/Balance/Reference/lbpolicies.htm). - 'Example: `3`' type: int type: list auth_type: choices: - api_key - instance_principal - instance_obo_user - resource_principal default: api_key description: - The type of authentication to use for making API requests. By default C(auth_type="api_key") based authentication is performed and the API key (see I(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 C(auth_type="instance_principal") to use instance principal based authentication when running ansible playbooks within an OCI compute instance. type: str ip_version: choices: - IPV4 - IPV6 description: - IP version associated with the backend set. - This parameter is updatable. type: str cert_bundle: description: - 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. type: str auth_purpose: choices: - service_principal description: - The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None. type: str force_create: default: false description: 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 I(key_by). type: bool wait_timeout: description: Time, in seconds, to wait when I(wait=yes). Defaults to 1200 for most of the services but some services might have a longer wait timeout. type: int health_checker: description: - '' - Required for create using I(state=present). - This parameter is updatable. suboptions: interval_in_millis: description: - The interval between health checks, in milliseconds. The default value is 10000 (10 seconds). - 'Example: `10000`' type: int port: description: - 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`' type: int protocol: choices: - HTTP - HTTPS - TCP - UDP description: - The protocol the health check must use; either HTTP or HTTPS, or UDP or TCP. - 'Example: `HTTP`' required: true type: str request_data: description: - Base64 encoded pattern to be sent as UDP or TCP health check probe. type: str response_body_regex: description: - A regular expression for parsing the response body from the backend server. - 'Example: `^((?!false).|\s)*$`' type: str response_data: description: - Base64 encoded pattern to be validated as UDP or TCP health check probe response. type: str retries: description: - 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`' type: int return_code: description: - 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`' type: int timeout_in_millis: description: - 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`' type: int url_path: description: - The path against which to run the health check. - 'Example: `/healthcheck`' type: str type: dict api_user_key_file: description: - 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 C(config_file_location)). If the key is encrypted with a pass-phrase, the C(api_user_key_pass_phrase) option must also be provided. type: str is_preserve_source: description: - 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. type: bool config_profile_name: description: - The profile to load from the config file referenced by C(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 C(config_file_location). type: str api_user_fingerprint: description: - 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 C(config_file_location)). To get the key pair's fingerprint value please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). type: str config_file_location: description: - 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. type: str api_user_key_pass_phrase: description: - Passphrase used by the key referenced in C(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 C(config_file_location)). type: str network_load_balancer_id: aliases: - id description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the network load balancer to update. required: true type: str
backend_set: contains: backends: contains: ip_address: description: - 'The IP address of the backend server. Example: `10.0.0.3`' returned: on success sample: ip_address_example type: str is_backup: description: - 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`' returned: on success sample: true type: bool is_drain: description: - Whether the network load balancer should drain this server. Servers marked "isDrain" receive no incoming traffic. - 'Example: `false`' returned: on success sample: true type: bool is_offline: description: - Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic. - 'Example: `false`' returned: on success sample: true type: bool name: description: - 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`' returned: on success sample: name_example type: str port: description: - The communication port for the backend server. - 'Example: `8080`' returned: on success sample: 56 type: int target_id: description: - 'The IP OCID/Instance OCID associated with the backend server. Example: `ocid1.privateip..oc1.<var>&lt;unique_ID&gt;</var>`' returned: on success sample: ocid1.target.oc1..xxxxxxEXAMPLExxxxxx type: str weight: description: - 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 L(How Network Load Balancing Policies Work,https://docs.cloud.oracle.com/Content/Balance/Reference/lbpolicies.htm). - 'Example: `3`' returned: on success sample: 56 type: int description: - Array of backends. returned: on success type: complex health_checker: contains: interval_in_millis: description: - The interval between health checks, in milliseconds. The default value is 10000 (10 seconds). - 'Example: `10000`' returned: on success sample: 56 type: int port: description: - 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`' returned: on success sample: 56 type: int protocol: description: - The protocol the health check must use; either HTTP or HTTPS, or UDP or TCP. - 'Example: `HTTP`' returned: on success sample: HTTP type: str request_data: description: - Base64 encoded pattern to be sent as UDP or TCP health check probe. returned: on success sample: 'null' type: str response_body_regex: description: - A regular expression for parsing the response body from the backend server. - 'Example: `^((?!false).|\s)*$`' returned: on success sample: response_body_regex_example type: str response_data: description: - Base64 encoded pattern to be validated as UDP or TCP health check probe response. returned: on success sample: 'null' type: str retries: description: - 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`' returned: on success sample: 56 type: int return_code: description: - 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`' returned: on success sample: 56 type: int timeout_in_millis: description: - 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`' returned: on success sample: 56 type: int url_path: description: - The path against which to run the health check. - 'Example: `/healthcheck`' returned: on success sample: url_path_example type: str description: - '' returned: on success type: complex ip_version: description: - IP version associated with the backend set. returned: on success sample: IPV4 type: str is_preserve_source: description: - 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. returned: on success sample: true type: bool name: description: - 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`' returned: on success sample: name_example type: str policy: description: - The network load balancer policy for the backend set. - 'Example: `FIVE_TUPLE`' returned: on success sample: TWO_TUPLE type: str description: - Details of the BackendSet resource acted upon by the current operation returned: on success 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: null response_body_regex: response_body_regex_example response_data: null 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 type: complex