oracle.oci.oci_marketplace_publication – Manage a Publication resource 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.

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create, update and delete a Publication resource in Oracle Cloud Infrastructure

  • For state=present, creates a publication of the specified listing type with an optional default package.

  • This resource has the following action operations in the oracle.oci.oci_marketplace_publication_actions module: change_compartment.

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 OCID of the compartment where you want to create the publication.
Required for create using state=present.
Required for update when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
Required for delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
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.
defined_tags
dictionary
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"}}`
This parameter is updatable.
force_create
boolean
    Choices:
  • no ←
  • yes
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
freeform_tags
dictionary
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"}`
This parameter is updatable.
is_agreement_acknowledged
boolean
    Choices:
  • no
  • yes
Whether the publisher acknowledged that they have the right and authority to share the contents of the publication and that they accepted the Oracle terms of use agreements required to create a publication.
Required for create using state=present.
key_by
list / elements=string
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
listing_type
string
    Choices:
  • COMMUNITY
  • PARTNER
  • PRIVATE
The publisher category to which the publication belongs. The publisher category informs where the listing appears for use.
Required for create using state=present.
Required for update when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
Required for delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
long_description
string
A long description of the publication to use in the listing.
This parameter is updatable.
name
string
The name of the publication, which is also used in the listing.
Required for create using state=present.
Required for update, delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
This parameter is updatable when OCI_USE_NAME_AS_IDENTIFIER is not set.
package_details
dictionary
Required for create using state=present.
eula
list / elements=dictionary / required
The end user license agreeement (EULA) that consumers of this listing must accept.
eula_type
string / required
    Choices:
  • TEXT
The end user license agreement's type.
license_text
string
The text of the end user license agreement.
image_id
string
The unique identifier for the base image of the publication.
operating_system
dictionary / required
name
string
The name of the operating system.
package_type
string / required
    Choices:
  • IMAGE
The package's type.
package_version
string / required
The package version.
publication_id
string
The unique identifier for the publication.
Required for update using state=present when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.
Required for delete using state=absent when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.

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.
short_description
string
A short description of the publication to use in the listing.
Required for create using state=present.
This parameter is updatable.
state
string
    Choices:
  • present ←
  • absent
The state of the Publication.
Use state=present to create or update a Publication.
Use state=absent to delete a Publication.
support_contacts
list / elements=dictionary
Contact information for getting support from the publisher for the listing.
Required for create using state=present.
This parameter is updatable.
email
string
The email of the contact.
name
string
The name of the contact.
phone
string
The phone number of the contact.
subject
string
The email subject line to use when contacting support.
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
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Examples

- name: Create publication
  oci_marketplace_publication:
    # required
    listing_type: COMMUNITY
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    package_details:
      # required
      package_version: package_version_example
      package_type: IMAGE
      operating_system:
        # optional
        name: name_example
      eula:
      - # required
        eula_type: TEXT

        # optional
        license_text: license_text_example

        # optional
      image_id: "ocid1.image.oc1..xxxxxxEXAMPLExxxxxx"
    is_agreement_acknowledged: true
    name: name_example
    short_description: short_description_example
    support_contacts:
    - # optional
      name: name_example
      phone: phone_example
      email: email_example
      subject: subject_example

    # optional
    long_description: long_description_example
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    freeform_tags: {'Department': 'Finance'}

- name: Update publication
  oci_marketplace_publication:
    # required
    publication_id: "ocid1.publication.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    name: name_example
    short_description: short_description_example
    long_description: long_description_example
    support_contacts:
    - # optional
      name: name_example
      phone: phone_example
      email: email_example
      subject: subject_example
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    freeform_tags: {'Department': 'Finance'}

- name: Update publication using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_marketplace_publication:
    # required
    listing_type: COMMUNITY
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    name: name_example

    # optional
    short_description: short_description_example
    long_description: long_description_example
    support_contacts:
    - # optional
      name: name_example
      phone: phone_example
      email: email_example
      subject: subject_example
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    freeform_tags: {'Department': 'Finance'}

- name: Delete publication
  oci_marketplace_publication:
    # required
    publication_id: "ocid1.publication.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete publication using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_marketplace_publication:
    # required
    listing_type: COMMUNITY
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    name: name_example
    state: absent

Return Values

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

Key Returned Description
publication
complex
on success
Details of the Publication resource acted upon by the current operation

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"}}`

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"}`

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.

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.
   
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)