oci_app_catalog_subscription_facts – Retrieve details about App Catalog subscriptions in OCI Compute Service

New in version 2.5.

Synopsis

  • This module retrieves information of app catalog subscriptions in the specified 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_OCID 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_type
string
    Choices:
  • api_key ←
  • instance_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.
compartment_id
- / required
The OCID of 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.
display_name
string
Use display_name along with the other options to return only resources that match the given display name exactly.
listing_id
-
The OCID of the listing.
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.
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 all the app catalog subscriptions in the specified compartment
  oci_app_catalog_subscription_facts:
    compartment_id: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
- name: Get the app catalog subscriptions for a specific listing in a compartment
  oci_app_catalog_subscription_facts:
    compartment_id: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
    listing_id: ocid1.appcataloglisting.oc1..xxxxxEXAMPLExxxxx
- name: Get the app catalog subscriptions having the given display name in a compartment
  oci_app_catalog_subscription_facts:
    compartment_id: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
    display_name: Test app catalog listing

Return Values

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

Key Returned Description
app_catalog_subscriptions
complex
always
List of app catalog subscriptions

Sample:
[{'listing_id': 'ocid1.appcataloglisting.oc1..xxxxxEXAMPLExxxxx', 'display_name': 'Test app catalog', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'listing_resource_version': '1.0.0', 'time_created': '2019-02-14T19:53:30.878000+00:00', 'summary': 'Test app catalog listing', 'listing_resource_id': 'ocid1.image.oc1..xxxxxEXAMPLExxxxx', 'publisher_name': 'Test Publisher'}]
  compartment_id
string
always
The compartmentID of the subscription.

Sample:
ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
  display_name
string
always
The display name of the listing.

Sample:
Test app catalog
  listing_id
string
always
The ocid of the listing resource.

Sample:
ocid1.appcataloglisting.oc1..xxxxxEXAMPLExxxxx
  listing_resource_id
string
always
Listing resource id.

Sample:
ocid1.image.oc1..xxxxxEXAMPLExxxxx
  listing_resource_version
string
always
Listing resource version.

Sample:
1.0.0
  publisher_name
string
always
Name of the publisher who published this listing.

Sample:
Test Publisher
  summary
string
always
Summary of the listing.

Sample:
Test app catalog listing
  time_created
string
always
Date and time at which the subscription was created, in RFC3339 format.

Sample:
2019-02-14 19:53:30.878000


Status

  • This module is not guaranteed to have a backwards compatible interface. [preview]
  • This module is maintained by the Ansible Community. [community]

Authors

  • Manoj Meda (@manojmeda)

Hint

If you notice any issues in this documentation you can edit this document to improve it.