oracle / oracle.oci / 4.2.0 / module / oci_network_load_balancer_backend_set_health_facts Fetches details about a BackendSetHealth 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_health_facts (4.2.0) — module
Install with ansible-galaxy collection install oracle.oci:==4.2.0
collections: - name: oracle.oci version: 4.2.0
Fetches details about a BackendSetHealth resource in Oracle Cloud Infrastructure
Retrieves the health status for the specified backend set.
- name: Get a specific backend_set_health oci_network_load_balancer_backend_set_health_facts: # required network_load_balancer_id: "ocid1.networkloadbalancer.oc1..xxxxxxEXAMPLExxxxxx" backend_set_name: backend_set_name_example
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 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 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 backend_set_name: description: - The name of the backend set for which to retrieve the health status. - 'Example: `example_backend_set`' 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 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_health: contains: critical_state_backend_names: description: - A list of backend servers that are currently in the `CRITICAL` health state. The list identifies each backend server by IP address and port. - 'Example: `10.0.0.4:8080`' returned: on success sample: [] type: list status: description: - Overall health status of the backend set. - '* **OK:** All backend servers in the backend set return a status of `OK`.' - '* **WARNING:** Half or more of the backend servers in a backend set return a status of `OK` and at least one backend server returns a status of `WARNING`, `CRITICAL`, or `UNKNOWN`.' - '* **CRITICAL:** Fewer than half of the backend servers in a backend set return a status of `OK`.' - '* **UNKNOWN:** If no probes have yet been sent to the backends, or the system is unable to retrieve metrics from the backends.' returned: on success sample: OK type: str total_backend_count: description: - The total number of backend servers in this backend set. - 'Example: `7`' returned: on success sample: 56 type: int unknown_state_backend_names: description: - A list of backend servers that are currently in the `UNKNOWN` health state. The list identifies each backend server by IP address and port. - 'Example: `10.0.0.5:8080`' returned: on success sample: [] type: list warning_state_backend_names: description: - A list of backend servers that are currently in the `WARNING` health state. The list identifies each backend server by IP address or OCID and port. - 'Example: `10.0.0.3:8080` or `ocid1.privateip..oc1.<var>&lt;unique_ID&gt;</var>:8080`' returned: on success sample: [] type: list description: - BackendSetHealth resource returned: on success sample: critical_state_backend_names: [] status: OK total_backend_count: 56 unknown_state_backend_names: [] warning_state_backend_names: [] type: complex