oracle.oci.oci_loadbalancer_health_checker – Manage a HealthChecker resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 5.5.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_loadbalancer_health_checker.

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to update a HealthChecker resource in Oracle Cloud Infrastructure

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
  • security_token
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
string / required
The name of the backend set associated with the health check policy to be retrieved.
Example: `example_backend_set`
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.
interval_in_millis
integer / required
The interval between health checks, in milliseconds.
Example: `10000`
load_balancer_id
string / required
The OCID of the load balancer associated with the health check policy to be updated.

aliases: id
port
integer / required
The backend server port against which to run the health check.
Example: `8080`
protocol
string / required
The protocol the health check must use; either HTTP or TCP.
Example: `HTTP`
realm_specific_endpoint_template_enabled
boolean
    Choices:
  • no
  • yes
Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
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.
response_body_regex
string / required
A regular expression for parsing the response body from the backend server.
Example: `^((?!false).|\s)*$`
retries
integer / required
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.
Example: `3`
return_code
integer / required
The status code a healthy backend server should return.
Example: `200`
state
string
    Choices:
  • present ←
The state of the HealthChecker.
Use state=present to update an existing a HealthChecker.
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
timeout_in_millis
integer / 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.
Example: `3000`
url_path
string
The path against which to run the health check.
Example: `/healthcheck`
This parameter is updatable.
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: Update health_checker
  oci_loadbalancer_health_checker:
    # required
    protocol: protocol_example
    port: 56
    return_code: 56
    retries: 56
    timeout_in_millis: 56
    interval_in_millis: 56
    response_body_regex: response_body_regex_example
    load_balancer_id: "ocid1.loadbalancer.oc1..xxxxxxEXAMPLExxxxxx"
    backend_set_name: backend_set_name_example

    # optional
    url_path: url_path_example

Return Values

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

Key Returned Description
health_checker
complex
on success
Details of the HealthChecker resource acted upon by the current operation

Sample:
{'interval_in_millis': 56, 'port': 56, 'protocol': 'protocol_example', 'response_body_regex': 'response_body_regex_example', 'retries': 56, 'return_code': 56, 'timeout_in_millis': 56, 'url_path': 'url_path_example'}
 
interval_in_millis
integer
on success
The interval between health checks, in milliseconds. The default 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, the load balancer uses the port information from the `Backend` object.
Example: `8080`

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

Sample:
protocol_example
 
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
 
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. Defaults to 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, 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. Defaults to 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


Authors

  • Oracle (@oracle)