oracle / oracle.oci / 3.5.0 / module / oci_network_load_balancer_health_facts Fetches details about one or multiple NetworkLoadBalancerHealth resources 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_health_facts (3.5.0) — module
Install with ansible-galaxy collection install oracle.oci:==3.5.0
collections: - name: oracle.oci version: 3.5.0
Fetches details about one or multiple NetworkLoadBalancerHealth resources in Oracle Cloud Infrastructure
Lists the summary health statuses for all network load balancers in the specified compartment.
If I(network_load_balancer_id) is specified, the details of a single NetworkLoadBalancerHealth will be returned.
- name: Get a specific network_load_balancer_health oci_network_load_balancer_health_facts: # required network_load_balancer_id: "ocid1.networkloadbalancer.oc1..xxxxxxEXAMPLExxxxxx"
- name: List network_load_balancer_healths oci_network_load_balancer_health_facts: # required compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx" # optional sort_order: ASC sort_by: timeCreated
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 sort_by: choices: - timeCreated - displayName description: - The field to sort by. Only one sort order can be provided. The default order for timeCreated is descending. The default order for displayName is ascending. If no value is specified, then timeCreated is the default. 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 sort_order: choices: - ASC - DESC description: - The sort order to use, either 'asc' (ascending) or 'desc' (descending). 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 compartment_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment containing the network load balancers to list. - Required to list multiple network_load_balancer_healths. 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 to get a specific network_load_balancer_health. type: str
network_load_balancer_healths: contains: critical_state_backend_set_names: description: - A list of backend sets that are currently in the `CRITICAL` health state. The list identifies each backend set by the user-friendly name you assigned when you created the backend set. - 'Example: `example_backend_set`' - Returned for get operation returned: on success sample: [] type: list network_load_balancer_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the network load balancer with which the health status is associated. - Returned for list operation returned: on success sample: ocid1.networkloadbalancer.oc1..xxxxxxEXAMPLExxxxxx type: str status: description: - The overall health status of the network load balancer. - '* **OK:** All backend sets associated with the network load balancer return a status of `OK`.' - '* **WARNING:** At least one of the backend sets associated with the network load balancer returns a status of `WARNING`, no backend sets return a status of `CRITICAL`, and the network load balancer life cycle state is `ACTIVE`.' - '* **CRITICAL:** One or more of the backend sets associated with the network load balancer return a status of `CRITICAL`.' - '* **UNKNOWN:** If any one of the following conditions is true:' - ' * The network load balancer life cycle state is not `ACTIVE`.' - ' * No backend sets are defined for the network load balancer.' - ' * More than half of the backend sets associated with the network load balancer return a status of `UNKNOWN`, none of the backend sets return a status of `WARNING` or `CRITICAL`, and the network load balancer life cycle state is `ACTIVE`.' - ' * The system could not retrieve metrics for any reason.' returned: on success sample: OK type: str total_backend_set_count: description: - The total number of backend sets associated with this network load balancer. - 'Example: `4`' - Returned for get operation returned: on success sample: 56 type: int unknown_state_backend_set_names: description: - A list of backend sets that are currently in the `UNKNOWN` health state. The list identifies each backend set by the user-friendly name you assigned when you created the backend set. - 'Example: `example_backend_set2`' - Returned for get operation returned: on success sample: [] type: list warning_state_backend_set_names: description: - A list of backend sets that are currently in the `WARNING` health state. The list identifies each backend set by the user-friendly name you assigned when you created the backend set. - 'Example: `example_backend_set3`' - Returned for get operation returned: on success sample: [] type: list description: - List of NetworkLoadBalancerHealth resources returned: on success sample: - critical_state_backend_set_names: [] network_load_balancer_id: ocid1.networkloadbalancer.oc1..xxxxxxEXAMPLExxxxxx status: OK total_backend_set_count: 56 unknown_state_backend_set_names: [] warning_state_backend_set_names: [] type: complex