oci_load_balancer_hostname - Create, update and delete a hostname resource in the specified load balancer.

New in version 2.5.

Synopsis

  • Create an OCI Load Balancer Hostname
  • Update OCI Load Balancers Hostname, if present.
  • Delete OCI Load Balancers Hostname, if present.

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.
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 Default:
DEFAULT
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.
hostname
A virtual hostname. Mandatory for create and update.
load_balancer_id
required
Identifier of the Load Balancer. Mandatory for create,delete and update.

aliases: id
name
required
A friendly name for the hostname resource. It must be unique and it cannot be changed. Avoid entering confidential information.Mandatory for create,update and delete.
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.
state
    Choices:
  • present ←
  • absent
Create,update or delete Load Balancer Hostname. For state=present, if it does not exists, it gets created. If exists, it gets updated.
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
wait
bool
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout Default:
1200
Time, in seconds, to wait when wait=yes.
wait_until
The lifecycle state to wait for the resource to transition into when wait=yes. By default, when wait=yes, we wait for the resource to get into ACTIVE/ATTACHED/AVAILABLE/PROVISIONED/ RUNNING applicable lifecycle state during create operation & to get into DELETED/DETACHED/ TERMINATED lifecycle state during delete operation.

Examples

# Note: These examples do not set authentication details.
# Create a hostname named "ansible_hostname" in a load balancer
- name: Create Load Balancer Hostname
  oci_load_balancer_hostname:
    name: "ansible_hostname"
    load_balancer_id: "ocid1.loadbalancer.xxxxxEXAMPLExxxxx"
    hostname: "app.example.com"
    state: 'present'

# Update Load Balancer Hostname
- name: Update Load Balancer Hostname
  oci_load_balancer_backend_set:
    load_balancer_id: "ocid1.loadbalancer.xxxxxEXAMPLExxxxx"
    name: "ansible_hostname"
    hostname: "app.production.com"

# Deleted Load Balancer Hostname
- name: Delete Load Balancer Hostname
  oci_load_balancer_hostname:
    load_balancer_id: "ocid1.loadbalancer.xxxxxEXAMPLExxxxx"
    name: "ansible_hostname"
    state: 'absent'

Return Values

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

Key Returned Description
hostname
complex
 success
Attributes of the created/updated Load Balancer Hostname. For delete, deleted Load Balancer Hostname description will be returned.

Sample:
[{'hostname': 'app.example.com', 'name': 'ansible_hostname'}, {'hostname': 'app.production.com', 'name': 'ansible_hostname_002'}]
  hostname
string
 always
A virtual hostname

Sample:
app.example.com
  name
string
 always
Name assigned to the Load Balancer Hostname during creation

Sample:
ansible_hostname


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.