oci_load_balancer_health_checker - Update health checker details of a backend set in a load balancer in OCI Load Balancing Service

New in version 2.5.

Synopsis

  • Update health checker details of a backend set in a load balancer in OCI Load Balancing Service.

Requirements

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

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 containing health checker details.
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.
interval_in_millis
required
The interval between health checks, in milliseconds.
load_balancer_id
required
Identifier of the Load Balancer in which the backend set containing the health checker details belongs

aliases: id
port
required
The communication port for the backend server.
protocol
required
The protocol the health check must use, either HTTP or TCP.
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.
response_body_regex
required
regular expression for parsing the response body from the backend server.
retries
required
The number of retries to attempt before a backend server is considered unhealthy.
return_code
required
The status code a healthy backend server should return.
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
timeout_in_millis
required
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.
url_path
required
The path against which to run the health check..
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.

Examples

# Note: These examples do not set authentication details.
# Update Health Checker of a Backend Set
- name: Update Health Checker of a Backend Set
  oci_load_balancer_health_checker:
    load_balancer_id: 'ocid1.loadbalalncer.aaaa'
    backend_set_name: 'backend_set'
    interval_in_millis: 30000
    port: 8080
    protocol: "HTTP"
    response_body_regex: "^(500|40[1348])$"
    retries: 3
    timeout_in_millis: 6000
    return_code: 200
    url_path: "/healthcheckupdated"

Return Values

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

Key Returned Description
health_checker
complex
success
Attributes of the health checker

Sample:
{'retries': 3, 'protocol': 'HTTP', 'response_body_regex': '^(500|40[1348])$', 'return_code': 200, 'timeout_in_millis': 6000, 'interval_in_millis': 30000, 'url_path': '/healthcheck', 'port': 8080}
  retries
integer
always
The number of retries to attempt before a backend server is considered unhealthy

Sample:
3
  protocol
string
always
The protocol the health check must use

Sample:
HTTP
  response_body_regex
string
always
A regular expression for parsing the response body from the backend server.

Sample:
^(500|40[1348])$
  return_code
integer
always
The status code a healthy backend server should return

Sample:
200
  timeout_in_millis
integer
always
The maximum time, in milliseconds, to wait for a reply to a health check

Sample:
60000
  interval_in_millis
integer
always
The interval between health checks, in milliseconds.

Sample:
3000
  url_path
string
always
The path against which to run the health check.

Sample:
/healthcheck
  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.

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.