oracle.oci.oci_os_management_hub_all_software_package_facts – Fetches details about one or multiple AllSoftwarePackage resources 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_os_management_hub_all_software_package_facts.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Lists software packages available through the OS Management Hub service. Filter the list against a variety of criteria including but not limited to its name.

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).
architecture
string
    Choices:
  • I386
  • I686
  • AARCH64
  • X86_64
  • SRC
  • NOARCH
  • OTHER
A filter to return software packages that match the given architecture.
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.
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 resources that match the given user-friendly name.
display_name_contains
string
A filter to return resources that may partially match the given display name.
is_latest
boolean
    Choices:
  • no
  • yes
Indicates whether to list only the latest versions of packages, module streams, and stream profiles.
name
string
Use name along with the other options to return only resources that match the given name exactly.
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:
  • displayName
The field to sort packages by. Only one sort order may be provided. Default order for displayName is ascending. If no value is specified displayName 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
version
string
A filter to return software packages that match the given version.

Examples

- name: List all_software_packages
  oci_os_management_hub_all_software_package_facts:

    # optional
    display_name: display_name_example
    display_name_contains: display_name_contains_example
    version: version_example
    architecture: I386
    is_latest: true
    os_family: ORACLE_LINUX_9
    sort_order: ASC
    sort_by: displayName

Return Values

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

Key Returned Description
all_software_packages
complex
on success
List of AllSoftwarePackage resources

Sample:
[{'architecture': 'I386', 'checksum': 'checksum_example', 'checksum_type': 'checksum_type_example', 'display_name': 'display_name_example', 'is_latest': True, 'name': 'name_example', 'os_families': [], 'software_sources': [{'description': 'description_example', 'display_name': 'display_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_mandatory_for_autonomous_linux': True, 'software_source_type': 'VENDOR'}], 'type': 'type_example', 'version': 'version_example'}]
 
architecture
string
on success
The architecture for which this software was built.

Sample:
I386
 
checksum
string
on success
Checksum of the package.

Sample:
checksum_example
 
checksum_type
string
on success
Type of the checksum.

Sample:
checksum_type_example
 
display_name
string
on success
Package name.

Sample:
display_name_example
 
is_latest
boolean
on success
Indicates whether this package is the latest version.

Sample:
True
 
name
string
on success
Unique identifier for the package. Note that this is not an OCID.

Sample:
name_example
 
os_families
list / elements=string
on success
The OS families the package belongs to.
 
software_sources
complex
on success
List of software sources that provide the software package. This property is deprecated and it will be removed in a future API release.
   
description
string
on success
Software source description.

Sample:
description_example
   
display_name
string
on success
Software source name.

Sample:
display_name_example
   
id
string
on success
The OCID of the software source.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
   
is_mandatory_for_autonomous_linux
boolean
on success
Indicates whether this is a required software source for Autonomous Linux instances. If true, the user can't unselect it.

Sample:
True
   
software_source_type
string
on success
Type of the software source.

Sample:
VENDOR
 
type
string
on success
Type of the package.

Sample:
type_example
 
version
string
on success
Version of the package.

Sample:
version_example


Authors

  • Oracle (@oracle)