oracle / oracle.oci / 4.32.0 / module / oci_compute_app_catalog_subscription Manage an AppCatalogSubscription resource in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_compute_app_catalog_subscription (4.32.0) — module
Install with ansible-galaxy collection install oracle.oci:==4.32.0
collections: - name: oracle.oci version: 4.32.0
This module allows the user to create and delete an AppCatalogSubscription resource in Oracle Cloud Infrastructure
For I(state=present), create a subscription for listing resource version for a compartment. It will take some time to propagate to all regions.
- 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
state: choices: - present - absent default: present description: - The state of the AppCatalogSubscription. - Use I(state=present) to create an AppCatalogSubscription. - Use I(state=absent) to delete an AppCatalogSubscription. required: false type: str key_by: description: 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. elements: str type: list region: description: - 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 C(config_file_location)). Please refer to U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm) for more information on OCI regions. type: str tenancy: description: - 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 C(config_file_location)). To get the tenancy OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm) type: str api_user: description: - 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 C(config_file_location)). To get the user's OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). type: str auth_type: choices: - api_key - instance_principal - instance_obo_user - resource_principal - security_token default: api_key description: - The type of authentication to use for making API requests. By default C(auth_type="api_key") based authentication is performed and the API key (see I(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 C(auth_type="instance_principal") to use instance principal based authentication when running ansible playbooks within an OCI compute instance. type: str eula_link: description: - EULA link type: str signature: description: - A generated signature for this listing resource version retrieved the agreements API. - Required for create using I(state=present). type: str listing_id: description: - The OCID of the listing. required: true type: str cert_bundle: description: - 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. type: str auth_purpose: choices: - service_principal description: - The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None. type: str force_create: default: false description: 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 I(key_by). type: bool compartment_id: description: - The compartmentID for the subscription. required: true type: str time_retrieved: description: - 'Date and time the agreements were retrieved, in L(RFC3339,https://tools.ietf.org/html/rfc3339) format. Example: `2018-03-20T12:32:53.532Z`' - Required for create using I(state=present). type: str api_user_key_file: description: - 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 C(config_file_location)). If the key is encrypted with a pass-phrase, the C(api_user_key_pass_phrase) option must also be provided. type: str config_profile_name: description: - The profile to load from the config file referenced by C(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 C(config_file_location). type: str api_user_fingerprint: description: - 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 C(config_file_location)). To get the key pair's fingerprint value please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). type: str config_file_location: description: - 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. type: str api_user_key_pass_phrase: description: - Passphrase used by the key referenced in C(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 C(config_file_location)). type: str listing_resource_version: description: - Listing resource version. required: true type: str oracle_terms_of_use_link: description: - Oracle TOU link - Required for create using I(state=present). type: str realm_specific_endpoint_template_enabled: description: - Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used. type: bool
app_catalog_subscription: contains: compartment_id: description: - The compartmentID of the subscription. returned: on success sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx type: str display_name: description: - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. returned: on success sample: display_name_example type: str listing_id: description: - The ocid of the listing resource. returned: on success sample: ocid1.listing.oc1..xxxxxxEXAMPLExxxxxx type: str listing_resource_id: description: - Listing resource id. returned: on success sample: ocid1.listingresource.oc1..xxxxxxEXAMPLExxxxxx type: str listing_resource_version: description: - Listing resource version. returned: on success sample: listing_resource_version_example type: str publisher_name: description: - Name of the publisher who published this listing. returned: on success sample: publisher_name_example type: str summary: description: - The short summary to the listing. returned: on success sample: summary_example type: str time_created: description: - 'Date and time at which the subscription was created, in L(RFC3339,https://tools.ietf.org/html/rfc3339) format. Example: `2018-03-20T12:32:53.532Z`' returned: on success sample: '2013-10-20T19:20:30+01:00' type: str description: - Details of the AppCatalogSubscription resource acted upon by the current operation returned: on success 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' type: complex