oci_load_balancer_backend_facts - Fetch details of all Backends in a load balancer backend set of a load balancer

New in version 2.5.

Synopsis

  • Fetch details of all Backends in a load balancer backend set of a load balancer.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
api_user
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
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
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
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
    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
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
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.
ip_address
The IP address of the backend server.
load_balancer_id
required
Identifier of the Load Balancer to which the Backends belongs.

aliases: id
port
The communication port for the backend server.
region
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
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 all load balancer backends of a load balancer
- name: List all Load Balancer Backends
  oci_load_balancer_backend_facts:
      load_balancer_id: 'ocid1.loadbalancer.oc1.iad.xxxxxEXAMPLExxxxx'
      backend_set_name: 'backend1'

#Fetch details of a specific load balancer backend in a load balancer
- name: List a specific Load Balancer Backend
  oci_load_balancer_backend_facts:
      load_balancer_id: 'ocid1.loadbalancer.oc1.iad.xxxxxEXAMPLExxxxx'
      backend_set_name: 'backend1'
      ip_address: '10.159.121.55'
      port: '8181'

Return Values

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

Key Returned Description
backends
complex
success
Attributes of the Load Balancer Backend.

Sample:
[{'drain': False, 'name': '10.159.34.21:8181', 'weight': 3, 'ip_address': '10.159.34.21', 'offline': False, 'backup': False, 'port': 8181}, {'drain': False, 'name': '10.159.34.21:1234', 'weight': 1, 'ip_address': '10.159.34.55', 'offline': False, 'backup': False, 'port': 1234}]
  drain
boolean
always
The drain state of the Load Balancer Backend

  name
string
always
Name of the Load Balancer Backend

Sample:
10.45.121.59:8080
  weight
integer
always
The weight of the Load Balancer Backend

Sample:
1
  backup
boolean
always
The backup state of the Load Balancer Backend

  offline
boolean
always
The offline state of the Load Balancer Backend

  ip_address
string
always
Ip Address of the Load Balancer Backend

Sample:
10.45.121.69
  port
string
always
Port of the Load Balancer Backend

Sample:
8080


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • Debayan Gupta(@debayan_gupta)

Hint

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