oracle.oci.oci_cims_incident_facts – Fetches details about one or multiple Incident resources 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_cims_incident_facts.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Returns the list of support tickets raised by the tenancy.

  • If incident_key is specified, the details of a single Incident will be returned.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
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.
compartment_id
string
The OCID of the tenancy.
Required to list multiple incidents.
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.
csi
string / required
The Customer Support Identifier associated with the support account.
homeregion
string
The region of the tenancy.
incident_key
string
Unique identifier for the support ticket.
Required to get a specific incident.
lifecycle_state
string
    Choices:
  • ACTIVE
  • CLOSED
The current state of the ticket.
ocid
string / required
User OCID for Oracle Identity Cloud Service (IDCS) users who also have a federated Oracle Cloud Infrastructure account.
problem_type
string
The kind of support request.
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.
sort_by
string
    Choices:
  • dateUpdated
  • severity
The key to use to sort the returned items.
sort_order
string
    Choices:
  • ASC
  • DESC
The order to sort the results in.
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 incident
  oci_cims_incident_facts:
    # required
    incident_key: incident_key_example
    csi: csi_example
    ocid: ocid_example

    # optional
    homeregion: us-phoenix-1
    problem_type: problem_type_example

- name: List incidents
  oci_cims_incident_facts:
    # required
    csi: csi_example
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    ocid: ocid_example

    # optional
    sort_by: dateUpdated
    sort_order: ASC
    lifecycle_state: ACTIVE
    homeregion: us-phoenix-1
    problem_type: problem_type_example

Return Values

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

Key Returned Description
incidents
complex
on success
List of Incident resources

Sample:
[{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'contact_list': {'contact_list': [{'contact_email': 'contact_email_example', 'contact_name': 'contact_name_example', 'contact_phone': 'contact_phone_example', 'contact_type': 'PRIMARY'}]}, 'incident_type': {'classifier_list': [{'description': 'description_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'issue_type_list': [{'issue_type_key': 'issue_type_key_example', 'label': 'label_example'}], 'label': 'label_example', 'name': 'name_example', 'scope': 'AD', 'unit': 'COUNT'}], 'description': 'description_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'label': 'label_example', 'name': 'name_example', 'resource_type_key': 'resource_type_key_example', 'service_category_list': [{'description': 'description_example', 'issue_type_list': [{'issue_type_key': 'issue_type_key_example', 'label': 'label_example'}], 'key': 'key_example', 'label': 'label_example', 'limit_id': 'ocid1.limit.oc1..xxxxxxEXAMPLExxxxxx', 'name': 'name_example', 'scope': 'AD', 'unit': 'COUNT'}]}, 'key': 'key_example', 'problem_type': 'LIMIT', 'referrer': 'referrer_example', 'tenancy_information': {'customer_support_key': 'customer_support_key_example', 'tenancy_id': 'ocid1.tenancy.oc1..xxxxxxEXAMPLExxxxxx'}, 'ticket': {'description': 'description_example', 'lifecycle_details': 'PENDING_WITH_ORACLE', 'lifecycle_state': 'ACTIVE', 'resource_list': [{'availability_domain': 'Uocm:PHX-AD-1', 'item': {'activity_author': 'CUSTOMER', 'activity_type': 'NOTES', 'category': {'category_key': 'category_key_example', 'name': 'name_example'}, 'comments': 'comments_example', 'current_limit': 56, 'current_usage': 56, 'issue_type': {'issue_type_key': 'issue_type_key_example', 'label': 'label_example'}, 'item_key': 'item_key_example', 'limit_status': 'APPROVED', 'name': 'name_example', 'requested_limit': 56, 'sub_category': {'name': 'name_example', 'sub_category_key': 'sub_category_key_example'}, 'time_created': 56, 'time_updated': 56, 'type': 'activity'}, 'region': 'us-phoenix-1'}], 'severity': 'HIGHEST', 'ticket_number': 'ticket_number_example', 'time_created': 56, 'time_updated': 56, 'title': 'title_example'}}]
 
compartment_id
string
on success
The OCID of the tenancy.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
contact_list
complex
on success

   
contact_list
complex
on success
The list of contacts.

     
contact_email
string
on success
The email of the contact person.

Sample:
contact_email_example
     
contact_name
string
on success
The name of the contact person.

Sample:
contact_name_example
     
contact_phone
string
on success
The phone number of the contact person.

Sample:
contact_phone_example
     
contact_type
string
on success
The type of contact, such as primary or alternate.

Sample:
PRIMARY
 
incident_type
complex
on success

   
classifier_list
complex
on success
The list of classifiers.

     
description
string
on success
The description of the classifier.

Sample:
description_example
     
id
string
on success
Unique identifier of the classifier.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
     
issue_type_list
complex
on success
The list of issues.

       
issue_type_key
string
on success
Unique identifier for the issue type.

Sample:
issue_type_key_example
       
label
string
on success
The label for the issue type. For example, `Instance Performance`.

Sample:
label_example
     
label
string
on success
The label associated with the classifier.

Sample:
label_example
     
name
string
on success
The display name of the classifier.

Sample:
name_example
     
scope
string
on success
The scope of the service category or resource.

Sample:
AD
     
unit
string
on success
The unit to use to measure the service category or resource.

Sample:
COUNT
   
description
string
on success
The description of the incident type.

Sample:
description_example
   
id
string
on success
Unique identifier for the incident type.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
   
label
string
on success
The label associated with the incident type.

Sample:
label_example
   
name
string
on success
The name of the incident type.

Sample:
name_example
   
resource_type_key
string
on success
Unique identifier of the resource.

Sample:
resource_type_key_example
   
service_category_list
complex
on success
The service category list.

     
description
string
on success
The text describing the classifier.

Sample:
description_example
     
issue_type_list
complex
on success
The list of issues.

       
issue_type_key
string
on success
Unique identifier for the issue type.

Sample:
issue_type_key_example
       
label
string
on success
The label for the issue type. For example, `Instance Performance`.

Sample:
label_example
     
key
string
on success
The unique ID that identifies a classifier.

Sample:
key_example
     
label
string
on success
The label for the classifier.

Sample:
label_example
     
limit_id
string
on success
The unique ID for the limit.

Sample:
ocid1.limit.oc1..xxxxxxEXAMPLExxxxxx
     
name
string
on success
The name of the classifier.

Sample:
name_example
     
scope
string
on success
The scope of the incident.

Sample:
AD
     
unit
string
on success
The unit to use to measure the service category or resource.

Sample:
COUNT
 
key
string
on success
Unique identifier for the support ticket.

Sample:
key_example
 
problem_type
string
on success
The kind of support ticket, such as a technical support request.

Sample:
LIMIT
 
referrer
string
on success
The incident referrer. This value is often the URL that the customer used when creating the support ticket.
Returned for get operation

Sample:
referrer_example
 
tenancy_information
complex
on success

   
customer_support_key
string
on success
The Customer Support Identifier number associated with the tenancy.

Sample:
customer_support_key_example
   
tenancy_id
string
on success
The OCID of the tenancy.

Sample:
ocid1.tenancy.oc1..xxxxxxEXAMPLExxxxxx
 
ticket
complex
on success

   
description
string
on success
The description of the issue addressed in the ticket.

Sample:
description_example
   
lifecycle_details
string
on success
Additional information about the current `lifecycleState`.

Sample:
PENDING_WITH_ORACLE
   
lifecycle_state
string
on success
The current state of the ticket.

Sample:
ACTIVE
   
resource_list
complex
on success
The list of resources associated with the ticket.

     
availability_domain
string
on success
The list of available Oracle Cloud Infrastructure availability domains.

Sample:
Uocm:PHX-AD-1
     
item
complex
on success

       
activity_author
string
on success
The person who updates the activity on the support ticket.

Sample:
CUSTOMER
       
activity_type
string
on success
The type of activity occuring on the support ticket.

Sample:
NOTES
       
category
complex
on success

         
category_key
string
on success
Unique identifier for the category.

Sample:
category_key_example
         
name
string
on success
The name of the category. For example, `Compute` or `Identity`.

Sample:
name_example
       
comments
string
on success
Comments added with the activity on the support ticket.

Sample:
comments_example
       
current_limit
integer
on success
The currently available limit of the resource.

Sample:
56
       
current_usage
integer
on success
The current usage of the resource.

Sample:
56
       
issue_type
complex
on success

         
issue_type_key
string
on success
Unique identifier for the issue type.

Sample:
issue_type_key_example
         
label
string
on success
The label for the issue type. For example, `Instance Performance`.

Sample:
label_example
       
item_key
string
on success
Unique identifier for the item.

Sample:
item_key_example
       
limit_status
string
on success
The status of the request.

Sample:
APPROVED
       
name
string
on success
The display name of the item.

Sample:
name_example
       
requested_limit
integer
on success
The requested limit for the resource.

Sample:
56
       
sub_category
complex
on success

         
name
string
on success
The name of the subcategory. For example, `Backup Count` or `Custom Image Count`.

Sample:
name_example
         
sub_category_key
string
on success
Unique identifier for the subcategory.

Sample:
sub_category_key_example
       
time_created
integer
on success
The time when the activity was created, in milliseconds since epoch time.

Sample:
56
       
time_updated
integer
on success
The time when the activity was updated, in milliseconds since epoch time.

Sample:
56
       
type
string
on success
The type of the support request.

Sample:
activity
     
region
string
on success
The list of available Oracle Cloud Infrastructure regions.

Sample:
us-phoenix-1
   
severity
string
on success
The severity assigned to the ticket.

Sample:
HIGHEST
   
ticket_number
string
on success
Unique identifier for the ticket.

Sample:
ticket_number_example
   
time_created
integer
on success
The time when the ticket was created, in milliseconds since epoch time.

Sample:
56
   
time_updated
integer
on success
The time when the ticket was updated, in milliseconds since epoch time.

Sample:
56
   
title
string
on success
The title of the ticket.

Sample:
title_example


Authors

  • Oracle (@oracle)