oracle.oci.oci_loadbalancer_path_route_set – Manage a PathRouteSet resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.0.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_path_route_set
.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to create, update and delete a PathRouteSet resource in Oracle Cloud Infrastructure
For state=present, adds a path route set to a load balancer. For more information, see Managing Request Routing.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
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
|
|
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
|
|
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.
|
|||
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
|
|
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 path route set to.
aliases: id |
|||
name
string
/ required
|
The name for this set of path route rules. It must be unique and it cannot be changed. Avoid entering confidential information.
Example: `example_path_route_set`
|
|||
path_routes
list
/ elements=dictionary
|
The set of path route rules.
Required for create using state=present, update using state=present with name present.
|
|||
backend_set_name
string
/ required
|
The name of the target backend set for requests where the incoming URI matches the specified path.
Example: `example_backend_set`
|
|||
path
string
/ 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.
Example: `/example/video/123`
|
|||
path_match_type
dictionary
/ required
|
The type of matching to apply to incoming URIs.
|
|||
match_type
string
/ required
|
|
Specifies how the load balancing service compares a PathRoute object's `path` string against the incoming URI.
* **EXACT_MATCH** - Looks for a `path` string that exactly matches the incoming URI path.
* **FORCE_LONGEST_PREFIX_MATCH** - Looks for the `path` string with the best, longest match of the beginning portion of the incoming URI path.
* **PREFIX_MATCH** - Looks for a `path` string that matches the beginning portion of the incoming URI path.
* **SUFFIX_MATCH** - Looks for a `path` string that matches the ending portion of the incoming URI path.
For a full description of how the system handles `matchType` in a path route set containing multiple rules, see Managing Request Routing.
|
||
realm_specific_endpoint_template_enabled
boolean
|
|
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. |
|||
state
string
|
|
The state of the PathRouteSet.
Use state=present to create or update a PathRouteSet.
Use state=absent to delete a PathRouteSet.
|
||
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
|
|
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.
|
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Create path_route_set
oci_loadbalancer_path_route_set:
# required
path_routes:
- # required
path: path_example
path_match_type:
# required
match_type: EXACT_MATCH
backend_set_name: backend_set_name_example
load_balancer_id: "ocid1.loadbalancer.oc1..xxxxxxEXAMPLExxxxxx"
name: name_example
- name: Update path_route_set
oci_loadbalancer_path_route_set:
# required
path_routes:
- # required
path: path_example
path_match_type:
# required
match_type: EXACT_MATCH
backend_set_name: backend_set_name_example
load_balancer_id: "ocid1.loadbalancer.oc1..xxxxxxEXAMPLExxxxxx"
name: name_example
- name: Delete path_route_set
oci_loadbalancer_path_route_set:
# 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 | |||
---|---|---|---|---|---|
path_route_set
complex
|
on success |
Details of the PathRouteSet resource acted upon by the current operation
Sample:
{'name': 'name_example', 'path_routes': [{'backend_set_name': 'backend_set_name_example', 'path': 'path_example', 'path_match_type': {'match_type': 'EXACT_MATCH'}}]}
|
|||
name
string
|
on success |
The unique name for this set of path route rules. Avoid entering confidential information.
Example: `example_path_route_set`
Sample:
name_example
|
|||
path_routes
complex
|
on success |
The set of path route rules.
|
|||
backend_set_name
string
|
on success |
The name of the target backend set for requests where the incoming URI matches the specified path.
Example: `example_backend_set`
Sample:
backend_set_name_example
|
|||
path
string
|
on success |
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.
Example: `/example/video/123`
Sample:
path_example
|
|||
path_match_type
complex
|
on success |
The type of matching to apply to incoming URIs.
|
|||
match_type
string
|
on success |
Specifies how the load balancing service compares a PathRoute object's `path` string against the incoming URI.
* **EXACT_MATCH** - Looks for a `path` string that exactly matches the incoming URI path.
* **FORCE_LONGEST_PREFIX_MATCH** - Looks for the `path` string with the best, longest match of the beginning portion of the incoming URI path.
* **PREFIX_MATCH** - Looks for a `path` string that matches the beginning portion of the incoming URI path.
* **SUFFIX_MATCH** - Looks for a `path` string that matches the ending portion of the incoming URI path.
For a full description of how the system handles `matchType` in a path route set containing multiple rules, see Managing Request Routing.
Sample:
EXACT_MATCH
|
Authors¶
Oracle (@oracle)