oracle.oci.oci_loadbalancer_backend_health_facts – Fetches details about a BackendHealth resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.2.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_backend_health_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about a BackendHealth resource in Oracle Cloud Infrastructure
Gets the current health status of the specified backend server.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
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
|
|
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
|
|
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_name
string
/ required
|
The IP address and port of the backend server to retrieve the health status for.
Example: `10.0.0.3:8080`
|
|
backend_set_name
string
/ required
|
The name of the backend set associated with the backend server to retrieve the health status for.
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 . |
|
load_balancer_id
string
/ required
|
The OCID of the load balancer associated with the backend server health status to be retrieved.
aliases: id |
|
realm_specific_endpoint_template_enabled
boolean
|
|
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. |
|
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 |
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- 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
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | ||
---|---|---|---|---|
backend_health
complex
|
on success |
BackendHealth resource
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'}
|
||
health_check_results
complex
|
on success |
A list of the most recent health check results returned for the specified backend server.
|
||
health_check_status
string
|
on success |
The result of the most recent health check.
Sample:
OK
|
||
source_ip_address
string
|
on success |
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`
Sample:
source_ip_address_example
|
||
subnet_id
string
|
on success |
The OCID of the subnet hosting the load balancer that reported this health check status.
Sample:
ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
|
||
timestamp
string
|
on success |
The date and time the data was retrieved, in the format defined by RFC3339.
Example: `2017-06-02T18:28:11+00:00`
Sample:
2013-10-20T19:20:30+01:00
|
||
status
string
|
on success |
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.
Sample:
OK
|
Authors¶
Oracle (@oracle)