oci_load_balancer_backend_set_health_facts – Fetch details of a Backend Set’s health in a load balancer

New in version 2.5.

Synopsis

  • Fetch details of Backend Set’s health in a load balancer.

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_OCID 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_type
string
    Choices:
  • api_key ←
  • instance_principal
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
- / required
The name of the backend set under which the backend exists.
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
- / required
Identifier of the Load Balancer to which the Backends belongs.

aliases: id
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

Examples

#Fetch details of the backend set health of a load balancer
- name: List a specific Load Balancer Backend Set's Health
  oci_load_balancer_backend_set_health_facts:
      load_balancer_id: 'ocid1.loadbalancer.oc1.iad.xxxxxEXAMPLExxxxx'
      backend_set_name: 'ansible_backend_set'

Return Values

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

Key Returned Description
backend_health
complex
success
Attributes of the Backend Health

Sample:
{'status': 'CRITICAL', 'critical_state_backend_names': ['10.159.34.21:8080', '10.159.34.21:8181'], 'unknown_state_backend_names': [], 'total_backend_count': 2, 'warning_state_backend_names': []}
  critical_state_backend_names
list
always
A list of backend servers that are currently in the CRITICAL health state. The list identifies each backend server by IP address and port.

Sample:
10.1.2.3:80
  status
string
always
Overall health status of the backend set. Allowed values - - OK - WARNING - CRITICAL - UNKWON

Sample:
OK
  total_backend_count
integer
always
The total number of backend servers in this backend set.

Sample:
2
  unknown_state_backend_names
list
always
A list of backend servers that are currently in the UNKWON health state. The list identifies each backend server by IP address and port.

Sample:
10.1.2.4:80
  warning_state_backend_names
list
always
A list of backend servers that are currently in the WARNING health state. The list identifies each backend server by IP address and port.

Sample:
10.1.55.2:80


Status

  • This module is not guaranteed to have a backwards compatible interface. [preview]
  • This module is maintained by the Ansible Community. [community]

Authors

  • Debayan Gupta(@debayan_gupta)

Hint

If you notice any issues in this documentation you can edit this document to improve it.