Try SpotterManage a Backend resource 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.0This module allows the user to create, update and delete a Backend resource in Oracle Cloud Infrastructure
For I(state=present), adds a backend server to a backend set.
- name: Create backend
oci_loadbalancer_backend:
# required
port: 56
ip_address: ip_address_example
load_balancer_id: "ocid1.loadbalancer.oc1..xxxxxxEXAMPLExxxxxx"
backend_set_name: backend_set_name_example
# optional
weight: 56
backup: true
drain: true
offline: true
- name: Update backend
oci_loadbalancer_backend:
# required
weight: 56
backup: true
drain: true
offline: true
port: 56
ip_address: ip_address_example
load_balancer_id: "ocid1.loadbalancer.oc1..xxxxxxEXAMPLExxxxxx"
backend_set_name: backend_set_name_example
- name: Delete backend
oci_loadbalancer_backend:
# required
port: 56
ip_address: ip_address_example
load_balancer_id: "ocid1.loadbalancer.oc1..xxxxxxEXAMPLExxxxxx"
backend_set_name: backend_set_name_example
state: absent
port:
description:
- The communication port for the backend server.
- 'Example: `8080`'
required: true
type: int
wait:
default: true
description: Whether to wait for create or delete operation to complete.
type: bool
drain:
description:
- Whether the load balancer should drain this server. Servers marked "drain" receive
no new incoming traffic.
- 'Example: `false`'
- Required for update using I(state=present) with present.
type: bool
state:
choices:
- present
- absent
default: present
description:
- The state of the Backend.
- Use I(state=present) to create or update a Backend.
- Use I(state=absent) to delete a Backend.
required: false
type: str
backup:
description:
- Whether the load balancer should treat this server as a backup unit. If `true`,
the load balancer forwards no ingress traffic to this backend server unless all
other backend servers not marked as "backup" fail the health check policy.
- '**Note:** You cannot add a backend server marked as `backup` to a backend set that
uses the IP Hash policy.'
- 'Example: `false`'
- Required for update using I(state=present) with present.
type: bool
key_by:
description: The list of attributes of this resource which should be used to uniquely
identify an instance of the resource. By default, all the attributes of a resource
are used to uniquely identify a resource.
elements: str
type: list
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
weight:
description:
- The 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 3 times the number of new connections as a server weighted
'1'. For more information on load balancing policies, see L(How Load Balancing Policies
Work,https://docs.cloud.oracle.com/Content/Balance/Reference/lbpolicies.htm).
- 'Example: `3`'
- Required for update using I(state=present) with present.
type: int
offline:
description:
- Whether the load balancer should treat this server as offline. Offline servers receive
no incoming traffic.
- 'Example: `false`'
- Required for update using I(state=present) with present.
type: bool
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
ip_address:
description:
- The IP address of the backend server.
- 'Example: `10.0.0.3`'
required: true
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
force_create:
default: false
description: Whether to attempt non-idempotent creation of a resource. By default,
create resource is an idempotent operation, and doesn't create the resource if it
already exists. Setting this option to true, forcefully creates a copy of the resource,
even if it already exists.This option is mutually exclusive with I(key_by).
type: bool
wait_timeout:
description: Time, in seconds, to wait when I(wait=yes). Defaults to 1200 for most
of the services but some services might have a longer wait timeout.
type: int
backend_set_name:
description:
- The name of the backend set to add the backend server to.
- 'Example: `example_backend_set`'
required: true
type: str
load_balancer_id:
aliases:
- id
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the load balancer associated with the backend set and servers.
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
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
backend:
contains:
backup:
description:
- Whether the load balancer should treat this server as a backup unit. If `true`,
the load balancer forwards no ingress traffic to this backend server unless
all other backend servers not marked as "backup" fail the health check policy.
- '**Note:** You cannot add a backend server marked as `backup` to a backend
set that uses the IP Hash policy.'
- 'Example: `false`'
returned: on success
sample: true
type: bool
drain:
description:
- Whether the load balancer should drain this server. Servers marked "drain"
receive no new incoming traffic.
- 'Example: `false`'
returned: on success
sample: true
type: bool
ip_address:
description:
- The IP address of the backend server.
- 'Example: `10.0.0.3`'
returned: on success
sample: ip_address_example
type: str
name:
description:
- A read-only field showing the IP address and port that uniquely identify this
backend server in the backend set.
- 'Example: `10.0.0.3:8080`'
returned: on success
sample: name_example
type: str
offline:
description:
- Whether the load balancer should treat this server as offline. Offline servers
receive no incoming traffic.
- 'Example: `false`'
returned: on success
sample: true
type: bool
port:
description:
- The communication port for the backend server.
- 'Example: `8080`'
returned: on success
sample: 56
type: int
weight:
description:
- The 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 3 times the number of new connections as a
server weighted '1'. For more information on load balancing policies, see
L(How Load Balancing Policies Work,https://docs.cloud.oracle.com/Content/Balance/Reference/lbpolicies.htm).
- 'Example: `3`'
returned: on success
sample: 56
type: int
description:
- Details of the Backend resource acted upon by the current operation
returned: on success
sample:
backup: true
drain: true
ip_address: ip_address_example
name: name_example
offline: true
port: 56
weight: 56
type: complex