Skip to content
This repository has been archived by the owner on May 1, 2021. It is now read-only.

Latest commit

 

History

History
474 lines (426 loc) · 30.4 KB

oci_app_catalog_subscription_module.rst

File metadata and controls

474 lines (426 loc) · 30.4 KB
Raw
source

cloud/oracle/oci_app_catalog_subscription.py

orphan

oci_app_catalog_subscription -- Manage app catalog subscriptions in OCI

2.5

Synopsis

  • This module allows the user to create, delete app catalog subscriptions in OCI. When created, it will take some time to propagate to all regions.

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_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
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.
eula_link
-
EULA link. Required if the listing_resource_version has one.
listing_id
- / required
The OCID of the listing.
listing_resource_version
- / required
Listing resource version.
oracle_terms_of_use_link
-
Oracle TOU link. Required for creating an app catalog subscription with 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
-
A generated signature for this listing resource version retrieved the agreements API. Required when state=present.
state
-
    Choices:
  • present ←
  • absent
Create an app catalog subscription when state=present. Use state=absent to delete a subscription.
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
-
Date and time the agreements were retrieved, in RFC3339 format. Required when state=present.

Notes

Examples

- name: Create a subscription
  oci_app_catalog_subscription:
    compartment_id: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
    eula_link: "https://objectstorage.region.oraclecloud.com/n/partnerimagecatalog/b/eulas/o/xxxxxx/xxxxxxx/eula.txt"
    listing_id: ocid1.appcataloglisting.oc1..xxxxxEXAMPLExxxxx
    listing_resource_version: "1.0.0"
    oracle_terms_of_use_link: "https://objectstorage.region.oraclecloud.com/n/partnerimagecatalog/b/eulas/o/oracle-terms-of-use.txt"
    signature: "xxxxxxxxxxxxxxexamplesignaturexxxxxxxxxxxx"
    time_retrieved: 2019-02-14T19:53:30.878Z
- name: Delete a subscription
  oci_app_catalog_subscription:
    listing_id: ocid1.appcataloglisting.oc1..xxxxxEXAMPLExxxxx
    compartment_id: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
    listing_resource_version: "1.0.0"
    state: absent

Return Values

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

Key Returned Description
app_catalog_subscription
complex
 on success
Information about the app catalog subscription. Applicable only for create.

Sample:
{'listing_resource_version': '1.0.0', 'listing_id': 'ocid1.appcataloglisting.oc1..xxxxxEXAMPLExxxxx', 'publisher_name': 'Test Publisher', 'summary': 'Test app catalog listing', 'listing_resource_id': 'ocid1.image.oc1..xxxxxEXAMPLExxxxx', 'display_name': 'Test app catalog', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'time_created': '2019-02-14T19:53:30.878000+00:00'}
  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+00:00


Status

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

Authors

  • Manoj Meda (@manojmeda)

Hint

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