oracle.oci.oci_cloud_guard_target_responder_recipe – Manage a TargetResponderRecipe 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_responder_recipe.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • For state=present, attach a ResponderRecipe 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.
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.
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.
responder_recipe_id
string
ResponderRecipe Identifier
Required for create using state=present.
responder_rules
list / elements=dictionary
Update responder rules associated with responder recipe in a target.
Required for update using state=present with target_responder_recipe_id present.
details
dictionary / required
condition
dictionary
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'
configurations
list / elements=dictionary
Configurations associated with the ResponderRule
config_key
string / required
Unique name of the configuration
This parameter is updatable.
name
string / required
configuration name
This parameter is updatable.
value
string / required
configuration value
This parameter is updatable.
mode
string
    Choices:
  • AUTOACTION
  • USERACTION
Execution Mode for ResponderRule
This parameter is updatable.
responder_rule_id
string / required
Identifier for ResponderRule.
This parameter is updatable.
state
string
    Choices:
  • present ←
  • absent
The state of the TargetResponderRecipe.
Use state=present to create or update a TargetResponderRecipe.
Use state=absent to delete a TargetResponderRecipe.
target_id
string / required
OCID of target
target_responder_recipe_id
string
OCID of TargetResponderRecipe
Required for update using state=present.
Required for delete using state=absent.

aliases: id
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

Examples

- name: Create target_responder_recipe
  oci_cloud_guard_target_responder_recipe:
    # required
    responder_recipe_id: "ocid1.responderrecipe.oc1..xxxxxxEXAMPLExxxxxx"
    target_id: "ocid1.target.oc1..xxxxxxEXAMPLExxxxxx"

- name: Update target_responder_recipe
  oci_cloud_guard_target_responder_recipe:
    # required
    responder_rules:
    - # required
      responder_rule_id: "ocid1.responderrule.oc1..xxxxxxEXAMPLExxxxxx"
      details:
        # optional
        condition:
          # required
          kind: SIMPLE

          # optional
          parameter: parameter_example
          operator: IN
          value: value_example
          value_type: MANAGED
        configurations:
        - # required
          config_key: config_key_example
          name: name_example
          value: value_example
        mode: AUTOACTION
    target_id: "ocid1.target.oc1..xxxxxxEXAMPLExxxxxx"
    target_responder_recipe_id: "ocid1.targetresponderrecipe.oc1..xxxxxxEXAMPLExxxxxx"

- name: Delete target_responder_recipe
  oci_cloud_guard_target_responder_recipe:
    # required
    target_id: "ocid1.target.oc1..xxxxxxEXAMPLExxxxxx"
    target_responder_recipe_id: "ocid1.targetresponderrecipe.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_responder_recipe
complex
on success
Details of the TargetResponderRecipe resource acted upon by the current operation

Sample:
{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'description': 'description_example', 'display_name': 'display_name_example', 'effective_responder_rules': [{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'description': 'description_example', 'details': {'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', 'name': 'name_example', 'value': 'value_example'}], 'is_enabled': True, 'mode': 'AUTOACTION'}, 'display_name': 'display_name_example', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'policies': [], 'responder_rule_id': 'ocid1.responderrule.oc1..xxxxxxEXAMPLExxxxxx', 'supported_modes': [], 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'type': 'REMEDIATION'}], 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'owner': 'CUSTOMER', 'responder_recipe_id': 'ocid1.responderrecipe.oc1..xxxxxxEXAMPLExxxxxx', 'responder_rules': [{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'description': 'description_example', 'details': {'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', 'name': 'name_example', 'value': 'value_example'}], 'is_enabled': True, 'mode': 'AUTOACTION'}, 'display_name': 'display_name_example', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'policies': [], 'responder_rule_id': 'ocid1.responderrule.oc1..xxxxxxEXAMPLExxxxxx', 'supported_modes': [], 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'type': 'REMEDIATION'}], 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}
 
compartment_id
string
on success
Compartment Identifier

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
description
string
on success
ResponderRecipe description.

Sample:
description_example
 
display_name
string
on success
ResponderRecipe display name.

Sample:
display_name_example
 
effective_responder_rules
complex
on success
List of responder rules associated with the recipe after applying all defaults
   
compartment_id
string
on success
Compartment Identifier

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
   
description
string
on success
ResponderRule description.

Sample:
description_example
   
details
complex
on success

     
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
ResponderRule configurations
       
config_key
string
on success
Unique name of the configuration

Sample:
config_key_example
       
name
string
on success
configuration name

Sample:
name_example
       
value
string
on success
configuration value

Sample:
value_example
     
is_enabled
boolean
on success
Identifies state for ResponderRule

Sample:
True
     
mode
string
on success
Execution Mode for ResponderRule

Sample:
AUTOACTION
   
display_name
string
on success
ResponderRule display name.

Sample:
display_name_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 ResponderRule.

Sample:
CREATING
   
policies
list / elements=string
on success
List of Policy
   
responder_rule_id
string
on success
Unique ResponderRule identifier.

Sample:
ocid1.responderrule.oc1..xxxxxxEXAMPLExxxxxx
   
supported_modes
list / elements=string
on success
Supported Execution Modes
   
time_created
string
on success
The date and time the target responder 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 responder recipe rule was updated. Format defined by RFC3339.

Sample:
2013-10-20T19:20:30+01:00
   
type
string
on success
Type of Responder

Sample:
REMEDIATION
 
id
string
on success
Unique identifier of TargetResponderRecipe that can't be changed after creation.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
owner
string
on success
Owner of ResponderRecipe

Sample:
CUSTOMER
 
responder_recipe_id
string
on success
Unique identifier for Responder Recipe of which this is an extension.

Sample:
ocid1.responderrecipe.oc1..xxxxxxEXAMPLExxxxxx
 
responder_rules
complex
on success
List of responder rules associated with the recipe - user input
   
compartment_id
string
on success
Compartment Identifier

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
   
description
string
on success
ResponderRule description.

Sample:
description_example
   
details
complex
on success

     
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
ResponderRule configurations
       
config_key
string
on success
Unique name of the configuration

Sample:
config_key_example
       
name
string
on success
configuration name

Sample:
name_example
       
value
string
on success
configuration value

Sample:
value_example
     
is_enabled
boolean
on success
Identifies state for ResponderRule

Sample:
True
     
mode
string
on success
Execution Mode for ResponderRule

Sample:
AUTOACTION
   
display_name
string
on success
ResponderRule display name.

Sample:
display_name_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 ResponderRule.

Sample:
CREATING
   
policies
list / elements=string
on success
List of Policy
   
responder_rule_id
string
on success
Unique ResponderRule identifier.

Sample:
ocid1.responderrule.oc1..xxxxxxEXAMPLExxxxxx
   
supported_modes
list / elements=string
on success
Supported Execution Modes
   
time_created
string
on success
The date and time the target responder 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 responder recipe rule was updated. Format defined by RFC3339.

Sample:
2013-10-20T19:20:30+01:00
   
type
string
on success
Type of Responder

Sample:
REMEDIATION
 
time_created
string
on success
The date and time the target responder 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 responder recipe rule was updated. Format defined by RFC3339.

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


Authors

  • Oracle (@oracle)