oci_app_catalog_listing_agreement - Creates an agreement for a particular app catalog listing resource version in OCI Compute Service

New in version 2.5.

Synopsis

  • This module Creates an agreement for a particular app catalog listing resource version.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
api_user
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
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
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
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
    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.
config_file_location
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
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_id
required
The OCID of the listing.

aliases: id
region
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.
resource_version
required
Listing Resource Version.

aliases: version
state
    Choices:
  • present ←
Create an app catalog listing agreement.
tenancy
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: Create an agreement for a particular app catalog listing resource version
  oci_app_catalog_listing_agreement:
    listing_id: ocid1.appcataloglisting.oc1..xxxxxEXAMPLExxxxx
    resource_version: "1.0.0"

Return Values

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

Key Returned Description
app_catalog_listing_agreement
complex
always
Agreement for a listing resource version

Sample:
{'time_retrieved': '2019-02-14T19:53:30.878000+00:00', 'listing_id': 'ocid1.appcataloglisting.oc1..xxxxxEXAMPLExxxxx', 'listing_resource_version': '1.0.0', 'signature': 'xxxxxxxxxxxexamplesignaturexxxxxxxxxxxxxxx', 'eula_link': 'https://objectstorage.region.oraclecloud.com/n/partnerimagecatalog/b/eulas/o/xxxxxx/xxxxxxx/eula.txt', 'oracle_terms_of_use_link': 'https://objectstorage.region.oraclecloud.com/n/partnerimagecatalog/b/eulas/o/oracle-terms-of-use.txt'}
  time_retrieved
string
always
Date and time the agreements were retrieved, in RFC3339 format.

Sample:
2019-02-14 19:53:30.878000
  listing_id
string
always
The ocid of the listing resource.

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

Sample:
1.0.0
  signature
string
always
A generated signature for this agreement retrieval operation which should be used in the create subscription call.

Sample:
xxxxxxxxxxxexamplesignaturexxxxxxxxxxxxxxx
  eula_link
string
always
EULA link.

Sample:
https://objectstorage.region.oraclecloud.com/n/partnerimagecatalog/b/eulas/o/xxxxxx/xxxxxxx/eula.txt
  oracle_terms_of_use_link
string
always
Oracle TOU link.

Sample:
https://objectstorage.region.oraclecloud.com/n/partnerimagecatalog/b/eulas/o/oracle-terms-of-use.txt


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • Manoj Meda (@manojmeda)

Hint

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