oracle.oci.oci_waas_caching_rules – Manage a CachingRules resource in Oracle Cloud Infrastructure¶

Note

This plugin is part of the oracle.oci collection (version 5.5.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_waas_caching_rules.

New in version 2.9.0: of oracle.oci

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis ¶

This module allows the user to update a CachingRules resource in Oracle Cloud Infrastructure

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			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.
caching_rules_details list / elements=dictionary / required
	action string / required		Choices: CACHE BYPASS_CACHE	The action to take when the criteria of a caching rule are met. - CACHE: Caches requested content when the criteria of the rule are met. - BYPASS_CACHE: Allows requests to bypass the cache and be directed to the origin when the criteria of the rule is met. This parameter is updatable.
	caching_duration string			The duration to cache content for the caching rule, specified in ISO 8601 extended format. Supported units: seconds, minutes, hours, days, weeks, months. The maximum value that can be set for any unit is `99`. Mixing of multiple units is not supported. Only applies when the `action` is set to `CACHE`. Example: `PT1H` This parameter is updatable.
	client_caching_duration string			The duration to cache content in the user's browser, specified in ISO 8601 extended format. Supported units: seconds, minutes, hours, days, weeks, months. The maximum value that can be set for any unit is `99`. Mixing of multiple units is not supported. Only applies when the `action` is set to `CACHE`. Example: `PT1H` This parameter is updatable.
	criteria list / elements=dictionary / required			The array of the rule criteria with condition and value. The caching rule would be applied for the requests that matched any of the listed conditions.
		condition string / required	Choices: URL_IS URL_STARTS_WITH URL_PART_ENDS_WITH URL_PART_CONTAINS	The condition of the caching rule criteria. - URL_IS: Matches if the concatenation of request URL path and query is identical to the contents of the `value` field. - URL_STARTS_WITH: Matches if the concatenation of request URL path and query starts with the contents of the `value` field. - URL_PART_ENDS_WITH: Matches if the concatenation of request URL path and query ends with the contents of the `value` field. - URL_PART_CONTAINS: Matches if the concatenation of request URL path and query contains the contents of the `value` field. URLs must start with a `/`. URLs can't contain restricted double slashes `//`. URLs can't contain the restricted `'` `&` `?` symbols. Resources to cache can only be specified by a URL, any query parameters are ignored. This parameter is updatable.
		value string / required		The value of the caching rule criteria. This parameter is updatable.
	is_client_caching_enabled boolean		Choices: no yes	Enables or disables client caching. Browsers use the `Cache-Control` header value for caching content locally in the browser. This setting overrides the addition of a `Cache- Control` header in responses. This parameter is updatable.
	key string			The unique key for the caching rule. This parameter is updatable.
	name string / required			The name of the caching rule. This parameter is updatable.
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`.
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.
state string			Choices: present ←	The state of the CachingRules. Use state=present to update an existing a CachingRules.
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
waas_policy_id string / required				The OCID of the WAAS policy. aliases: id
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.

Notes ¶

Note

For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html

Examples ¶

- name: Update caching_rules
  oci_waas_caching_rules:
    # required
    waas_policy_id: "ocid1.waaspolicy.oc1..xxxxxxEXAMPLExxxxxx"
    caching_rules_details:
    - # required
      name: name_example
      action: CACHE
      criteria:
      - # required
        condition: URL_IS
        value: value_example

      # optional
      key: key_example
      caching_duration: caching_duration_example
      is_client_caching_enabled: true
      client_caching_duration: client_caching_duration_example

Return Values ¶

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

Key			Returned	Description
caching_rules complex			on success	Details of the CachingRules resource acted upon by the current operation Sample: {'action': 'CACHE', 'caching_duration': 'caching_duration_example', 'client_caching_duration': 'client_caching_duration_example', 'criteria': [{'condition': 'URL_IS', 'value': 'value_example'}], 'is_client_caching_enabled': True, 'key': 'key_example', 'name': 'name_example'}
	action string		on success	The action to take when the criteria of a caching rule are met. - CACHE: Caches requested content when the criteria of the rule are met. - BYPASS_CACHE: Allows requests to bypass the cache and be directed to the origin when the criteria of the rule is met. Sample: CACHE
	caching_duration string		on success	The duration to cache content for the caching rule, specified in ISO 8601 extended format. Supported units: seconds, minutes, hours, days, weeks, months. The maximum value that can be set for any unit is `99`. Mixing of multiple units is not supported. Only applies when the `action` is set to `CACHE`. Example: `PT1H` Sample: caching_duration_example
	client_caching_duration string		on success	The duration to cache content in the user's browser, specified in ISO 8601 extended format. Supported units: seconds, minutes, hours, days, weeks, months. The maximum value that can be set for any unit is `99`. Mixing of multiple units is not supported. Only applies when the `action` is set to `CACHE`. Example: `PT1H` Sample: client_caching_duration_example
	criteria complex		on success	The array of the rule criteria with condition and value. The caching rule would be applied for the requests that matched any of the listed conditions.
		condition string	on success	The condition of the caching rule criteria. - URL_IS: Matches if the concatenation of request URL path and query is identical to the contents of the `value` field. - URL_STARTS_WITH: Matches if the concatenation of request URL path and query starts with the contents of the `value` field. - URL_PART_ENDS_WITH: Matches if the concatenation of request URL path and query ends with the contents of the `value` field. - URL_PART_CONTAINS: Matches if the concatenation of request URL path and query contains the contents of the `value` field. URLs must start with a `/`. URLs can't contain restricted double slashes `//`. URLs can't contain the restricted `'` `&` `?` symbols. Resources to cache can only be specified by a URL, any query parameters are ignored. Sample: URL_IS
		value string	on success	The value of the caching rule criteria. Sample: value_example
	is_client_caching_enabled boolean		on success	Enables or disables client caching. Browsers use the `Cache-Control` header value for caching content locally in the browser. This setting overrides the addition of a `Cache- Control` header in responses. Sample: True
	key string		on success	The unique key for the caching rule. Sample: key_example
	name string		on success	The name of the caching rule. Sample: name_example

Authors¶

Oracle (@oracle)

oracle.oci.oci_waas_caching_rules – Manage a CachingRules resource in Oracle Cloud Infrastructure¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶