oracle.oci.oci_marketplace_publication_facts – Fetches details about one or multiple Publication 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_marketplace_publication_facts.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Lists the publications in the specified compartment.

  • If publication_id is specified, the details of a single Publication 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 unique identifier for the compartment.
Required to list multiple publications.
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.
listing_type
string
    Choices:
  • COMMUNITY
  • PARTNER
  • PRIVATE
The type of the listing.
Required to list multiple publications.
name
list / elements=string
The name of the publication.
operating_systems
list / elements=string
The operating system of the listing.
publication_id
string
The unique identifier for the publication.
Required to get a specific publication.

aliases: id
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 publication
  oci_marketplace_publication_facts:
    # required
    publication_id: "ocid1.publication.oc1..xxxxxxEXAMPLExxxxxx"

- name: List publications
  oci_marketplace_publication_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    listing_type: COMMUNITY

    # optional
    name: [ "name_example" ]
    publication_id: "ocid1.publication.oc1..xxxxxxEXAMPLExxxxxx"
    operating_systems: [ "operating_systems_example" ]
    sort_by: TIMERELEASED
    sort_order: ASC

Return Values

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

Key Returned Description
publications
complex
on success
List of Publication resources

Sample:
[{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'freeform_tags': {'Department': 'Finance'}, 'icon': {'content_url': 'content_url_example', 'file_extension': 'file_extension_example', 'mime_type': 'mime_type_example', 'name': 'name_example'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'CREATING', 'listing_type': 'COMMUNITY', 'long_description': 'long_description_example', 'name': 'name_example', 'package_type': 'ORCHESTRATION', 'short_description': 'short_description_example', 'support_contacts': [{'email': 'email_example', 'name': 'name_example', 'phone': 'phone_example', 'subject': 'subject_example'}], 'supported_operating_systems': [{'name': 'name_example'}], 'time_created': '2013-10-20T19:20:30+01:00'}]
 
compartment_id
string
on success
The OCID of the compartment where the publication exists.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
defined_tags
dictionary
on success
The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}`
Returned for get operation

Sample:
{'Operations': {'CostCenter': 'US'}}
 
freeform_tags
dictionary
on success
The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{"Department": "Finance"}`
Returned for get operation

Sample:
{'Department': 'Finance'}
 
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 publication in Marketplace.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_state
string
on success
The lifecycle state of the publication.

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

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

Sample:
long_description_example
 
name
string
on success
The name of the publication, which is also used in the listing.

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

Sample:
ORCHESTRATION
 
short_description
string
on success
A short description of the publication to use in the listing.

Sample:
short_description_example
 
support_contacts
complex
on success
Contact information for getting 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
 
supported_operating_systems
complex
on success
The list of operating systems supprted by the listing.

   
name
string
on success
The name of the operating system.

Sample:
name_example
 
time_created
string
on success
The date and time the publication was created, expressed in RFC 3339 timestamp format.
Example: `2016-08-25T21:10:29.600Z`

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


Authors

  • Oracle (@oracle)