oracle.oci.oci_cloud_guard_target – Manage a Target resource in Oracle Cloud Infrastructure¶

Note

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

New in version 2.9.0: of oracle.oci

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis ¶

This module allows the user to create, update and delete a Target resource in Oracle Cloud Infrastructure
For state=present, creates a new Target

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
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								Compartment Identifier where the resource is created Required for create using state=present. Required for update when environment variable `OCI_USE_NAME_AS_IDENTIFIER` is set. Required for delete when environment variable `OCI_USE_NAME_AS_IDENTIFIER` is set.
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`.
defined_tags dictionary								Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` This parameter is updatable.
description string								The target description. Avoid entering confidential information.
display_name string								DetectorTemplate identifier. Avoid entering confidential information. Required for create using state=present. Required for update, delete when environment variable `OCI_USE_NAME_AS_IDENTIFIER` is set. This parameter is updatable when `OCI_USE_NAME_AS_IDENTIFIER` is not set. aliases: name
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.
freeform_tags dictionary								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. 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.
lifecycle_state string							Choices: CREATING UPDATING ACTIVE INACTIVE DELETING DELETED FAILED	The current state of the DetectorRule. This parameter is updatable.
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 Target. Use state=present to create or update a Target. Use state=absent to delete a Target.
target_detector_recipes list / elements=dictionary								List of detector recipes to associate with target This parameter is updatable.
	detector_recipe_id string							Identifier for DetectorRecipe.
	detector_rules list / elements=dictionary							Overrides to be applied to Detector Rule associated with the target
		details dictionary / required
			condition_groups list / elements=dictionary					Condition group corresponding to each compartment
				compartment_id string / required				compartment associated with condition
				condition dictionary / required
					composite_operator string		Choices: AND OR	Applicable when kind is 'COMPOSITE'
					kind string / required		Choices: SIMPLE COMPOSITE	Type of condition object
					left_operand dictionary			Applicable when kind is 'COMPOSITE'
						kind string / required	Choices: COMPOSITE SIMPLE	Type of condition object
					operator string		Choices: IN NOT_IN EQUALS NOT_EQUALS	type of operator Applicable when kind is 'SIMPLE'
					parameter string			parameter Key Applicable when kind is 'SIMPLE'
					right_operand dictionary			Applicable when kind is 'COMPOSITE'
						kind string / required	Choices: COMPOSITE SIMPLE	Type of condition object
					value string			type of operator Applicable when kind is 'SIMPLE'
					value_type string		Choices: MANAGED CUSTOM	type of value Applicable when kind is 'SIMPLE'
		detector_rule_id string / required						Identifier for DetectorRule.
	target_detector_recipe_id string							Identifier for DetectorRecipe. This parameter is updatable.
target_id string								OCID of target Required for update using state=present when environment variable `OCI_USE_NAME_AS_IDENTIFIER` is not set. Required for delete using state=absent when environment variable `OCI_USE_NAME_AS_IDENTIFIER` is not set. aliases: id
target_resource_id string								Resource ID which the target uses to monitor Required for create using state=present.
target_resource_type string							Choices: COMPARTMENT ERPCLOUD HCMCLOUD SECURITY_ZONE	possible type of targets(COMPARTMENT/FACLOUD) Required for create using state=present.
target_responder_recipes list / elements=dictionary								List of responder recipes to associate with target This parameter is updatable.
	responder_recipe_id string							Identifier for ResponderRecipe.
	responder_rules list / elements=dictionary							Override responder rules associated with reponder recipe in a target.
		details dictionary / required
			condition dictionary
				composite_operator string			Choices: AND OR	Applicable when kind is 'COMPOSITE'
				kind string / required			Choices: SIMPLE COMPOSITE	Type of condition object
				left_operand dictionary				Applicable when kind is 'COMPOSITE'
					kind string / required		Choices: COMPOSITE SIMPLE	Type of condition object
				operator string			Choices: IN NOT_IN EQUALS NOT_EQUALS	type of operator Applicable when kind is 'SIMPLE'
				parameter string				parameter Key Applicable when kind is 'SIMPLE'
				right_operand dictionary				Applicable when kind is 'COMPOSITE'
					kind string / required		Choices: COMPOSITE SIMPLE	Type of condition object
				value string				type of operator Applicable when kind is 'SIMPLE'
				value_type string			Choices: MANAGED CUSTOM	type of value Applicable when kind is 'SIMPLE'
			configurations list / elements=dictionary					Configurations associated with the ResponderRule
				config_key string / required				Unique name of the configuration
				name string / required				configuration name
				value string / required				configuration value
			mode string				Choices: AUTOACTION USERACTION	Execution Mode for ResponderRule
		responder_rule_id string / required						Identifier for ResponderRule.
	target_responder_recipe_id string							Identifier for ResponderRecipe. This parameter is updatable.
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.

Notes ¶

Note

For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html

Examples ¶

- name: Create target
  oci_cloud_guard_target:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    target_resource_type: COMPARTMENT
    target_resource_id: "ocid1.targetresource.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example

    # optional
    description: description_example
    lifecycle_state: CREATING
    target_detector_recipes:
    - # optional
      detector_recipe_id: "ocid1.detectorrecipe.oc1..xxxxxxEXAMPLExxxxxx"
      target_detector_recipe_id: "ocid1.targetdetectorrecipe.oc1..xxxxxxEXAMPLExxxxxx"
      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
    target_responder_recipes:
    - # optional
      responder_recipe_id: "ocid1.responderrecipe.oc1..xxxxxxEXAMPLExxxxxx"
      target_responder_recipe_id: "ocid1.targetresponderrecipe.oc1..xxxxxxEXAMPLExxxxxx"
      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
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update target
  oci_cloud_guard_target:
    # required
    target_id: "ocid1.target.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    display_name: display_name_example
    lifecycle_state: CREATING
    target_detector_recipes:
    - # optional
      detector_recipe_id: "ocid1.detectorrecipe.oc1..xxxxxxEXAMPLExxxxxx"
      target_detector_recipe_id: "ocid1.targetdetectorrecipe.oc1..xxxxxxEXAMPLExxxxxx"
      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
    target_responder_recipes:
    - # optional
      responder_recipe_id: "ocid1.responderrecipe.oc1..xxxxxxEXAMPLExxxxxx"
      target_responder_recipe_id: "ocid1.targetresponderrecipe.oc1..xxxxxxEXAMPLExxxxxx"
      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
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update target using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_cloud_guard_target:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example

    # optional
    lifecycle_state: CREATING
    target_detector_recipes:
    - # optional
      detector_recipe_id: "ocid1.detectorrecipe.oc1..xxxxxxEXAMPLExxxxxx"
      target_detector_recipe_id: "ocid1.targetdetectorrecipe.oc1..xxxxxxEXAMPLExxxxxx"
      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
    target_responder_recipes:
    - # optional
      responder_recipe_id: "ocid1.responderrecipe.oc1..xxxxxxEXAMPLExxxxxx"
      target_responder_recipe_id: "ocid1.targetresponderrecipe.oc1..xxxxxxEXAMPLExxxxxx"
      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
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Delete target
  oci_cloud_guard_target:
    # required
    target_id: "ocid1.target.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete target using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_cloud_guard_target:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    state: absent

Return Values ¶

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

Key								Returned	Description
target complex								on success	Details of the Target 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', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'inherited_by_compartments': [], 'lifecycle_state': 'CREATING', 'lifecyle_details': 'lifecyle_details_example', 'recipe_count': 56, 'system_tags': {}, 'target_details': {'security_zone_display_name': 'security_zone_display_name_example', 'security_zone_id': 'ocid1.securityzone.oc1..xxxxxxEXAMPLExxxxxx', 'target_resource_type': 'COMPARTMENT', 'target_security_zone_recipes': [{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'owner': 'CUSTOMER', 'security_policies': [], 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}]}, 'target_detector_recipes': [{'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'}], 'target_resource_id': 'ocid1.targetresource.oc1..xxxxxxEXAMPLExxxxxx', 'target_resource_type': 'COMPARTMENT', 'target_responder_recipes': [{'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'}], '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 where the resource is created 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	The target description. Sample: description_example
	display_name string							on success	Target display name, can be renamed. Sample: display_name_example
	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	Unique identifier that is immutable on creation. Sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
	inherited_by_compartments list / elements=string							on success	List of inherited compartments
	lifecycle_state string							on success	The current state of the Target. Sample: CREATING
	lifecyle_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: lifecyle_details_example
	recipe_count integer							on success	Total number of recipes attached to target Sample: 56
	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"}}`
	target_details complex							on success
		security_zone_display_name string						on success	The name of the security zone to associate this compartment with. Sample: security_zone_display_name_example
		security_zone_id string						on success	The OCID of the security zone to associate this compartment with. Sample: ocid1.securityzone.oc1..xxxxxxEXAMPLExxxxxx
		target_resource_type string						on success	Possible type of targets. Sample: COMPARTMENT
		target_security_zone_recipes complex						on success	The list of security zone recipes to associate this compartment with.
			compartment_id string					on success	The id of the compartment that contains the recipe 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	The recipe's description Sample: description_example
			display_name string					on success	The recipe's name Sample: display_name_example
			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	Unique identifier that is immutable on creation Sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
			lifecycle_details string					on success	A message describing the current state in more detail. For example, this can be used to provide actionable information for a recipe in the `Failed` state. Sample: lifecycle_details_example
			lifecycle_state string					on success	The current state of the recipe Sample: CREATING
			owner string					on success	The owner of the recipe Sample: CUSTOMER
			security_policies list / elements=string					on success	The list of `SecurityPolicy` ids that are included in the recipe
			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 time the recipe was created. An RFC3339 formatted datetime string. Sample: 2013-10-20T19:20:30+01:00
			time_updated string					on success	The time the recipe was last updated. An RFC3339 formatted datetime string. Sample: 2013-10-20T19:20:30+01:00
	target_detector_recipes complex							on success	List of detector recipes associated with target
		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
	target_resource_id string							on success	Resource ID which the target uses to monitor Sample: ocid1.targetresource.oc1..xxxxxxEXAMPLExxxxxx
	target_resource_type string							on success	possible type of targets Sample: COMPARTMENT
	target_responder_recipes complex							on success	List of responder recipes associated with target
		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
	time_created string							on success	The date and time the target 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 was updated. Format defined by RFC3339. Sample: 2013-10-20T19:20:30+01:00

Authors¶

Oracle (@oracle)

oracle.oci.oci_cloud_guard_target – Manage a Target resource in Oracle Cloud Infrastructure¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶