oracle.oci.oci_compute_app_catalog_subscription – Manage an AppCatalogSubscription resource in Oracle Cloud Infrastructure¶

Note

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

New in version 2.9.0: of oracle.oci

Synopsis ¶

This module allows the user to create and delete an AppCatalogSubscription resource in Oracle Cloud Infrastructure
For state=present, create a subscription for listing resource version for a compartment. It will take some time to propagate to all regions.

Requirements ¶

The below requirements are needed on the host that executes this module.

python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io

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 / required		The compartmentID for the subscription.
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`.
eula_link string		EULA link
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.
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_id string / required		The OCID of the listing.
listing_resource_version string / required		Listing resource version.
oracle_terms_of_use_link string		Oracle TOU link Required for create using state=present.
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.
signature string		A generated signature for this listing resource version retrieved the agreements API. Required for create using state=present.
state string	Choices: present ← absent	The state of the AppCatalogSubscription. Use state=present to create an AppCatalogSubscription. Use state=absent to delete an AppCatalogSubscription.
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
time_retrieved string		Date and time the agreements were retrieved, in RFC3339 format. Example: `2018-03-20T12:32:53.532Z` Required for create using state=present.

Notes ¶

Note

For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html

Examples ¶

- name: Create app_catalog_subscription
  oci_compute_app_catalog_subscription:
    # required
    oracle_terms_of_use_link: oracle_terms_of_use_link_example
    time_retrieved: time_retrieved_example
    signature: signature_example
    listing_resource_version: listing_resource_version_example
    listing_id: "ocid1.listing.oc1..xxxxxxEXAMPLExxxxxx"
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    eula_link: eula_link_example

- name: Delete app_catalog_subscription
  oci_compute_app_catalog_subscription:
    # required
    listing_resource_version: listing_resource_version_example
    listing_id: "ocid1.listing.oc1..xxxxxxEXAMPLExxxxxx"
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

Return Values ¶

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

Key		Returned	Description
app_catalog_subscription complex		on success	Details of the AppCatalogSubscription resource acted upon by the current operation Sample: {'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'display_name': 'display_name_example', 'listing_id': 'ocid1.listing.oc1..xxxxxxEXAMPLExxxxxx', 'listing_resource_id': 'ocid1.listingresource.oc1..xxxxxxEXAMPLExxxxxx', 'listing_resource_version': 'listing_resource_version_example', 'publisher_name': 'publisher_name_example', 'summary': 'summary_example', 'time_created': '2013-10-20T19:20:30+01:00'}
	compartment_id string	on success	The compartmentID of the subscription. Sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
	display_name string	on success	A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Sample: display_name_example
	listing_id string	on success	The ocid of the listing resource. Sample: ocid1.listing.oc1..xxxxxxEXAMPLExxxxxx
	listing_resource_id string	on success	Listing resource id. Sample: ocid1.listingresource.oc1..xxxxxxEXAMPLExxxxxx
	listing_resource_version string	on success	Listing resource version. Sample: listing_resource_version_example
	publisher_name string	on success	Name of the publisher who published this listing. Sample: publisher_name_example
	summary string	on success	The short summary to the listing. Sample: summary_example
	time_created string	on success	Date and time at which the subscription was created, in RFC3339 format. Example: `2018-03-20T12:32:53.532Z` Sample: 2013-10-20T19:20:30+01:00

Authors¶

Oracle (@oracle)

oracle.oci.oci_compute_app_catalog_subscription – Manage an AppCatalogSubscription resource in Oracle Cloud Infrastructure¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶