oracle.oci.oci_loadbalancer_routing_policy – Manage a RoutingPolicy resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 5.3.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_loadbalancer_routing_policy.

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create, update and delete a RoutingPolicy resource in Oracle Cloud Infrastructure

  • For state=present, adds a routing policy to a load balancer. For more information, see Managing Request Routing.

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_ID 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_purpose
string
    Choices:
  • service_principal
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
  • security_token
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.
cert_bundle
string
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.
condition_language_version
string
    Choices:
  • V1
The version of the language in which `condition` of `rules` are composed.
Required for create using state=present.
This parameter is updatable.
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.
force_create
boolean
    Choices:
  • no ←
  • yes
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 key_by.
key_by
list / elements=string
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.
load_balancer_id
string / required
The OCID of the load balancer to add the routing policy rule list to.
name
string / required
The name for this list of routing rules. It must be unique and it cannot be changed. Avoid entering confidential information.
Example: `example_routing_rules`
realm_specific_endpoint_template_enabled
boolean
    Choices:
  • no
  • yes
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.
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.
rules
list / elements=dictionary
The list of routing rules.
Required for create using state=present, update using state=present with name present.
actions
list / elements=dictionary / required
A list of actions to be applied when conditions of the routing rule are met.
backend_set_name
string
Name of the backend set the listener will forward the traffic to.
Example: `backendSetForImages`
name
string / required
    Choices:
  • FORWARD_TO_BACKENDSET
condition
string / required
A routing rule to evaluate defined conditions against the incoming HTTP request and perform an action.
name
string / required
A unique name for the routing policy rule. Avoid entering confidential information.
state
string
    Choices:
  • present ←
  • absent
The state of the RoutingPolicy.
Use state=present to create or update a RoutingPolicy.
Use state=absent to delete a RoutingPolicy.
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
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Examples

- name: Create routing_policy
  oci_loadbalancer_routing_policy:
    # required
    condition_language_version: V1
    rules:
    - # required
      name: name_example
      condition: condition_example
      actions:
      - # required
        name: FORWARD_TO_BACKENDSET

        # optional
        backend_set_name: backend_set_name_example
    load_balancer_id: "ocid1.loadbalancer.oc1..xxxxxxEXAMPLExxxxxx"
    name: name_example

- name: Update routing_policy
  oci_loadbalancer_routing_policy:
    # required
    rules:
    - # required
      name: name_example
      condition: condition_example
      actions:
      - # required
        name: FORWARD_TO_BACKENDSET

        # optional
        backend_set_name: backend_set_name_example
    load_balancer_id: "ocid1.loadbalancer.oc1..xxxxxxEXAMPLExxxxxx"
    name: name_example

    # optional
    condition_language_version: V1

- name: Delete routing_policy
  oci_loadbalancer_routing_policy:
    # required
    load_balancer_id: "ocid1.loadbalancer.oc1..xxxxxxEXAMPLExxxxxx"
    name: name_example
    state: absent

Return Values

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

Key Returned Description
routing_policy
complex
on success
Details of the RoutingPolicy resource acted upon by the current operation

Sample:
{'condition_language_version': 'V1', 'name': 'name_example', 'rules': [{'actions': [{'backend_set_name': 'backend_set_name_example', 'name': 'FORWARD_TO_BACKENDSET'}], 'condition': 'condition_example', 'name': 'name_example'}]}
 
condition_language_version
string
on success
The version of the language in which `condition` of `rules` are composed.

Sample:
V1
 
name
string
on success
The unique name for this list of routing rules. Avoid entering confidential information.
Example: `example_routing_policy`

Sample:
name_example
 
rules
complex
on success
The ordered list of routing rules.
   
actions
complex
on success
A list of actions to be applied when conditions of the routing rule are met.
     
backend_set_name
string
on success
Name of the backend set the listener will forward the traffic to.
Example: `backendSetForImages`

Sample:
backend_set_name_example
     
name
string
on success

Sample:
FORWARD_TO_BACKENDSET
   
condition
string
on success
A routing rule to evaluate defined conditions against the incoming HTTP request and perform an action.

Sample:
condition_example
   
name
string
on success
A unique name for the routing policy rule. Avoid entering confidential information.

Sample:
name_example


Authors

  • Oracle (@oracle)