oracle.oci.oci_os_management_software_package_facts – Fetches details about one or multiple SoftwarePackage 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_os_management_software_package_facts.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Lists Software Packages in a Software Source

  • If software_package_name is specified, the details of a single SoftwarePackage will be returned.

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.
compartment_id
string
The ID of the compartment in which to list resources. This parameter is optional and in some cases may have no effect.
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 user-friendly name. Does not have to be unique, and it's changeable.
Example: `My new resource`
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.
software_package_name
string
The id of the software package.
Required to get a specific software_package.
software_source_id
string / required
The OCID of the software source.
sort_by
string
    Choices:
  • TIMECREATED
  • DISPLAYNAME
The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED 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

Examples

- name: Get a specific software_package
  oci_os_management_software_package_facts:
    # required
    software_package_name: software_package_name_example
    software_source_id: "ocid1.softwaresource.oc1..xxxxxxEXAMPLExxxxxx"

- name: List software_packages
  oci_os_management_software_package_facts:
    # required
    software_source_id: "ocid1.softwaresource.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    sort_order: ASC
    sort_by: TIMECREATED

Return Values

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

Key Returned Description
software_packages
complex
on success
List of SoftwarePackage resources

Sample:
[{'architecture': 'architecture_example', 'checksum': 'checksum_example', 'checksum_type': 'checksum_type_example', 'dependencies': [{'dependency': 'dependency_example', 'dependency_modifier': 'dependency_modifier_example', 'dependency_type': 'dependency_type_example'}], 'description': 'description_example', 'display_name': 'display_name_example', 'files': [{'checksum': 'checksum_example', 'checksum_type': 'checksum_type_example', 'path': 'path_example', 'size_in_bytes': 56, 'time_modified': '2013-10-20T19:20:30+01:00', 'type': 'type_example'}], 'last_modified_date': 'last_modified_date_example', 'name': 'name_example', 'size_in_bytes': 56, 'software_sources': [{'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'name': 'name_example'}], 'type': 'type_example', 'version': 'version_example'}]
 
architecture
string
on success
the architecture for which this software was built

Sample:
architecture_example
 
checksum
string
on success
checksum of the package

Sample:
checksum_example
 
checksum_type
string
on success
type of the checksum

Sample:
checksum_type_example
 
dependencies
complex
on success
list of dependencies for the software package
Returned for get operation

   
dependency
string
on success
the software package's dependency

Sample:
dependency_example
   
dependency_modifier
string
on success
the modifier for the dependency

Sample:
dependency_modifier_example
   
dependency_type
string
on success
the type of the dependency

Sample:
dependency_type_example
 
description
string
on success
description of the package
Returned for get operation

Sample:
description_example
 
display_name
string
on success
Package name

Sample:
display_name_example
 
files
complex
on success
list of files for the software package
Returned for get operation

   
checksum
string
on success
checksum of the file

Sample:
checksum_example
   
checksum_type
string
on success
type of the checksum

Sample:
checksum_type_example
   
path
string
on success
file path

Sample:
path_example
   
size_in_bytes
integer
on success
size of the file in bytes

Sample:
56
   
time_modified
string
on success
The date and time of the last modification to this file, as described in RFC 3339, section 14.29.

Sample:
2013-10-20T19:20:30+01:00
   
type
string
on success
type of the file

Sample:
type_example
 
last_modified_date
string
on success
date of the last update to the package
Returned for get operation

Sample:
last_modified_date_example
 
name
string
on success
Unique identifier for the package. NOTE - This is not an OCID

Sample:
name_example
 
size_in_bytes
integer
on success
size of the package in bytes
Returned for get operation

Sample:
56
 
software_sources
complex
on success
list of software sources that provide the software package
Returned for get operation

   
id
string
on success
software source identifier

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
   
name
string
on success
software source name

Sample:
name_example
 
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)