oracle.oci.oci_ons_subscription_actions – Perform actions on a Subscription resource in Oracle Cloud Infrastructure¶

Note

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

New in version 2.9.0: of oracle.oci

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis ¶

Perform actions on a Subscription resource in Oracle Cloud Infrastructure
For action=get_unsubscription, unsubscribes the subscription from the topic. Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
For action=resend_subscription_confirmation, resends the confirmation details for the specified subscription. Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.

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
action string / required	Choices: get_unsubscription resend_subscription_confirmation	The action to perform on the Subscription.
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 security_token	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.
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`.
id string / required		The OCID of the subscription to unsubscribe from.
protocol string		The protocol used for the subscription. Allowed values: * `CUSTOM_HTTPS` * `EMAIL` * `HTTPS` (deprecated; for PagerDuty endpoints, use `PAGERDUTY`) * `ORACLE_FUNCTIONS` * `PAGERDUTY` * `SLACK` * `SMS` For information about subscription protocols, see To create a subscription. Required for action=get_unsubscription.
realm_specific_endpoint_template_enabled boolean	Choices: no yes	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.
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
token string		The subscription confirmation token. Required for action=get_unsubscription.
wait boolean	Choices: no yes ←	Whether to wait for create or delete operation to complete.
wait_timeout integer		Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Notes ¶

Note

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

Examples ¶

- name: Perform action get_unsubscription on subscription
  oci_ons_subscription_actions:
    # required
    token: token_example
    protocol: protocol_example
    id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    action: get_unsubscription

- name: Perform action resend_subscription_confirmation on subscription
  oci_ons_subscription_actions:
    # required
    id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    action: resend_subscription_confirmation

Return Values ¶

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

Key		Returned	Description
subscription complex		on success	Details of the Subscription resource acted upon by the current operation Sample: {'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'created_time': 56, 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'deliver_policy': 'deliver_policy_example', 'endpoint': 'endpoint_example', 'etag': 'etag_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'PENDING', 'protocol': 'protocol_example', 'topic_id': 'ocid1.topic.oc1..xxxxxxEXAMPLExxxxxx'}
	compartment_id string	on success	The OCID of the compartment for the subscription. Sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
	created_time integer	on success	The time when this suscription was created. Sample: 56
	defined_tags dictionary	on success	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}` Sample: {'Operations': {'CostCenter': 'US'}}
	deliver_policy string	on success	The delivery policy of the subscription. Stored as a JSON string. Sample: deliver_policy_example
	endpoint string	on success	A locator that corresponds to the subscription protocol. For example, an email address for a subscription that uses the `EMAIL` protocol, or a URL for a subscription that uses an HTTP-based protocol. Sample: endpoint_example
	etag string	on success	For optimistic concurrency control. See `if-match`. Sample: etag_example
	freeform_tags dictionary	on success	Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{"Department": "Finance"}` Sample: {'Department': 'Finance'}
	id string	on success	The OCID of the subscription. Sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
	lifecycle_state string	on success	The lifecycle state of the subscription. The status of a new subscription is PENDING; when confirmed, the subscription status changes to ACTIVE. Sample: PENDING
	protocol string	on success	The protocol used for the subscription. Allowed values: * `CUSTOM_HTTPS` * `EMAIL` * `HTTPS` (deprecated; for PagerDuty endpoints, use `PAGERDUTY`) * `ORACLE_FUNCTIONS` * `PAGERDUTY` * `SLACK` * `SMS` For information about subscription protocols, see To create a subscription. Sample: protocol_example
	topic_id string	on success	The OCID of the associated topic. Sample: ocid1.topic.oc1..xxxxxxEXAMPLExxxxxx

Authors¶

Oracle (@oracle)

oracle.oci.oci_ons_subscription_actions – Perform actions on a Subscription resource in Oracle Cloud Infrastructure¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶