oracle.oci.oci_announcements_service_announcement_subscription_facts – Fetches details about one or multiple AnnouncementSubscription resources in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about one or multiple AnnouncementSubscription resources in Oracle Cloud Infrastructure

  • Gets a list of all announcement subscriptions in the specified compartment.

  • This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.

  • If announcement_subscription_id is specified, the details of a single AnnouncementSubscription will be returned.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
announcement_subscription_id
string
The OCID of the announcement subscription.
Required to get a specific announcement_subscription.

aliases: id
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
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.
compartment_id
string
The OCID of the compartment.
Required to list multiple announcement_subscriptions.
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
A filter to return only resources that match the entire display name given.

aliases: name
lifecycle_state
string
    Choices:
  • ACTIVE
  • DELETED
  • FAILED
A filter to return only announcement subscriptions that match the given lifecycle state.
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.
sort_by
string
    Choices:
  • timeCreated
  • displayName
The criteria to sort by. You can specify only one sort order. The default sort order for the creation date of resources is descending. The default sort order for display names is ascending.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, whether ascending ('ASC') or descending ('DESC').
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 a specific announcement_subscription
  oci_announcements_service_announcement_subscription_facts:
    # required
    announcement_subscription_id: "ocid1.announcementsubscription.oc1..xxxxxxEXAMPLExxxxxx"

- name: List announcement_subscriptions
  oci_announcements_service_announcement_subscription_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    lifecycle_state: ACTIVE
    display_name: display_name_example
    sort_order: ASC
    sort_by: timeCreated

Return Values

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

Key Returned Description
announcement_subscriptions
complex
on success
List of AnnouncementSubscription resources

Sample:
[{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'display_name': 'display_name_example', 'filter_groups': {'filters': [{'type': 'COMPARTMENT_ID', 'value': 'value_example'}], 'name': 'name_example'}, 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'ACTIVE', 'ons_topic_id': 'ocid1.onstopic.oc1..xxxxxxEXAMPLExxxxxx', 'preferred_language': 'preferred_language_example', 'preferred_time_zone': 'preferred_time_zone_example', 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}]
 
compartment_id
string
on success
The OCID of the compartment that contains the announcement subscription.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
description
string
on success
A description of the announcement subscription. Avoid entering confidential information.
Returned for get operation

Sample:
description_example
 
display_name
string
on success
A user-friendly name for the announcement subscription. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Sample:
display_name_example
 
filter_groups
complex
on success
A list of filter groups for the announcement subscription. A filter group is a combination of multiple filters applied to announcements for matching purposes.
Returned for get operation

   
filters
complex
on success
A list of filters against which the Announcements service matches announcements. You cannot have more than one of any given filter type within a filter group. You also cannot combine the RESOURCE_ID filter with any other type of filter within a given filter group.

     
type
string
on success
The type of filter.

Sample:
COMPARTMENT_ID
     
value
string
on success
The value of the filter.

Sample:
value_example
   
name
string
on success
The name of the group. The name must be unique and it cannot be changed. Avoid entering confidential information.

Sample:
name_example
 
freeform_tags
dictionary
on success
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
The OCID of the announcement subscription.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_details
string
on success
A message describing the current lifecycle state in more detail. For example, details might provide required or recommended actions for a resource in a Failed state.

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
The current lifecycle state of the announcement subscription.

Sample:
ACTIVE
 
ons_topic_id
string
on success
The OCID of the Notifications service topic that is the target for publishing announcements that match the configured announcement subscription.

Sample:
ocid1.onstopic.oc1..xxxxxxEXAMPLExxxxxx
 
preferred_language
string
on success
(For announcement subscriptions with Oracle Fusion Applications configured as the service only) The language in which the user prefers to receive emailed announcements. Specify the preference with a value that uses the language tag format (x-obmcs-human-language). For example fr- FR.
Returned for get operation

Sample:
preferred_language_example
 
preferred_time_zone
string
on success
The time zone that the user prefers for announcement time stamps. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example America/Los_Angeles.
Returned for get operation

Sample:
preferred_time_zone_example
 
system_tags
dictionary
on success
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

 
time_created
string
on success
The date and time that the announcement subscription was created, expressed in RFC 3339 timestamp format.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The date and time that the announcement subscription was updated, expressed in RFC 3339 timestamp format.

Sample:
2013-10-20T19:20:30+01:00


Authors

  • Oracle (@oracle)