oracle.oci.oci_cloud_guard_target_detector_recipe – Manage a TargetDetectorRecipe 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_cloud_guard_target_detector_recipe.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • For state=present, attach a DetectorRecipe with the Target

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.
compartment_id
string
The ID of the compartment in which to list resources.
Required for create using state=present.
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.
detector_recipe_id
string
DetectorRecipe Identifier
Required for create using state=present.
This parameter is updatable.
detector_rules
list / elements=dictionary
Update detector rules associated with detector recipe in a target.
This parameter is updatable.
details
dictionary / required
condition_groups
list / elements=dictionary
Condition group corresponding to each compartment
compartment_id
string / required
compartment associated with condition
This parameter is updatable.
condition
dictionary / required
composite_operator
string
    Choices:
  • AND
  • OR
This parameter is updatable.
Applicable when kind is 'COMPOSITE'
kind
string / required
    Choices:
  • SIMPLE
  • COMPOSITE
Type of condition object
This parameter is updatable.
left_operand
dictionary
Applicable when kind is 'COMPOSITE'
kind
string / required
    Choices:
  • COMPOSITE
  • SIMPLE
Type of condition object
This parameter is updatable.
operator
string
    Choices:
  • IN
  • NOT_IN
  • EQUALS
  • NOT_EQUALS
type of operator
This parameter is updatable.
Applicable when kind is 'SIMPLE'
parameter
string
parameter Key
This parameter is updatable.
Applicable when kind is 'SIMPLE'
right_operand
dictionary
Applicable when kind is 'COMPOSITE'
kind
string / required
    Choices:
  • COMPOSITE
  • SIMPLE
Type of condition object
This parameter is updatable.
value
string
type of operator
This parameter is updatable.
Applicable when kind is 'SIMPLE'
value_type
string
    Choices:
  • MANAGED
  • CUSTOM
type of value
This parameter is updatable.
Applicable when kind is 'SIMPLE'
detector_rule_id
string / required
Identifier for DetectorRule.
This parameter is updatable.
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.
is_validation_only_query
boolean
    Choices:
  • no
  • yes
When enabled, validation is performed for attaching the detector recipe.
This parameter is updatable.
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.
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 ←
  • absent
The state of the TargetDetectorRecipe.
Use state=present to create or update a TargetDetectorRecipe.
Use state=absent to delete a TargetDetectorRecipe.
target_detector_recipe_id
string
OCID of TargetDetectorRecipe
Required for update using state=present.
Required for delete using state=absent.

aliases: id
target_id
string / required
OCID of target
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 target_detector_recipe
  oci_cloud_guard_target_detector_recipe:
    # required
    detector_recipe_id: "ocid1.detectorrecipe.oc1..xxxxxxEXAMPLExxxxxx"
    target_id: "ocid1.target.oc1..xxxxxxEXAMPLExxxxxx"

- name: Update target_detector_recipe
  oci_cloud_guard_target_detector_recipe:
    # required
    target_id: "ocid1.target.oc1..xxxxxxEXAMPLExxxxxx"
    target_detector_recipe_id: "ocid1.targetdetectorrecipe.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    detector_recipe_id: "ocid1.detectorrecipe.oc1..xxxxxxEXAMPLExxxxxx"
    is_validation_only_query: true
    detector_rules:
    - # required
      detector_rule_id: "ocid1.detectorrule.oc1..xxxxxxEXAMPLExxxxxx"
      details:
        # optional
        condition_groups:
        - # required
          compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
          condition:
            # required
            kind: SIMPLE

            # optional
            parameter: parameter_example
            operator: IN
            value: value_example
            value_type: MANAGED

- name: Delete target_detector_recipe
  oci_cloud_guard_target_detector_recipe:
    # required
    target_id: "ocid1.target.oc1..xxxxxxEXAMPLExxxxxx"
    target_detector_recipe_id: "ocid1.targetdetectorrecipe.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

Return Values

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

Key Returned Description
target_detector_recipe
complex
on success
Details of the TargetDetectorRecipe resource acted upon by the current operation

Sample:
{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'description': 'description_example', 'detector': 'IAAS_ACTIVITY_DETECTOR', 'detector_recipe_id': 'ocid1.detectorrecipe.oc1..xxxxxxEXAMPLExxxxxx', 'detector_rules': [{'data_source_id': 'ocid1.datasource.oc1..xxxxxxEXAMPLExxxxxx', 'description': 'description_example', 'details': {'condition_groups': [{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'condition': {'composite_operator': 'AND', 'kind': 'COMPOSITE', 'left_operand': {'kind': 'COMPOSITE'}, 'operator': 'IN', 'parameter': 'parameter_example', 'right_operand': {'kind': 'COMPOSITE'}, 'value': 'value_example', 'value_type': 'MANAGED'}}], 'configurations': [{'config_key': 'config_key_example', 'data_type': 'data_type_example', 'name': 'name_example', 'value': 'value_example', 'values': [{'list_type': 'MANAGED', 'managed_list_type': 'managed_list_type_example', 'value': 'value_example'}]}], 'is_configuration_allowed': True, 'is_enabled': True, 'labels': [], 'problem_threshold': 56, 'risk_level': 'CRITICAL', 'sighting_types': [{'description': 'description_example', 'display_name': 'display_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'mitre_link': 'mitre_link_example', 'tactic': 'tactic_example', 'techniques': []}], 'target_types': []}, 'detector': 'IAAS_ACTIVITY_DETECTOR', 'detector_rule_id': 'ocid1.detectorrule.oc1..xxxxxxEXAMPLExxxxxx', 'display_name': 'display_name_example', 'entities_mappings': [{'display_name': 'display_name_example', 'entity_type': 'EXTERNAL_IP', 'query_field': 'query_field_example'}], 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'managed_list_types': [], 'recommendation': 'recommendation_example', 'resource_type': 'resource_type_example', 'service_type': 'service_type_example', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}], 'display_name': 'display_name_example', 'effective_detector_rules': [{'data_source_id': 'ocid1.datasource.oc1..xxxxxxEXAMPLExxxxxx', 'description': 'description_example', 'details': {'condition_groups': [{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'condition': {'composite_operator': 'AND', 'kind': 'COMPOSITE', 'left_operand': {'kind': 'COMPOSITE'}, 'operator': 'IN', 'parameter': 'parameter_example', 'right_operand': {'kind': 'COMPOSITE'}, 'value': 'value_example', 'value_type': 'MANAGED'}}], 'configurations': [{'config_key': 'config_key_example', 'data_type': 'data_type_example', 'name': 'name_example', 'value': 'value_example', 'values': [{'list_type': 'MANAGED', 'managed_list_type': 'managed_list_type_example', 'value': 'value_example'}]}], 'is_configuration_allowed': True, 'is_enabled': True, 'labels': [], 'problem_threshold': 56, 'risk_level': 'CRITICAL', 'sighting_types': [{'description': 'description_example', 'display_name': 'display_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'mitre_link': 'mitre_link_example', 'tactic': 'tactic_example', 'techniques': []}], 'target_types': []}, 'detector': 'IAAS_ACTIVITY_DETECTOR', 'detector_rule_id': 'ocid1.detectorrule.oc1..xxxxxxEXAMPLExxxxxx', 'display_name': 'display_name_example', 'entities_mappings': [{'display_name': 'display_name_example', 'entity_type': 'EXTERNAL_IP', 'query_field': 'query_field_example'}], 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'managed_list_types': [], 'recommendation': 'recommendation_example', 'resource_type': 'resource_type_example', 'service_type': 'service_type_example', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}], 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'CREATING', 'owner': 'CUSTOMER', 'source_data_retention': 56, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}
 
compartment_id
string
on success
compartmentId of detector recipe

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
description
string
on success
Detector recipe description.

Sample:
description_example
 
detector
string
on success
Type of detector

Sample:
IAAS_ACTIVITY_DETECTOR
 
detector_recipe_id
string
on success
Unique identifier for Detector Recipe of which this is an extension

Sample:
ocid1.detectorrecipe.oc1..xxxxxxEXAMPLExxxxxx
 
detector_rules
complex
on success
List of detector rules for the detector type for recipe - user input
   
data_source_id
string
on success
The id of the attached DataSource.

Sample:
ocid1.datasource.oc1..xxxxxxEXAMPLExxxxxx
   
description
string
on success
Description for TargetDetectorRecipeDetectorRule. information.

Sample:
description_example
   
details
complex
on success

     
condition_groups
complex
on success
Condition group corresponding to each compartment
       
compartment_id
string
on success
compartment associated with condition

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
       
condition
complex
on success

         
composite_operator
string
on success

Sample:
AND
         
kind
string
on success
Type of condition object

Sample:
COMPOSITE
         
left_operand
complex
on success

           
kind
string
on success
Type of condition object

Sample:
COMPOSITE
         
operator
string
on success
type of operator

Sample:
IN
         
parameter
string
on success
parameter Key

Sample:
parameter_example
         
right_operand
complex
on success

           
kind
string
on success
Type of condition object

Sample:
COMPOSITE
         
value
string
on success
type of operator

Sample:
value_example
         
value_type
string
on success
type of value

Sample:
MANAGED
     
configurations
complex
on success
Configuration details
       
config_key
string
on success
Unique name of the configuration

Sample:
config_key_example
       
data_type
string
on success
configuration data type

Sample:
data_type_example
       
name
string
on success
configuration name

Sample:
name_example
       
value
string
on success
configuration value

Sample:
value_example
       
values
complex
on success
List of configuration values
         
list_type
string
on success
configuration list item type, either CUSTOM or MANAGED

Sample:
MANAGED
         
managed_list_type
string
on success
type of the managed list

Sample:
managed_list_type_example
         
value
string
on success
configuration value

Sample:
value_example
     
is_configuration_allowed
boolean
on success
configuration allowed or not

Sample:
True
     
is_enabled
boolean
on success
Enables the control

Sample:
True
     
labels
list / elements=string
on success
user defined labels for a detector rule
     
problem_threshold
integer
on success
Cutover point for an elevated resource Risk Score to create a Problem

Sample:
56
     
risk_level
string
on success
The Risk Level

Sample:
CRITICAL
     
sighting_types
complex
on success
List of sighting types
       
description
string
on success
Description of the sighting type

Sample:
description_example
       
display_name
string
on success
Name of the sighting type

Sample:
display_name_example
       
id
string
on success
The unique identifier of sighting type

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
        mitre_link
string
on success
Link of the sighting type

Sample:
mitre_link_example
       
tactic
string
on success
Mitre Att&ck tactic

Sample:
tactic_example
       
techniques
list / elements=string
on success
List of Mitre Att&ck Techniques
     
target_types
list / elements=string
on success
List of target types for which the detector rule is applicable
   
detector
string
on success
detector for the rule

Sample:
IAAS_ACTIVITY_DETECTOR
   
detector_rule_id
string
on success
The unique identifier of the detector rule.

Sample:
ocid1.detectorrule.oc1..xxxxxxEXAMPLExxxxxx
   
display_name
string
on success
Display name for TargetDetectorRecipeDetectorRule. information.

Sample:
display_name_example
   
entities_mappings
complex
on success
Data Source entities mapping for a Detector Rule
     
display_name
string
on success
The display name of entity

Sample:
display_name_example
     
entity_type
string
on success
Possible type of entity

Sample:
EXTERNAL_IP
     
query_field
string
on success
The entity value mapped to a data source query

Sample:
query_field_example
   
lifecycle_details
string
on success
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

Sample:
lifecycle_details_example
   
lifecycle_state
string
on success
The current state of the DetectorRule.

Sample:
CREATING
   
managed_list_types
list / elements=string
on success
List of cloudguard managed list types related to this rule
   
recommendation
string
on success
Recommendation for TargetDetectorRecipeDetectorRule

Sample:
recommendation_example
   
resource_type
string
on success
resource type of the configuration to which the rule is applied

Sample:
resource_type_example
   
service_type
string
on success
service type of the configuration to which the rule is applied

Sample:
service_type_example
   
time_created
string
on success
The date and time the target detector recipe rule was created. Format defined by RFC3339.

Sample:
2013-10-20T19:20:30+01:00
   
time_updated
string
on success
The date and time the target detector recipe rule was updated. Format defined by RFC3339.

Sample:
2013-10-20T19:20:30+01:00
 
display_name
string
on success
Display name of detector recipe.

Sample:
display_name_example
 
effective_detector_rules
complex
on success
List of effective detector rules for the detector type for recipe after applying defaults
   
data_source_id
string
on success
The id of the attached DataSource.

Sample:
ocid1.datasource.oc1..xxxxxxEXAMPLExxxxxx
   
description
string
on success
Description for TargetDetectorRecipeDetectorRule. information.

Sample:
description_example
   
details
complex
on success

     
condition_groups
complex
on success
Condition group corresponding to each compartment
       
compartment_id
string
on success
compartment associated with condition

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
       
condition
complex
on success

         
composite_operator
string
on success

Sample:
AND
         
kind
string
on success
Type of condition object

Sample:
COMPOSITE
         
left_operand
complex
on success

           
kind
string
on success
Type of condition object

Sample:
COMPOSITE
         
operator
string
on success
type of operator

Sample:
IN
         
parameter
string
on success
parameter Key

Sample:
parameter_example
         
right_operand
complex
on success

           
kind
string
on success
Type of condition object

Sample:
COMPOSITE
         
value
string
on success
type of operator

Sample:
value_example
         
value_type
string
on success
type of value

Sample:
MANAGED
     
configurations
complex
on success
Configuration details
       
config_key
string
on success
Unique name of the configuration

Sample:
config_key_example
       
data_type
string
on success
configuration data type

Sample:
data_type_example
       
name
string
on success
configuration name

Sample:
name_example
       
value
string
on success
configuration value

Sample:
value_example
       
values
complex
on success
List of configuration values
         
list_type
string
on success
configuration list item type, either CUSTOM or MANAGED

Sample:
MANAGED
         
managed_list_type
string
on success
type of the managed list

Sample:
managed_list_type_example
         
value
string
on success
configuration value

Sample:
value_example
     
is_configuration_allowed
boolean
on success
configuration allowed or not

Sample:
True
     
is_enabled
boolean
on success
Enables the control

Sample:
True
     
labels
list / elements=string
on success
user defined labels for a detector rule
     
problem_threshold
integer
on success
Cutover point for an elevated resource Risk Score to create a Problem

Sample:
56
     
risk_level
string
on success
The Risk Level

Sample:
CRITICAL
     
sighting_types
complex
on success
List of sighting types
       
description
string
on success
Description of the sighting type

Sample:
description_example
       
display_name
string
on success
Name of the sighting type

Sample:
display_name_example
       
id
string
on success
The unique identifier of sighting type

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
        mitre_link
string
on success
Link of the sighting type

Sample:
mitre_link_example
       
tactic
string
on success
Mitre Att&ck tactic

Sample:
tactic_example
       
techniques
list / elements=string
on success
List of Mitre Att&ck Techniques
     
target_types
list / elements=string
on success
List of target types for which the detector rule is applicable
   
detector
string
on success
detector for the rule

Sample:
IAAS_ACTIVITY_DETECTOR
   
detector_rule_id
string
on success
The unique identifier of the detector rule.

Sample:
ocid1.detectorrule.oc1..xxxxxxEXAMPLExxxxxx
   
display_name
string
on success
Display name for TargetDetectorRecipeDetectorRule. information.

Sample:
display_name_example
   
entities_mappings
complex
on success
Data Source entities mapping for a Detector Rule
     
display_name
string
on success
The display name of entity

Sample:
display_name_example
     
entity_type
string
on success
Possible type of entity

Sample:
EXTERNAL_IP
     
query_field
string
on success
The entity value mapped to a data source query

Sample:
query_field_example
   
lifecycle_details
string
on success
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

Sample:
lifecycle_details_example
   
lifecycle_state
string
on success
The current state of the DetectorRule.

Sample:
CREATING
   
managed_list_types
list / elements=string
on success
List of cloudguard managed list types related to this rule
   
recommendation
string
on success
Recommendation for TargetDetectorRecipeDetectorRule

Sample:
recommendation_example
   
resource_type
string
on success
resource type of the configuration to which the rule is applied

Sample:
resource_type_example
   
service_type
string
on success
service type of the configuration to which the rule is applied

Sample:
service_type_example
   
time_created
string
on success
The date and time the target detector recipe rule was created. Format defined by RFC3339.

Sample:
2013-10-20T19:20:30+01:00
   
time_updated
string
on success
The date and time the target detector recipe rule was updated. Format defined by RFC3339.

Sample:
2013-10-20T19:20:30+01:00
 
id
string
on success
Ocid for detector recipe

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_state
string
on success
The current state of the resource.

Sample:
CREATING
 
owner
string
on success
Owner of detector recipe

Sample:
CUSTOMER
 
source_data_retention
integer
on success
The number of days for which source data is retained

Sample:
56
 
time_created
string
on success
The date and time the target detector recipe was created. Format defined by RFC3339.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The date and time the target detector recipe was updated. Format defined by RFC3339.

Sample:
2013-10-20T19:20:30+01:00


Authors

  • Oracle (@oracle)