Try SpotterFetches details about one or multiple Backend resources 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 one or multiple Backend resources in Oracle Cloud Infrastructure
Lists the backend servers for a given network load balancer and backend set.
If I(backend_name) is specified, the details of a single Backend will be returned.
- name: Get a specific backend
oci_network_load_balancer_backend_facts:
# required
backend_name: backend_name_example
network_load_balancer_id: "ocid1.networkloadbalancer.oc1..xxxxxxEXAMPLExxxxxx"
backend_set_name: backend_set_name_example
- name: List backends
oci_network_load_balancer_backend_facts:
# required
network_load_balancer_id: "ocid1.networkloadbalancer.oc1..xxxxxxEXAMPLExxxxxx"
backend_set_name: backend_set_name_example
# 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
- 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
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
backend_name:
description:
- The name of the backend server to retrieve. If the backend was created with an explicitly
specified name, that name should be used here. If the backend was created without
explicitly specifying the name, but was created using ipAddress, this is specified
as <ipAddress>:<port>. If the backend was created without explicitly specifying
the name, but was created using targetId, this is specified as <targetId>:<port>.
- 'Example: `10.0.0.3:8080` or `ocid1.privateip..oc1.<var><unique_ID></var>:8080`'
- Required to get a specific backend.
type: str
backend_set_name:
description:
- The name of the backend set that includes the backend server.
- 'Example: `example_backend_set`'
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
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: true
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
backends:
contains:
ip_address:
description:
- 'The IP address of the backend server. Example: `10.0.0.3`'
returned: on success
sample: ip_address_example
type: str
is_backup:
description:
- Whether the network load balancer should treat this server as a backup unit.
If `true`, then the network load balancer forwards no ingress traffic to this
backend server unless all other backend servers not marked as "isBackup" fail
the health check policy.
- 'Example: `false`'
returned: on success
sample: true
type: bool
is_drain:
description:
- Whether the network load balancer should drain this server. Servers marked
"isDrain" receive no incoming traffic.
- 'Example: `false`'
returned: on success
sample: true
type: bool
is_offline:
description:
- Whether the network load balancer should treat this server as offline. Offline
servers receive no incoming traffic.
- 'Example: `false`'
returned: on success
sample: true
type: bool
name:
description:
- A read-only field showing the IP address/IP OCID and port that uniquely identify
this backend server in the backend set.
- 'Example: `10.0.0.3:8080`, or `ocid1.privateip..oc1.<var><unique_ID></var>:443`
or `10.0.0.3:0`'
returned: on success
sample: name_example
type: str
port:
description:
- The communication port for the backend server.
- 'Example: `8080`'
returned: on success
sample: 56
type: int
target_id:
description:
- 'The IP OCID/Instance OCID associated with the backend server. Example: `ocid1.privateip..oc1.<var><unique_ID></var>`'
returned: on success
sample: ocid1.target.oc1..xxxxxxEXAMPLExxxxxx
type: str
weight:
description:
- The network load balancing policy weight assigned to the server. Backend servers
with a higher weight receive a larger proportion of incoming traffic. For
example, a server weighted '3' receives three times the number of new connections
as a server weighted '1'. For more information about load balancing policies,
see L(How Network Load Balancing Policies Work,https://docs.cloud.oracle.com/Content/Balance/Reference/lbpolicies.htm).
- 'Example: `3`'
returned: on success
sample: 56
type: int
description:
- List of Backend resources
returned: on success
sample:
- ip_address: ip_address_example
is_backup: true
is_drain: true
is_offline: true
name: name_example
port: 56
target_id: ocid1.target.oc1..xxxxxxEXAMPLExxxxxx
weight: 56
type: complex