oracle.oci.oci_adm_vulnerability_audit_facts – Fetches details about one or multiple VulnerabilityAudit resources in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.2.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_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple VulnerabilityAudit resources in Oracle Cloud Infrastructure
Returns a list of Vulnerability Audits based on the specified query parameters. At least one of id, compartmentId or knowledgeBaseId query parameter must be provided.
If vulnerability_audit_id is specified, the details of a single VulnerabilityAudit will be returned.
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
|
|
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
|
A filter to return only resources that belong to the specified compartment identifier.
|
|
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 . |
|
display_name
string
|
A filter to return only resources that match the entire display name given.
aliases: name |
|
is_success
boolean
|
|
A filter to return only successful or failed Vulnerability Audits.
|
knowledge_base_id
string
|
A filter to return only Vulnerability Audits that were created against the specified knowledge base.
|
|
lifecycle_state
string
|
|
A filter to return only Vulnerability Audits that match the specified lifecycleState.
|
realm_specific_endpoint_template_enabled
boolean
|
|
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. |
|
sort_by
string
|
|
The field used to sort Vulnerability Audits. Only one sort order is allowed. Default order for _maxObservedCvssV2Score_ is **ascending**. Default order for _maxObservedCvssV3Score_ is **ascending**. Default order for _maxObservedCvssV2ScoreWithIgnored_ is **ascending**. Default order for _maxObservedCvssV3ScoreWithIgnored_ is **ascending**. Default order for _timeCreated_ is **descending**. Default order for _vulnerableArtifactsCount_ is **ascending**. Default order for _vulnerableArtifactsCountWithIgnored_ is **ascending**.
|
sort_order
string
|
|
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
|
Unique Vulnerability Audit identifier path parameter.
Required to get a specific vulnerability_audit.
aliases: id |
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Get a specific vulnerability_audit
oci_adm_vulnerability_audit_facts:
# required
vulnerability_audit_id: "ocid1.vulnerabilityaudit.oc1..xxxxxxEXAMPLExxxxxx"
- name: List vulnerability_audits
oci_adm_vulnerability_audit_facts:
# optional
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
knowledge_base_id: "ocid1.knowledgebase.oc1..xxxxxxEXAMPLExxxxxx"
is_success: true
lifecycle_state: ACTIVE
sort_order: ASC
sort_by: maxObservedCvssV2Score
display_name: display_name_example
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | ||
---|---|---|---|---|
vulnerability_audits
complex
|
on success |
List of VulnerabilityAudit resources
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 |
Returned for get operation
|
||
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 |
Returned for get operation
|
||
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.
Returned for get operation
|
||
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)