oracle.oci.oci_marketplace_listing_facts – Fetches details about one or multiple Listing resources in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Gets a list of listings from Oracle Cloud Infrastructure Marketplace by searching keywords and filtering according to listing attributes.

  • If you plan to launch an instance from an image listing, you must first subscribe to the listing. When you launch the instance, you also need to provide the image ID of the listing resource version that you want.

  • Subscribing to the listing requires you to first get a signature from the terms of use agreement for the listing resource version. To get the signature, issue a GetAppCatalogListingAgreements API call. The AppCatalogListingResourceVersionAgreements object, including its signature, is returned in the response. With the signature for the terms of use agreement for the desired listing resource version, create a subscription by issuing a CreateAppCatalogSubscription API call.

  • To get the image ID to launch an instance, issue a GetAppCatalogListingResourceVersion API call. Lastly, to launch the instance, use the image ID of the listing resource version to issue a LaunchInstance API call.

  • If listing_id is specified, the details of a single Listing 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.
category
list / elements=string
Name of the product category or categories. If you specify multiple categories, then Marketplace returns any listing with one or more matching categories.
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 unique identifier for the 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.
image_id
string
The image identifier of the listing.
is_featured
boolean
    Choices:
  • no
  • yes
Indicates whether to show only featured listings. If this is set to `false` or is omitted, then all listings will be returned.
listing_id
string
The unique identifier for the listing.
Required to get a specific listing.

aliases: id
listing_types
list / elements=string
    Choices:
  • COMMUNITY
  • PARTNER
  • PRIVATE
The type of the listing.
name
list / elements=string
The name of the listing.
operating_systems
list / elements=string
The operating system of the listing.
package_type
string
A filter to return only packages that match the given package type exactly.
pricing
list / elements=string
    Choices:
  • FREE
  • BYOL
  • PAYGO
Name of the pricing type. If multiple pricing types are provided, then any listing with one or more matching pricing models will be returned.
publisher_id
string
Limit results to just this publisher.
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:
  • TIMERELEASED
The field to use to sort listed results. You can only specify one field to sort by. `TIMERELEASED` displays results in descending order by default. You can change your preference by specifying a different sort order.
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 listing
  oci_marketplace_listing_facts:
    # required
    listing_id: "ocid1.listing.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

- name: List listings
  oci_marketplace_listing_facts:

    # optional
    name: [ "name_example" ]
    listing_id: "ocid1.listing.oc1..xxxxxxEXAMPLExxxxxx"
    image_id: "ocid1.image.oc1..xxxxxxEXAMPLExxxxxx"
    publisher_id: "ocid1.publisher.oc1..xxxxxxEXAMPLExxxxxx"
    package_type: package_type_example
    sort_by: TIMERELEASED
    sort_order: ASC
    category: [ "category_example" ]
    pricing: [ "FREE" ]
    is_featured: true
    listing_types: [ "COMMUNITY" ]
    operating_systems: [ "operating_systems_example" ]
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

Return Values

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

Key Returned Description
listings
complex
on success
List of Listing resources

Sample:
[{'banner': {'content_url': 'content_url_example', 'file_extension': 'file_extension_example', 'mime_type': 'mime_type_example', 'name': 'name_example'}, 'categories': [], 'compatible_architectures': [], 'default_package_version': 'default_package_version_example', 'documentation_links': [{'document_category': 'document_category_example', 'name': 'name_example', 'url': 'url_example'}], 'icon': {'content_url': 'content_url_example', 'file_extension': 'file_extension_example', 'mime_type': 'mime_type_example', 'name': 'name_example'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_featured': True, 'is_rover_exportable': True, 'keywords': 'keywords_example', 'languages': [{'code': 'code_example', 'name': 'name_example'}], 'license_model_description': 'license_model_description_example', 'links': [{'href': 'href_example', 'rel': 'SELF'}], 'listing_type': 'COMMUNITY', 'long_description': 'long_description_example', 'name': 'name_example', 'package_type': 'ORCHESTRATION', 'pricing_types': [], 'publisher': {'contact_email': 'contact_email_example', 'contact_phone': 'contact_phone_example', 'description': 'description_example', 'hq_address': 'hq_address_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'links': [{'href': 'href_example', 'rel': 'SELF'}], 'logo': {'content_url': 'content_url_example', 'file_extension': 'file_extension_example', 'mime_type': 'mime_type_example', 'name': 'name_example'}, 'name': 'name_example', 'website_url': 'website_url_example', 'year_founded': 56}, 'regions': [{'code': 'code_example', 'countries': [{'code': 'code_example', 'name': 'name_example'}], 'name': 'name_example'}], 'release_notes': 'release_notes_example', 'screenshots': [{'content_url': 'content_url_example', 'description': 'description_example', 'file_extension': 'file_extension_example', 'mime_type': 'mime_type_example', 'name': 'name_example'}], 'short_description': 'short_description_example', 'support_contacts': [{'email': 'email_example', 'name': 'name_example', 'phone': 'phone_example', 'subject': 'subject_example'}], 'support_links': [{'name': 'name_example', 'url': 'url_example'}], 'supported_operating_systems': [{'name': 'name_example'}], 'system_requirements': 'system_requirements_example', 'tagline': 'tagline_example', 'time_released': '2013-10-20T19:20:30+01:00', 'usage_information': 'usage_information_example', 'version': 'version_example', 'videos': [{'name': 'name_example', 'url': 'url_example'}]}]
 
banner
complex
on success
Returned for get operation

   
content_url
string
on success
The content URL of the upload data.

Sample:
content_url_example
   
file_extension
string
on success
The file extension of the upload data.

Sample:
file_extension_example
   
mime_type
string
on success
The MIME type of the upload data.

Sample:
mime_type_example
   
name
string
on success
The name used to refer to the upload data.

Sample:
name_example
 
categories
list / elements=string
on success
Categories that the listing belongs to.

 
compatible_architectures
list / elements=string
on success
The list of compatible architectures supported by the listing

 
default_package_version
string
on success
The default package version.
Returned for get operation

Sample:
default_package_version_example
  documentation_links
complex
on success
Links to additional documentation provided by the publisher specifically for the listing.
Returned for get operation

   
document_category
string
on success
The category that the document belongs to.

Sample:
document_category_example
   
name
string
on success
Text that describes the resource.

Sample:
name_example
   
url
string
on success
The URL of the resource.

Sample:
url_example
 
icon
complex
on success

   
content_url
string
on success
The content URL of the upload data.

Sample:
content_url_example
   
file_extension
string
on success
The file extension of the upload data.

Sample:
file_extension_example
   
mime_type
string
on success
The MIME type of the upload data.

Sample:
mime_type_example
   
name
string
on success
The name used to refer to the upload data.

Sample:
name_example
 
id
string
on success
The unique identifier for the listing in Marketplace.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
  is_featured
boolean
on success
Indicates whether the listing is included in Featured Listings.

Sample:
True
 
is_rover_exportable
boolean
on success
True if this application is Rover exportable
Returned for list operation

Sample:
True
 
keywords
string
on success
Keywords associated with the listing.
Returned for get operation

Sample:
keywords_example
 
languages
complex
on success
Languages supported by the listing.
Returned for get operation

   
code
string
on success
A code assigned to the item.

Sample:
code_example
   
name
string
on success
The name of the item.

Sample:
name_example
 
license_model_description
string
on success
A description of the publisher's licensing model for the listing.
Returned for get operation

Sample:
license_model_description_example
  links
complex
on success
Links to reference material.
Returned for get operation

   
href
string
on success
The anchor tag.

Sample:
href_example
   
rel
string
on success
Reference links to the previous page, next page, and other pages.

Sample:
SELF
 
listing_type
string
on success
The publisher category to which the listing belongs. The publisher category informs where the listing appears for use.

Sample:
COMMUNITY
 
long_description
string
on success
A long description of the listing.
Returned for get operation

Sample:
long_description_example
 
name
string
on success
The name of the listing.

Sample:
name_example
 
package_type
string
on success
The listing's package type.

Sample:
ORCHESTRATION
 
pricing_types
list / elements=string
on success
Summary of the pricing types available across all packages in the listing.
Returned for list operation

 
publisher
complex
on success

   
contact_email
string
on success
The email address of the publisher.

Sample:
contact_email_example
   
contact_phone
string
on success
The phone number of the publisher.

Sample:
contact_phone_example
   
description
string
on success
A description of the publisher.

Sample:
description_example
   
hq_address
string
on success
The address of the publisher's headquarters.

Sample:
hq_address_example
   
id
string
on success
Unique identifier for the publisher.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
    links
complex
on success
Reference links.

     
href
string
on success
The anchor tag.

Sample:
href_example
     
rel
string
on success
Reference links to the previous page, next page, and other pages.

Sample:
SELF
    logo
complex
on success

     
content_url
string
on success
The content URL of the upload data.

Sample:
content_url_example
     
file_extension
string
on success
The file extension of the upload data.

Sample:
file_extension_example
     
mime_type
string
on success
The MIME type of the upload data.

Sample:
mime_type_example
     
name
string
on success
The name used to refer to the upload data.

Sample:
name_example
   
name
string
on success
The name of the publisher.

Sample:
name_example
   
website_url
string
on success
The publisher's website.

Sample:
website_url_example
   
year_founded
integer
on success
The year the publisher's company or organization was founded.

Sample:
56
 
regions
complex
on success
The regions where you can deploy the listing. (Some listings have restrictions that limit their deployment to United States regions only.)

   
code
string
on success
The code of the region.

Sample:
code_example
   
countries
complex
on success
Countries in the region.

     
code
string
on success
A code assigned to the item.

Sample:
code_example
     
name
string
on success
The name of the item.

Sample:
name_example
   
name
string
on success
The name of the region.

Sample:
name_example
 
release_notes
string
on success
Release notes for the listing.
Returned for get operation

Sample:
release_notes_example
 
screenshots
complex
on success
Screenshots of the listing.
Returned for get operation

   
content_url
string
on success
The content URL of the screenshot.

Sample:
content_url_example
   
description
string
on success
A description of the screenshot.

Sample:
description_example
   
file_extension
string
on success
The file extension of the screenshot.

Sample:
file_extension_example
   
mime_type
string
on success
The MIME type of the screenshot.

Sample:
mime_type_example
   
name
string
on success
The name of the screenshot.

Sample:
name_example
 
short_description
string
on success
A short description of the listing.

Sample:
short_description_example
 
support_contacts
complex
on success
Contact information to use to get support from the publisher for the listing.
Returned for get operation

   
email
string
on success
The email of the contact.

Sample:
email_example
   
name
string
on success
The name of the contact.

Sample:
name_example
   
phone
string
on success
The phone number of the contact.

Sample:
phone_example
   
subject
string
on success
The email subject line to use when contacting support.

Sample:
subject_example
  support_links
complex
on success
Links to support resources for the listing.
Returned for get operation

   
name
string
on success
Text that describes the resource.

Sample:
name_example
   
url
string
on success
The URL of the resource.

Sample:
url_example
 
supported_operating_systems
complex
on success
List of operating systems supported by the listing.

   
name
string
on success
The name of the operating system.

Sample:
name_example
 
system_requirements
string
on success
System requirements for the listing.
Returned for get operation

Sample:
system_requirements_example
 
tagline
string
on success
The tagline of the listing.

Sample:
tagline_example
 
time_released
string
on success
The release date of the listing.
Returned for get operation

Sample:
2013-10-20T19:20:30+01:00
 
usage_information
string
on success
Usage information for the listing.
Returned for get operation

Sample:
usage_information_example
 
version
string
on success
The version of the listing.
Returned for get operation

Sample:
version_example
 
videos
complex
on success
Videos of the listing.
Returned for get operation

   
name
string
on success
Text that describes the resource.

Sample:
name_example
   
url
string
on success
The URL of the resource.

Sample:
url_example


Authors

  • Oracle (@oracle)