oracle / oracle.oci / 5.0.0 / module / oci_loadbalancer_health_checker Manage a HealthChecker resource in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_loadbalancer_health_checker (5.0.0) — module
Install with ansible-galaxy collection install oracle.oci:==5.0.0
collections: - name: oracle.oci version: 5.0.0
This module allows the user to update a HealthChecker resource in Oracle Cloud Infrastructure
- 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
port: description: - The backend server port against which to run the health check. - 'Example: `8080`' required: true type: int wait: default: true description: Whether to wait for create or delete operation to complete. type: bool state: choices: - present default: present description: - The state of the HealthChecker. - Use I(state=present) to update an existing a HealthChecker. required: false 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 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. - 'Example: `3`' required: true type: int 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 protocol: description: - The protocol the health check must use; either HTTP or TCP. - 'Example: `HTTP`' required: true type: str url_path: description: - The path against which to run the health check. - 'Example: `/healthcheck`' - This parameter is updatable. type: str auth_type: choices: - api_key - instance_principal - instance_obo_user - resource_principal - security_token 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 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 return_code: description: - The status code a healthy backend server should return. - 'Example: `200`' required: true type: int 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 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 backend_set_name: description: - The name of the backend set associated with the health check policy to be retrieved. - 'Example: `example_backend_set`' required: true type: str load_balancer_id: aliases: - id description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the load balancer associated with the health check policy to be updated. required: true type: str 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 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. - 'Example: `3000`' required: true type: int interval_in_millis: description: - The interval between health checks, in milliseconds. - 'Example: `10000`' required: true type: int 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 response_body_regex: description: - A regular expression for parsing the response body from the backend server. - 'Example: `^((?!false).|\s)*$`' required: true 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 realm_specific_endpoint_template_enabled: description: - 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. type: bool
health_checker: contains: interval_in_millis: description: - The interval between health checks, in milliseconds. The default 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, the load balancer uses the port information from the `Backend` object. - 'Example: `8080`' returned: on success sample: 56 type: int protocol: description: - The protocol the health check must use; either HTTP or TCP. - 'Example: `HTTP`' returned: on success sample: protocol_example 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 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. Defaults to 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, 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. Defaults to 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: - Details of the HealthChecker resource acted upon by the current operation returned: on success 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 type: complex