oracle.oci.oci_waf_protection_capability_facts – Fetches details about one or multiple ProtectionCapability resources in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about one or multiple ProtectionCapability resources in Oracle Cloud Infrastructure

  • Lists of protection capabilities filtered by query parameters.

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
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.
compartment_id
string / required
The OCID of the compartment in which to list resources.
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.
display_name
string
A filter to return only resources that match the entire display name given.

aliases: name
group_tag
list / elements=string
A filter to return only resources that are accociated given group tag.
is_latest_version
list / elements=boolean
A filter to return only resources that matches given isLatestVersion.
key
string
The unique key of protection capability to filter by.
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.
sort_by
string
    Choices:
  • key
  • type
  • displayName
The field to sort by. Only one sort order may be provided. Default order for key is descending. Default order for type is descending. Default order for displayName is ascending. If no value is specified key is default.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either 'ASC' or 'DESC'.
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
type
string
    Choices:
  • REQUEST_PROTECTION_CAPABILITY
  • RESPONSE_PROTECTION_CAPABILITY
A filter to return only resources that matches given type.

Examples

- name: List protection_capabilities
  oci_waf_protection_capability_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    key: key_example
    is_latest_version: [ "true" ]
    type: REQUEST_PROTECTION_CAPABILITY
    group_tag: [ "group_tag_example" ]
    display_name: display_name_example
    sort_order: ASC
    sort_by: key

Return Values

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

Key Returned Description
protection_capabilities
complex
on success
List of ProtectionCapability resources

Sample:
[{'collaborative_action_threshold': 56, 'collaborative_weights': [{'display_name': 'display_name_example', 'key': 'key_example', 'weight': 56}], 'description': 'description_example', 'display_name': 'display_name_example', 'group_tags': [], 'is_latest_version': True, 'key': 'key_example', 'type': 'REQUEST_PROTECTION_CAPABILITY', 'version': 56}]
 
collaborative_action_threshold
integer
on success
The default collaborative action threshold for OCI-managed collaborative protection capability. Collaborative protection capabilities are made of several simple, non-collaborative protection capabilities (referred to as `contributing capabilities` later on) which have weights assigned to them. These weights can be found in the `collaborativeWeights` array. For incoming/outgoing HTTP messages, all contributing capabilities are executed and the sum of all triggered contributing capabilities weights is calculated. Only if this sum is greater than or equal to `collaborativeActionThreshold` is the incoming/outgoing HTTP message marked as malicious.
This field is ignored for non-collaborative capabilities.

Sample:
56
 
collaborative_weights
complex
on success
The weights of contributing capabilities. Defines how much each contributing capability contributes towards the action threshold of a collaborative protection capability.
This field is ignored for non-collaborative capabilities.

   
display_name
string
on success
The display name of contributing protection capability.

Sample:
display_name_example
   
key
string
on success
Unique key of contributing protection capability.

Sample:
key_example
   
weight
integer
on success
The weight of contributing protection capability.

Sample:
56
 
description
string
on success
The description of protection capability.

Sample:
description_example
 
display_name
string
on success
The display name of protection capability.

Sample:
display_name_example
 
group_tags
list / elements=string
on success
The list of unique names protection capability group tags that are associated with this capability. Example: ["PCI", "Recommended"]

 
is_latest_version
boolean
on success
The field that shows if this is the latest version of protection capability.

Sample:
True
 
key
string
on success
Unique key of protection capability.

Sample:
key_example
 
type
string
on success
The type of protection capability.
* **REQUEST_PROTECTION_CAPABILITY** can only be used in `requestProtection` module of WebAppFirewallPolicy.
* **RESPONSE_PROTECTION_CAPABILITY** can only be used in `responseProtection` module of WebAppFirewallPolicy.

Sample:
REQUEST_PROTECTION_CAPABILITY
 
version
integer
on success
The version of protection capability.

Sample:
56


Authors

  • Oracle (@oracle)