oracle.oci.oci_adm_vulnerability_audit – Manage a VulnerabilityAudit resource in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

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

  • For state=present, creates a new Vulnerability Audit by providing a tree of Application Dependencies.

  • This resource has the following action operations in the oracle.oci.oci_adm_vulnerability_audit_actions module: change_compartment.

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).
application_dependencies
list / elements=dictionary
List of Application Dependencies (without vulnerabilities).
application_dependency_node_ids
list / elements=string
List of Application Dependencies on which this Application Dependency depends, each identified by its nodeId.
gav
string / required
Group Artifact Version (GAV) identifier (Group:Artifact:Version), e.g. org.graalvm.nativeimage:svm:21.1.0.
node_id
string / required
Unique identifier of an Application Dependency, for example nodeId1. The nodeId can be generated by assigning a unique id to each application dependency in the tree of application dependencies. Every node, even those who share the same GAV, should have a different nodeId. The preferred way of constructing a nodeId is to assign incremental integers during a breadth first or depth first search. A nodeId can be reused only it refers to the same subtree of application dependencies. (This is not equivalent to referring to the same GAV, that is, a GAV can have multiple transitive dependencies.)
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.
build_type
string
The type of the build tool.
Required for create using state=present.
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 Oracle Cloud identifier (OCID) of the compartment associated with the Vulnerability Audit. If compartment identifier is not provided the compartment of the associated Knowledge Base will be used instead.
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.
configuration
dictionary
exclusions
list / elements=string
A vulnerable Application Dependency is ignored if its name matches any of the items in `exclusions`.
max_permissible_cvss_v2_score
float
A vulnerable Application Dependency is ignored if the score of its associated Vulnerability is below maxPermissibleCvssV2Score and below maxPermissibleCvssV3Score.
max_permissible_cvss_v3_score
float
A vulnerable Application Dependency is ignored if the score of its associated Vulnerability is below maxPermissibleCvssV2Score and below maxPermissibleCvssV3Score.
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.
display_name
string
The name of the Vulnerability Audit.
Required for create, 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"}`
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.
knowledge_base_id
string
The Oracle Cloud identifier (OCID) of the Knowledge Base.
Required for create using state=present.
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.
source
dictionary
description
string
Description of the external resource source.
Applicable when type is 'EXTERNAL_RESOURCE'
oci_resource_id
string
The Oracle Cloud identifier (OCID) of the OCI resource that triggered the Vulnerability Audit.
Required when type is 'OCI_RESOURCE'
type
string / required
    Choices:
  • UNKNOWN
  • OCI_RESOURCE
  • EXTERNAL_RESOURCE
Source type of the Vulnerability Audit.
state
string
    Choices:
  • present ←
  • absent
The state of the VulnerabilityAudit.
Use state=present to create or update a VulnerabilityAudit.
Use state=absent to delete a VulnerabilityAudit.
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
Unique Vulnerability Audit identifier path parameter.
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
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.

Examples

- name: Create vulnerability_audit
  oci_adm_vulnerability_audit:
    # required
    knowledge_base_id: "ocid1.knowledgebase.oc1..xxxxxxEXAMPLExxxxxx"
    build_type: build_type_example

    # optional
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    application_dependencies:
    - # required
      gav: gav_example
      node_id: "ocid1.node.oc1..xxxxxxEXAMPLExxxxxx"

      # optional
      application_dependency_node_ids: [ "application_dependency_node_ids_example" ]
    configuration:
      # optional
      max_permissible_cvss_v2_score: 3.4
      max_permissible_cvss_v3_score: 3.4
      exclusions: [ "exclusions_example" ]
    source:
      # required
      type: UNKNOWN
    display_name: display_name_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update vulnerability_audit
  oci_adm_vulnerability_audit:
    # required
    vulnerability_audit_id: "ocid1.vulnerabilityaudit.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    display_name: display_name_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update vulnerability_audit using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_adm_vulnerability_audit:
    # required
    display_name: display_name_example

    # optional
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Delete vulnerability_audit
  oci_adm_vulnerability_audit:
    # required
    vulnerability_audit_id: "ocid1.vulnerabilityaudit.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete vulnerability_audit using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_adm_vulnerability_audit:
    # required
    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
vulnerability_audit
complex
on success
Details of the VulnerabilityAudit resource acted upon by the current operation

Sample:
{'build_type': 'MAVEN', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'configuration': {'exclusions': [], 'max_permissible_cvss_v2_score': 3.4, 'max_permissible_cvss_v3_score': 3.4}, 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_success': True, 'knowledge_base_id': 'ocid1.knowledgebase.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'ACTIVE', 'max_observed_cvss_v2_score': 3.4, 'max_observed_cvss_v2_score_with_ignored': 3.4, 'max_observed_cvss_v3_score': 3.4, 'max_observed_cvss_v3_score_with_ignored': 3.4, 'source': {'description': 'description_example', 'oci_resource_id': 'ocid1.ociresource.oc1..xxxxxxEXAMPLExxxxxx', 'type': 'EXTERNAL_RESOURCE'}, 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'vulnerabilities': [{'cvss_v2_score': 3.4, 'cvss_v3_score': 3.4, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_ignored': True}], 'vulnerable_artifacts_count': 56, 'vulnerable_artifacts_count_with_ignored': 56}
 
build_type
string
on success
The type of the build tool.

Sample:
MAVEN
 
compartment_id
string
on success
The Oracle Cloud identifier (OCID) of the compartment associated with the Vulnerability Audit.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
configuration
complex
on success

   
exclusions
list / elements=string
on success
A vulnerable Application Dependency is ignored if its name matches any of the items in `exclusions`.
   
max_permissible_cvss_v2_score
float
on success
A vulnerable Application Dependency is ignored if the score of its associated Vulnerability is below maxPermissibleCvssV2Score and below maxPermissibleCvssV3Score.

Sample:
3.4
   
max_permissible_cvss_v3_score
float
on success
A vulnerable Application Dependency is ignored if the score of its associated Vulnerability is below maxPermissibleCvssV2Score and below maxPermissibleCvssV3Score.

Sample:
3.4
 
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'}}
 
display_name
string
on success
The name of the Vulnerability Audit.

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"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
The Oracle Cloud identifier (OCID) of the Vulnerability Audit.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
is_success
boolean
on success
Indicates if an audit succeeded according to the configuration. The value is `null` if the audit is in the `CREATING` state.

Sample:
True
 
knowledge_base_id
string
on success
The Oracle Cloud identifier (OCID) of the Knowledge Base.

Sample:
ocid1.knowledgebase.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_state
string
on success
The current lifecycle state of the Vulnerability Audit.

Sample:
ACTIVE
 
max_observed_cvss_v2_score
float
on success
Maximum Common Vulnerability Scoring System Version 2 score observed for non-ignored vulnerable Application Dependencies.

Sample:
3.4
 
max_observed_cvss_v2_score_with_ignored
float
on success
Maximum Common Vulnerability Scoring System Version 2 score observed for vulnerable Application Dependencies including ignored ones.

Sample:
3.4
 
max_observed_cvss_v3_score
float
on success
Maximum Common Vulnerability Scoring System Version 3 score observed for non-ignored vulnerable Application Dependencies.

Sample:
3.4
 
max_observed_cvss_v3_score_with_ignored
float
on success
Maximum Common Vulnerability Scoring System Version 3 score observed for vulnerable Application Dependencies including ignored ones.

Sample:
3.4
 
source
complex
on success

   
description
string
on success
Description of the external resource source.

Sample:
description_example
   
oci_resource_id
string
on success
The Oracle Cloud identifier (OCID) of the OCI resource that triggered the Vulnerability Audit.

Sample:
ocid1.ociresource.oc1..xxxxxxEXAMPLExxxxxx
   
type
string
on success
Source type of the Vulnerability Audit.

Sample:
EXTERNAL_RESOURCE
 
system_tags
dictionary
on success
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
 
time_created
string
on success
The creation date and time of the Vulnerability Audit (formatted according to RFC3339).

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The update date and time of the Vulnerability Audit (formatted according to RFC3339).

Sample:
2013-10-20T19:20:30+01:00
 
vulnerabilities
complex
on success
List of vulnerabilities found in the Vulnerability Audit.
   
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
 
vulnerable_artifacts_count
integer
on success
Count of non-ignored vulnerable Application Dependencies.

Sample:
56
 
vulnerable_artifacts_count_with_ignored
integer
on success
Count of all vulnerable Application Dependencies.

Sample:
56


Authors

  • Oracle (@oracle)