oci_load_balancer_path_route_set – Create, update and delete a path route set of a load balancer

New in version 2.5.

Synopsis

  • Create an OCI Load Balancer Path Route Set
  • Update OCI Load Balancers Path Route Set, if present.
  • Delete OCI Load Balancers Path Route Set, if present.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
api_user
string
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
string
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
string
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
string
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
string
    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
string
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
string
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.
delete_path_routes
boolean
    Choices:
  • no ←
  • yes
Delete any Path Route in the Path Route Set named name that is specified in path_routes. This is only applicable in case of updating path route set.If delete_path_routes=yes, path routes provided by path_routes would be deleted from existing path routes, if they are part of existing path route. If they are not part of existing path routes, they will be ignored. delete_path_routes and purge_path_routes are mutually exclusive.
load_balancer_id
- / required
Identifier of the Load Balancer. Mandatory for create,delete and update.

aliases: id
name
-
The name for this set of path route rules. It must be unique and it can not be changed.
path_routes
-
The set of path route rules. Mandatory for create and update.
backend_set_name
- / required
The name of the target backend set for requests where the incoming URI matches the specified path.
path
- / required
The path string to match against the incoming URI path. - Path strings are case-insensitive. - Asterisk (*) wildcards are not supported. - Regular expressions are not supported.
path_match_type
- / required
The type of matching to apply to incoming URIs. This should be a dict/hash that consists of the key [match_type describes how the load balancing service compares a PathRoute object's path string against the incoming URI. The choices for the value are EXACT_MATCH, FORCE_LONGEST_PREFIX_MATCH, PREFIX_MATCH, SUFFIX_MATCH. required - true]
purge_path_routes
boolean
    Choices:
  • no
  • yes ←
Purge any Path Route in the Path Route Set named name that is not specified in path_routes. This is only applicable in case of updating path route set.If purge_path_routes=no, provided path_routes would be appended to existing path_routes. purge_path_routes and delete_path_routes are mutually exclusive.
region
string
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 Path Route Set. For state=present, if it does not exists, it gets created. If exists, it gets updated.
tenancy
string
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
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Default:
1200
Time, in seconds, to wait when wait=yes.
wait_until
string
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 backend set named "ansible_path_route_set" in a load balancer
- name: Create Load Balancer Path Route Set
  oci_load_balancer_path_route_set:
    name: "ansible_path_route_set"
    load_balancer_id: "ocid1.loadbalancer.oc1.iad.xxxxxEXAMPLExxxxx"
    path_routes:
          - backend_set_name: "ansible_backend_set"
            path: "/admin"
            path_match_type:
                 match_type: 'EXACT_MATCH'
    state: 'present'

# Update Load Balancer Path Route Set
- name: Update Load Balancer Path Route Set
  oci_load_balancer_path_route_set:
    load_balancer_id: "ocid1.loadbalancer.oc1.iad.xxxxxEXAMPLExxxxx"
    name: "ansible_backend_set"
    path_routes:
          - backend_set_name: "ansible_backend_set"
            path: "/admin"
            path_match_type:
                 match_type: 'FORCE_LONGEST_PREFIX_MATCH'
    state: 'present'

# Update Load Balancer Path Route Set by appending a new path route
- name: Update Load Balancer Path Route Set by appending a new path route
  oci_load_balancer_path_route_set:
    load_balancer_id: "ocid1.loadbalancer.oc1.iad.xxxxxEXAMPLExxxxx"
    name: "ansible_backend_set"
    path_routes:
          - backend_set_name: "ansible_backend_set"
            path: "/admin"
            path_match_type:
                 match_type: 'FORCE_LONGEST_PREFIX_MATCH'
    purge_path_routes: False
    state: 'present'

# Update Load Balancer Path Route Set by deleting a path route
- name: Update Load Balancer Path Route Set by deleting a path route
  oci_load_balancer_path_route_set:
    load_balancer_id: "ocid1.loadbalancer.oc1.iad.xxxxxEXAMPLExxxxx"
    name: "ansible_backend_set"
    path_routes:
          - backend_set_name: "ansible_backend_set"
            path: "/admin"
            path_match_type:
                 match_type: 'FORCE_LONGEST_PREFIX_MATCH'
    delete_path_routes: True
    state: 'present'

# Delete Load Balancer Path Route Set
- name: Delete Load Balancer Path Route Set
  oci_load_balancer_path_route_set:
    load_balancer_id: "ocid1.loadbalancer.oc1.iad.xxxxxEXAMPLExxxxx"
    name: "ansible_path_route_set"
    state: 'absent'

Return Values

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

Key Returned Description
path_route_set
complex
success
Attributes of the created/updated Load Balancer Path Route Set. For delete, deleted Load Balancer Path Route Set description will be returned.

Sample:
{'name': 'ansible_path_route_set', 'path_routes': [{'path': '/admin', 'backend_set_name': 'ansible_backend_set', 'path_match_type': {'match_type': 'EXACT_MATCH'}}]}
  name
string
always
Name assigned to the Load Balancer Path Route Set during creation

Sample:
ansible_path_route_set
  path_routes
list
always
The set of path route rules.

Sample:
[{'path': '/admin', 'backend_set_name': 'ansible_backend_set', 'path_match_type': {'match_type': 'EXACT_MATCH'}}]


Status

  • This module is not guaranteed to have a backwards compatible interface. [preview]
  • This module is maintained by the Ansible Community. [community]

Authors

  • Debayan Gupta(@debayan_gupta)

Hint

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