oracle.oci.oci_cloud_guard_responder_recipe_actions – Perform actions on a ResponderRecipe resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 4.13.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_responder_recipe_actions.
New in version 2.9.0: of oracle.oci
Synopsis¶
Perform actions on a ResponderRecipe resource in Oracle Cloud Infrastructure
For action=change_compartment, moves the ResponderRecipe from current compartment to another.
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 |
|---|---|---|
|
action
string
/ required
|
|
The action to perform on the ResponderRecipe.
|
|
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
|
|
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
|
|
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 into which the ResponderRecipe should be moved
|
|
|
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. |
|
|
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
/ required
|
OCID of ResponderRecipe
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 |
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Perform action change_compartment on responder_recipe
oci_cloud_guard_responder_recipe_actions:
# required
responder_recipe_id: "ocid1.responderrecipe.oc1..xxxxxxEXAMPLExxxxxx"
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
action: change_compartment
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | |||||
|---|---|---|---|---|---|---|---|
|
responder_recipe
complex
|
on success |
Details of the ResponderRecipe resource acted upon by the current operation
Sample:
{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, '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'}], 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'owner': 'CUSTOMER', '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'}], 'source_responder_recipe_id': 'ocid1.sourceresponderrecipe.oc1..xxxxxxEXAMPLExxxxxx', 'system_tags': {}, '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
|
|||||
|
defined_tags
dictionary
|
on success |
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
Sample:
{'Operations': {'CostCenter': 'US'}}
|
|||||
|
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
|
|||||
|
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 |
Identifier for ResponderRule.
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 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 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
|
|||||
|
freeform_tags
dictionary
|
on success |
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
Avoid entering confidential information.
Sample:
{'Department': 'Finance'}
|
|||||
|
id
string
|
on success |
Identifier for ResponderRecipe.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
|||||
|
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 Example.
Sample:
CREATING
|
|||||
|
owner
string
|
on success |
Owner of ResponderRecipe
Sample:
CUSTOMER
|
|||||
|
responder_rules
complex
|
on success |
List of responder rules associated with the recipe
|
|||||
|
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 |
Identifier for ResponderRule.
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 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 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
|
|||||
|
source_responder_recipe_id
string
|
on success |
The id of the source responder recipe.
Sample:
ocid1.sourceresponderrecipe.oc1..xxxxxxEXAMPLExxxxxx
|
|||||
|
system_tags
dictionary
|
on success |
System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
|
|||||
|
time_created
string
|
on success |
The date and time the responder 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 responder recipe was updated. Format defined by RFC3339.
Sample:
2013-10-20T19:20:30+01:00
|
|||||
Authors¶
Oracle (@oracle)