oci_waas_recommendation_facts – Retrieve details about WAAS policy recommendations

New in version 2.5.

Synopsis

  • This module retrieves information of recommended Web Application Firewall protection rules for a WAAS policy.

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.
recommended_action
string
    Choices:
  • DETECT
  • BLOCK
A filter that matches recommended protection rules based on the selected action. If unspecified, rules with any action type are returned.
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.
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.

Examples

- name: Get the recommendations for a waas policy
  oci_waas_recommendation_facts:
    waas_policy_id: ocid1.waaspolicy.oc1..xxxxxEXAMPLExxxxx

- name: Get the recommendations of specific action for a waas policy
  oci_waas_recommendation_facts:
    waas_policy_id: ocid1.waaspolicy.oc1..xxxxxEXAMPLExxxxx
    recommended_action: DETECT

Return Values

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

Key Returned Description
waas_recommendations
complex
on success
List of recommended Web Application Firewall protection rules for a WAAS policy.

Sample:
[{'mod_security_rule_ids': ['941340'], 'description': 'Cross-Site Scripting (XSS) Attempt: XSS Filters from IE', 'key': '941340', 'recommended_action': 'BLOCK', 'labels': ['OWASP', 'OWASP-2017', 'CRS3', 'WASCTC', 'PCI', 'HTTP', 'A2', 'A2-2017', 'XSS', 'Cross-Site Scripting'], 'name': 'Cross-Site Scripting (XSS) Attempt: XSS Filters from Internet Explorer'}]
  description
string
success
The description of the recommended protection rule.

Sample:
Cross-Site Scripting (XSS) Attempt: XSS Filters from IE
  key
string
success
The unique key for the recommended protection rule.

Sample:
941340
  labels
list
success
The list of labels for the recommended protection rule.

Sample:
['OWASP', 'OWASP-2017', 'CRS3', 'WASCTC', 'PCI', 'HTTP', 'A2', 'A2-2017', 'XSS', 'Cross-Site Scripting']
  mod_security_rule_ids
list
success
The list of the ModSecurity rule IDs associated with the protection rule.

Sample:
['941340']
  name
string
success
The name of the recommended protection rule.

Sample:
Cross-Site Scripting (XSS) Attempt: XSS Filters from Internet Explorer
  recommended_action
string
success
The recommended action to apply to the protection rule.

Sample:
BLOCK


Status

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

Authors

  • Manoj Meda (@manojmeda)

Hint

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