oracle.oci.oci_os_management_hub_erratum_facts – Fetches details about one or multiple Erratum resources 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_os_management_hub_erratum_facts.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Lists all of the currently available errata. Filter the list against a variety of criteria including but not limited to its name, classification type, advisory severity, and OS family.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
advisory_severity
list / elements=string
    Choices:
  • LOW
  • MODERATE
  • IMPORTANT
  • CRITICAL
The advisory severity.
advisory_type
list / elements=string
    Choices:
  • SECURITY
  • BUGFIX
  • ENHANCEMENT
A filter to return only errata that match the given advisory types.
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.
classification_type
list / elements=string
    Choices:
  • SECURITY
  • BUGFIX
  • ENHANCEMENT
  • OTHER
A filter to return only packages that match the given update classification type.
compartment_id
string / required
The OCID of the compartment. This parameter is required and returns only resources contained within the specified compartment.
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.
name
list / elements=string
The assigned erratum name. It's unique and not changeable.
Example: `ELSA-2020-5804`
name_contains
string
A filter to return resources that may partially match the erratum name given.
os_family
string
    Choices:
  • ORACLE_LINUX_9
  • ORACLE_LINUX_8
  • ORACLE_LINUX_7
  • ORACLE_LINUX_6
  • WINDOWS_SERVER_2016
  • WINDOWS_SERVER_2019
  • WINDOWS_SERVER_2022
  • ALL
A filter to return only resources that match the given operating system family.
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.
sort_by
string
    Choices:
  • timeIssued
  • name
The field to sort errata by. Only one sort order may be provided. Default order for timeIssued is descending. Default order for name is ascending. If no value is specified timeIssued is default.
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
time_issue_date_end
string
The issue date before which to list all errata, in ISO 8601 format
Example: 2017-07-14T02:40:00.000Z
time_issue_date_start
string
The issue date after which to list all errata, in ISO 8601 format
Example: 2017-07-14T02:40:00.000Z

Examples

- name: List erratums
  oci_os_management_hub_erratum_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    name: [ "name_example" ]
    name_contains: name_contains_example
    classification_type: [ "SECURITY" ]
    advisory_type: [ "SECURITY" ]
    os_family: ORACLE_LINUX_9
    advisory_severity: [ "LOW" ]
    time_issue_date_start: 2013-10-20T19:20:30+01:00
    time_issue_date_end: 2013-10-20T19:20:30+01:00
    sort_order: ASC
    sort_by: timeIssued

Return Values

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

Key Returned Description
erratums
complex
on success
List of Erratum resources

Sample:
[{'advisory_severity': 'LOW', 'advisory_type': 'SECURITY', 'classification_type': 'SECURITY', 'name': 'name_example', 'os_families': [], 'related_cves': [], 'synopsis': 'synopsis_example', 'time_issued': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}]
 
advisory_severity
string
on success
The severity advisory. Only valid for security type advisories.

Sample:
LOW
 
advisory_type
string
on success
The advisory type of the erratum.

Sample:
SECURITY
 
classification_type
string
on success
Type of the erratum. This property is deprecated and it will be removed in a future API release. Please refer to the advisoryType property instead.

Sample:
SECURITY
 
name
string
on success
Advisory name.

Sample:
name_example
 
os_families
list / elements=string
on success
List of affected OS families.
 
related_cves
list / elements=string
on success
List of CVEs applicable to this erratum.
 
synopsis
string
on success
Summary description of the erratum.

Sample:
synopsis_example
 
time_issued
string
on success
The date and time the erratum was issued (in RFC 3339 format).

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The date and time the erratum was updated (in RFC 3339 format).

Sample:
2013-10-20T19:20:30+01:00


Authors

  • Oracle (@oracle)