oracle.oci.oci_announcements_service_announcements_collection_facts – Fetches details about one or multiple AnnouncementsCollection resources in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.1.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_announcements_collection_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple AnnouncementsCollection resources in Oracle Cloud Infrastructure
Gets a list of announcements for the current tenancy.
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.
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 |
---|---|---|
announcement_type
string
|
The type of announcement.
|
|
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
|
|
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
|
|
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.
|
|
chain_id
string
|
A filter to return only announcements belonging to the specified announcement chain ID.
|
|
compartment_id
string
/ 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 . |
|
environment_name
string
|
A filter to return only announcements that match a specific environment name.
|
|
exclude_announcement_types
list
/ elements=string
|
Exclude The type of announcement.
|
|
is_banner
boolean
|
|
Whether the announcement is displayed as a console banner.
|
lifecycle_state
string
|
|
The announcement's current lifecycle state.
|
platform_type
string
|
|
A filter to return only announcements affecting a specific platform.
|
realm_specific_endpoint_template_enabled
boolean
|
|
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. |
|
service
string
|
A filter to return only announcements affecting a specific service.
|
|
should_show_only_latest_in_chain
boolean
|
|
A filter to display only the latest announcement in a chain.
|
sort_by
string
|
|
The criteria to sort by. You can specify only one sort order.
|
sort_order
string
|
|
The sort order to use. (Sorting by `announcementType` orders the announcements list according to importance.)
|
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_one_earliest_time
string
|
The boundary for the earliest `timeOneValue` date on announcements that you want to see.
|
|
time_one_latest_time
string
|
The boundary for the latest `timeOneValue` date on announcements that you want to see.
|
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: List announcements_collection
oci_announcements_service_announcements_collection_facts:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
announcement_type: announcement_type_example
lifecycle_state: ACTIVE
is_banner: true
sort_by: timeOneValue
sort_order: ASC
time_one_earliest_time: 2013-10-20T19:20:30+01:00
time_one_latest_time: 2013-10-20T19:20:30+01:00
environment_name: environment_name_example
service: service_example
platform_type: IAAS
exclude_announcement_types: [ "exclude_announcement_types_example" ]
should_show_only_latest_in_chain: true
chain_id: "ocid1.chain.oc1..xxxxxxEXAMPLExxxxxx"
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | ||
---|---|---|---|---|
announcements_collection
complex
|
on success |
List of AnnouncementsCollection resources
Sample:
[{'items': [{'affected_regions': [], 'announcement_type': 'ACTION_RECOMMENDED', 'chain_id': 'ocid1.chain.oc1..xxxxxxEXAMPLExxxxxx', 'environment_name': 'environment_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_banner': True, 'lifecycle_state': 'ACTIVE', 'platform_type': 'IAAS', 'reference_ticket_number': 'reference_ticket_number_example', 'services': [], 'summary': 'summary_example', 'time_created': '2013-10-20T19:20:30+01:00', 'time_one_title': 'time_one_title_example', 'time_one_type': 'ACTION_REQUIRED_BY', 'time_one_value': '2013-10-20T19:20:30+01:00', 'time_two_title': 'time_two_title_example', 'time_two_type': 'END_TIME', 'time_two_value': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'type': 'type_example'}], 'user_statuses': [{'time_acknowledged': '2013-10-20T19:20:30+01:00', 'user_id': 'ocid1.user.oc1..xxxxxxEXAMPLExxxxxx', 'user_status_announcement_id': 'ocid1.userstatusannouncement.oc1..xxxxxxEXAMPLExxxxxx'}]}]
|
||
items
complex
|
on success |
A collection of announcements.
|
||
affected_regions
list
/ elements=string
|
on success |
Impacted regions.
|
||
announcement_type
string
|
on success |
The type of announcement. An announcement's type signals its severity.
Sample:
ACTION_RECOMMENDED
|
||
chain_id
string
|
on success |
The sequence of connected announcements, or announcement chain, that this announcement belongs to. Related announcements share the same chain ID.
Sample:
ocid1.chain.oc1..xxxxxxEXAMPLExxxxxx
|
||
environment_name
string
|
on success |
The name of the environment that this announcement pertains to.
Sample:
environment_name_example
|
||
id
string
|
on success |
The OCID of the announcement.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||
is_banner
boolean
|
on success |
Whether the announcement is displayed as a banner in the console.
Sample:
True
|
||
lifecycle_state
string
|
on success |
The current lifecycle state of the announcement.
Sample:
ACTIVE
|
||
platform_type
string
|
on success |
The platform type that this announcement pertains to.
Sample:
IAAS
|
||
reference_ticket_number
string
|
on success |
The reference Jira ticket number.
Sample:
reference_ticket_number_example
|
||
services
list
/ elements=string
|
on success |
Impacted Oracle Cloud Infrastructure services.
|
||
summary
string
|
on success |
A summary of the issue. A summary might appear in the console banner view of the announcement or in an email subject line. Avoid entering confidential information.
Sample:
summary_example
|
||
time_created
string
|
on success |
The date and time the announcement was created, expressed in RFC 3339 timestamp format. Example: `2019-01-01T17:43:01.389+0000`
Sample:
2013-10-20T19:20:30+01:00
|
||
time_one_title
string
|
on success |
The label associated with an initial time value. Example: `Time Started`
Sample:
time_one_title_example
|
||
time_one_type
string
|
on success |
The type of a time associated with an initial time value. If the `timeOneTitle` attribute is present, then the `timeOneTitle` attribute contains a label of `timeOneType` in English. Example: `START_TIME`
Sample:
ACTION_REQUIRED_BY
|
||
time_one_value
string
|
on success |
The actual value of the first time value for the event. Typically, this denotes the time an event started, but the meaning can vary, depending on the announcement type. The `timeOneType` attribute describes the meaning.
Sample:
2013-10-20T19:20:30+01:00
|
||
time_two_title
string
|
on success |
The label associated with a second time value. Example: `Time Ended`
Sample:
time_two_title_example
|
||
time_two_type
string
|
on success |
The type of a time associated with second time value. If the `timeTwoTitle` attribute is present, then the `timeTwoTitle` attribute contains a label of `timeTwoType` in English. Example: `END_TIME`
Sample:
END_TIME
|
||
time_two_value
string
|
on success |
The actual value of the second time value. Typically, this denotes the time an event ended, but the meaning can vary, depending on the announcement type. The `timeTwoType` attribute describes the meaning.
Sample:
2013-10-20T19:20:30+01:00
|
||
time_updated
string
|
on success |
The date and time the announcement was last updated, expressed in RFC 3339 timestamp format. Example: `2019-01-01T17:43:01.389+0000`
Sample:
2013-10-20T19:20:30+01:00
|
||
type
string
|
on success |
The entity type, which is either an announcement or the summary representation of an announcement.
Sample:
type_example
|
||
user_statuses
complex
|
on success |
The user-specific status for found announcements.
|
||
time_acknowledged
string
|
on success |
The date and time the announcement was acknowledged, expressed in RFC 3339 timestamp format. Example: `2019-01-01T17:43:01.389+0000`
Sample:
2013-10-20T19:20:30+01:00
|
||
user_id
string
|
on success |
The OCID of the user that this status is associated with.
Sample:
ocid1.user.oc1..xxxxxxEXAMPLExxxxxx
|
||
user_status_announcement_id
string
|
on success |
The OCID of the announcement that this status is associated with.
Sample:
ocid1.userstatusannouncement.oc1..xxxxxxEXAMPLExxxxxx
|
Authors¶
Oracle (@oracle)