Try SpotterFetches details about a BackendHealth resource in Oracle Cloud Infrastructure
| "added in version" 2.9.0 of oracle.oci"
Authors: Oracle (@oracle)
preview | supported by community
Install with ansible-galaxy collection install oracle.oci:==5.0.0
collections:
- name: oracle.oci
version: 5.0.0Fetches details about a BackendHealth resource in Oracle Cloud Infrastructure
Gets the current health status of the specified backend server.
- name: Get a specific backend_health
oci_loadbalancer_backend_health_facts:
# required
load_balancer_id: "ocid1.loadbalancer.oc1..xxxxxxEXAMPLExxxxxx"
backend_set_name: backend_set_name_example
backend_name: backend_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
- 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
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_name:
description:
- The IP address and port of the backend server to retrieve the health status for.
- 'Example: `10.0.0.3:8080`'
required: true
type: str
backend_set_name:
description:
- The name of the backend set associated with the backend server to retrieve the health
status for.
- '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 backend server health status to be retrieved.
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
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
backend_health:
contains:
health_check_results:
contains:
health_check_status:
description:
- The result of the most recent health check.
returned: on success
sample: OK
type: str
source_ip_address:
description:
- The IP address of the health check status report provider. This identifier
helps you differentiate same-subnet load balancers that report health
check status.
- 'Example: `10.0.0.7`'
returned: on success
sample: source_ip_address_example
type: str
subnet_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the subnet hosting the load balancer that reported this health check
status.
returned: on success
sample: ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
type: str
timestamp:
description:
- The date and time the data was retrieved, in the format defined by RFC3339.
- 'Example: `2017-06-02T18:28:11+00:00`'
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
description:
- A list of the most recent health check results returned for the specified
backend server.
returned: on success
type: complex
status:
description:
- The general health status of the specified backend server as reported by the
primary and standby load balancers.
- '* **OK:** Both health checks returned `OK`.'
- '* **WARNING:** One health check returned `OK` and one did not.'
- '* **CRITICAL:** Neither health check returned `OK`.'
- '* **UNKNOWN:** One or both health checks returned `UNKNOWN`, or the system
was unable to retrieve metrics at this time.'
returned: on success
sample: OK
type: str
description:
- BackendHealth resource
returned: on success
sample:
health_check_results:
- health_check_status: OK
source_ip_address: source_ip_address_example
subnet_id: ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
timestamp: '2013-10-20T19:20:30+01:00'
status: OK
type: complex