oracle.oci.oci_data_safe_finding_facts – Fetches details about one or multiple Finding resources in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

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

  • List all the findings from all the targets in the specified assessment.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
access_level
string
    Choices:
  • RESTRICTED
  • ACCESSIBLE
Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.
api_user
string
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See config_file_location). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint
string
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See config_file_location). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file
string
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See config_file_location). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided.
api_user_key_pass_phrase
string
Passphrase used by the key referenced in api_user_key_file, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location).
auth_purpose
string
    Choices:
  • service_principal
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
The type of authentication to use for making API requests. By default auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
cert_bundle
string
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
compartment_id_in_subtree
boolean
    Choices:
  • no
  • yes
Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
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.
finding_key
string
Each finding has a key. This key is same for the finding across targets
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.
security_assessment_id
string / required
The OCID of the security assessment.
severity
string
    Choices:
  • HIGH
  • MEDIUM
  • LOW
  • EVALUATE
  • ADVISORY
  • PASS
A filter to return only findings of a particular risk level.
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: List findings
  oci_data_safe_finding_facts:
    # required
    security_assessment_id: "ocid1.securityassessment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    severity: HIGH
    compartment_id_in_subtree: true
    access_level: RESTRICTED
    finding_key: finding_key_example

Return Values

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

Key Returned Description
findings
complex
on success
List of Finding resources

Sample:
[{'assessment_id': 'ocid1.assessment.oc1..xxxxxxEXAMPLExxxxxx', 'details': {}, 'key': 'key_example', 'references': {'cis': 'cis_example', 'gdpr': 'gdpr_example', 'stig': 'stig_example'}, 'remarks': 'remarks_example', 'severity': 'HIGH', 'summary': 'summary_example', 'target_id': 'ocid1.target.oc1..xxxxxxEXAMPLExxxxxx', 'title': 'title_example'}]
 
assessment_id
string
on success
The OCID of the assessment that generated this finding.

Sample:
ocid1.assessment.oc1..xxxxxxEXAMPLExxxxxx
 
details
dictionary
on success
The details of the finding. Provides detailed information to explain the finding summary, typically results from the assessed database, followed by any recommendations for changes.

 
key
string
on success
The unique finding key. This is a system-generated identifier. To get the finding key for a finding, use ListFindings.

Sample:
key_example
 
references
complex
on success
Provides information on whether the finding is related to a CIS Oracle Database Benchmark recommendation, a STIG rule, or a GDPR Article/Recital.

   
cis
string
on success
Relevant section from CIS.

Sample:
cis_example
   
gdpr
string
on success
Relevant section from GDPR.

Sample:
gdpr_example
   
stig
string
on success
Relevant section from STIG.

Sample:
stig_example
 
remarks
string
on success
The explanation of the issue in this finding. It explains the reason for the rule and, if a risk is reported, it may also explain the recommended actions for remediation.

Sample:
remarks_example
 
severity
string
on success
The severity of the finding.

Sample:
HIGH
 
summary
string
on success
The brief summary of the finding. When the finding is informational, the summary typically reports only the number of data elements that were examined.

Sample:
summary_example
 
target_id
string
on success
The OCID of the target database.

Sample:
ocid1.target.oc1..xxxxxxEXAMPLExxxxxx
 
title
string
on success
The short title for the finding.

Sample:
title_example


Authors

  • Oracle (@oracle)