oracle.oci.oci_os_management_software_package_search_facts – Fetches details about one or multiple SoftwarePackageSearch resources in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Searches all of the available Software Sources and returns any/all Software Packages matching the search criteria.

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.
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.
cve_name
string
The name of the CVE as published. Example: `CVE-2006-4535`
display_name
string
A user-friendly name. Does not have to be unique, and it's changeable.
Example: `My new resource`
name
string
Use name along with the other options to return only resources that match the given name exactly.
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 identifier for the software package (not an OCID)
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: List software_package_searches
  oci_os_management_software_package_search_facts:

    # optional
    software_package_name: software_package_name_example
    display_name: display_name_example
    cve_name: cve_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_package_searches
complex
on success
List of SoftwarePackageSearch resources

Sample:
[{'advisory_type': 'SECURITY', 'architecture': 'architecture_example', 'display_name': 'display_name_example', 'errata': [{'display_name': 'display_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx'}], 'name': 'name_example', 'software_sources': [{'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'name': 'name_example'}], 'summary': 'summary_example', 'type': 'type_example', 'version': 'version_example'}]
 
advisory_type
string
on success
Type of the erratum.

Sample:
SECURITY
 
architecture
string
on success
the architecture for which this software was built

Sample:
architecture_example
 
display_name
string
on success
Package name

Sample:
display_name_example
 
errata
complex
on success
List of errata containing this software package

   
display_name
string
on success
User friendly name

Sample:
display_name_example
   
id
string
on success
unique identifier that is immutable on creation

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
name
string
on success
Unique identifier for the package. NOTE - This is not an OCID

Sample:
name_example
 
software_sources
complex
on success
list of software sources that provide the software package

   
id
string
on success
software source identifier

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

Sample:
name_example
 
summary
string
on success
a summary description of the software package

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