oracle.oci.oci_adm_application_dependency_vulnerability_facts – Fetches details about one or multiple ApplicationDependencyVulnerability resources in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Returns a list of Application Dependencies with their associated vulnerabilities.

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
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.
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.
cvss_v2_greater_than_or_equal
float
A filter that returns only Vulnerability Audits that have a Common Vulnerability Scoring System Version 2 (CVSS V2) greater or equal than the specified value.
cvss_v3_greater_than_or_equal
float
A filter that returns only Vulnerability Audits that have a Common Vulnerability Scoring System Version 3 (CVSS V3) greater or equal than the specified value.
depth
integer
A filter to limit depth of the application dependencies tree traversal. Additionally query parameters such as "cvssV2GreaterThanOrEqual", "cvssV3GreaterThanOrEqual", "gav" and "vulnerabilityId" can't be used in conjunction with this latter.
gav
string
A filter to return only resources that match the entire GAV (Group Artifact Version) identifier given.
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.
root_node_id
string
A filter to override the top level root identifier with the new given value. The application dependency tree will only be traversed from the given node. Query parameters "cvssV2GreaterThanOrEqual", "cvssV3GreaterThanOrEqual", "gav" and "vulnerabilityId" cannot be used in conjunction with this parameter.
sort_by
string
    Choices:
  • gav
  • nodeId
  • dfs
  • bfs
The field to sort by. Only one sort order may be provided. If sort order is dfs, the nodes are returned by going through the application dependency tree in a depth-first manner. Children are sorted based on their GAV property alphabetically (either ascending or descending, depending on the order parameter). Default order is ascending. If sort order is bfs, the nodes are returned by going through the application dependency tree in a breadth-first manner. Children are sorted based on their GAV property alphabetically (either ascending or descending, depending on the order parameter). Default order is ascending. Default order for gav is ascending where ascending corresponds to alphanumerical order. Default order for nodeId is ascending where ascending corresponds to alphanumerical order. Sorting by DFS or BFS cannot be used in conjunction with the following query parameters: "gav", "cvssV2GreaterThanOrEqual", "cvssV3GreaterThanOrEqual" and "vulnerabilityId".
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either 'ASC' or 'DESC'.
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
vulnerability_audit_id
string / required
Unique Vulnerability Audit identifier path parameter.
vulnerability_id
string
A filter to return only Vulnerability Audits that match the specified id.

Examples

- name: List application_dependency_vulnerabilities
  oci_adm_application_dependency_vulnerability_facts:
    # required
    vulnerability_audit_id: "ocid1.vulnerabilityaudit.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    vulnerability_id: "ocid1.vulnerability.oc1..xxxxxxEXAMPLExxxxxx"
    cvss_v3_greater_than_or_equal: 3.4
    cvss_v2_greater_than_or_equal: 3.4
    sort_order: ASC
    sort_by: gav
    root_node_id: "ocid1.rootnode.oc1..xxxxxxEXAMPLExxxxxx"
    depth: 56
    gav: gav_example

Return Values

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

Key Returned Description
application_dependency_vulnerabilities
complex
on success
List of ApplicationDependencyVulnerability resources

Sample:
[{'application_dependency_node_ids': [], 'gav': 'gav_example', 'is_found_in_knowledge_base': True, 'node_id': 'ocid1.node.oc1..xxxxxxEXAMPLExxxxxx', 'vulnerabilities': [{'cvss_v2_score': 3.4, 'cvss_v3_score': 3.4, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_ignored': True}]}]
 
application_dependency_node_ids
list / elements=string
on success
List of Application Dependencies on which this Application Dependency depends, each identified by its nodeId.

 
gav
string
on success
Group Artifact Version (GAV) identifier (Group:Artifact:Version), for example org.graalvm.nativeimage:svm:21.1.0.

Sample:
gav_example
 
is_found_in_knowledge_base
boolean
on success
Indicates if the artifact is found in the knowledge base.

Sample:
True
 
node_id
string
on success
Unique identifier of an Application Dependency, for example nodeId1.

Sample:
ocid1.node.oc1..xxxxxxEXAMPLExxxxxx
 
vulnerabilities
complex
on success
List of vulnerabilities for the Application Dependency.

   
cvss_v2_score
float
on success
Common Vulnerability Scoring System (CVSS) Version 2.

Sample:
3.4
   
cvss_v3_score
float
on success
Common Vulnerability Scoring System (CVSS) Version 3.

Sample:
3.4
   
id
string
on success
Unique vulnerability identifier, e.g. CVE-1999-0067.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
   
is_ignored
boolean
on success
Indicates if the vulnerability was ignored according to the audit configuration.

Sample:
True


Authors

  • Oracle (@oracle)