oracle.oci.oci_cims_incident – Manage an Incident resource in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create and update an Incident resource in Oracle Cloud Infrastructure

  • For state=present, enables the customer to create an support ticket.

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 for create using state=present.
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.
contacts
list / elements=dictionary
The list of contacts.
contact_email
string
The email of the contact person.
contact_name
string
The name of the contact person.
contact_phone
string
The phone number of the contact person.
contact_type
string
    Choices:
  • PRIMARY
  • ALTERNATE
  • SECONDARY
  • ADMIN
  • MANAGER
The type of contact, such as primary or alternate.
csi
string
The Customer Support Identifier number for the support account.
Required for create using state=present, update using state=present with incident_key present.
force_create
boolean
    Choices:
  • no ←
  • yes
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 key_by.
homeregion
string
The region of the tenancy.
This parameter is updatable.
incident_key
string
Unique identifier for the support ticket.
Required for update using state=present.
key_by
list / elements=string
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.
ocid
string / required
User OCID for Oracle Identity Cloud Service (IDCS) users who also have a federated Oracle Cloud Infrastructure account.
problem_type
string
    Choices:
  • LIMIT
  • LEGACY_LIMIT
  • TECH
  • ACCOUNT
The kind of support ticket, such as a technical issue request.
Required for create using state=present.
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.
referrer
string
The incident referrer. This value is often the URL that the customer used when creating the support ticket.
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.
state
string
    Choices:
  • present ←
The state of the Incident.
Use state=present to create or update an Incident.
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
ticket
dictionary / required
contextual_data
dictionary
The context from where the ticket is getting created.
client_id
string / required
The unique client identifier
payload
string / required
The context data payload
schema_name
string / required
The schema name
schema_version
string / required
The schema version
description
string
The description of the support ticket.
resource
dictionary
The list of resources.
This parameter is updatable.
resource_list
list / elements=dictionary
The list of resources.
availability_domain
string
    Choices:
  • DEV_1
  • DEV_2
  • DEV_3
  • INTEG_NEXT_1
  • INTEG_STABLE_1
  • SEA_AD_1
  • SEA_AD_2
  • SEA_AD_3
  • PHX_AD_1
  • PHX_AD_2
  • PHX_AD_3
  • US_ASHBURN_AD_1
  • US_ASHBURN_AD_2
  • US_ASHBURN_AD_3
  • US_ASHBURN_AD_4
  • EU_FRANKFURT_1_AD_1
  • EU_FRANKFURT_1_AD_2
  • EU_FRANKFURT_1_AD_3
  • UK_LONDON_1_AD_1
  • UK_LONDON_1_AD_2
  • UK_LONDON_1_AD_3
  • CA_TORONTO_1_AD_1
  • AP_TOKYO_1_AD_1
  • AP_SEOUL_1_AD_1
  • AP_MUMBAI_1_AD_1
  • SA_SAOPAULO_1_AD_1
  • ME_JEDDAH_1_AD_1
  • AP_OSAKA_1_AD_1
  • AP_SYDNEY_1_AD_1
  • EU_ZURICH_1_AD_1
  • EU_AMSTERDAM_1_AD_1
  • AP_MELBOURNE_1_AD_1
  • CA_MONTREAL_1_AD_1
  • AP_HYDERABAD_1_AD_1
  • AP_CHUNCHEON_1_AD_1
  • NO_AD
The list of available Oracle Cloud Infrastructure availability domains.
item
dictionary
category
dictionary
category_key
string
Unique identifier for the category.
Applicable when type is 'tech'
current_limit
integer
The limit of the resource currently available.
Applicable when type is 'limit'
current_usage
integer
The current usage of the resource.
Applicable when type is 'limit'
issue_type
dictionary
issue_type_key
string
Unique identifier for the issue type.
Applicable when type is 'tech'
limit_status
string
    Choices:
  • APPROVED
  • PARTIALLY_APPROVED
  • NOT_APPROVED
The current status of the request.
Applicable when type is 'limit'
name
string
The display name of the item.
requested_limit
integer
Reserved for future use.
Applicable when type is 'limit'
sub_category
dictionary
sub_category_key
string
Unique identifier for the subcategory.
Applicable when type is 'tech'
type
string / required
    Choices:
  • tech
  • limit
The type of the item.
region
string
    Choices:
  • DEV
  • SEA
  • INTEG_NEXT
  • INTEG_STABLE
  • PHX
  • IAD
  • FRA
  • EU_FRANKFURT_1
  • LHR
  • YYZ
  • NRT
  • ICN
  • BOM
  • GRU
  • SYD
  • ZRH
  • JED
  • AMS
  • KIX
  • MEL
  • YUL
  • HYD
  • YNY
The list of available Oracle Cloud Infrastructure regions.
severity
string
    Choices:
  • HIGHEST
  • HIGH
  • MEDIUM
The severity of the support ticket.
title
string
The title of the support ticket.

Examples

- name: Create incident
  oci_cims_incident:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    problem_type: LIMIT
    csi: csi_example
    ticket:
      # optional
      severity: HIGHEST
      resource_list:
      - # optional
        item:
          # required
          type: tech

          # optional
          category:
            # optional
            category_key: category_key_example
          sub_category:
            # optional
            sub_category_key: sub_category_key_example
          issue_type:
            # optional
            issue_type_key: issue_type_key_example
          name: name_example
        region: us-phoenix-1
        availability_domain: Uocm:PHX-AD-1
      title: title_example
      description: description_example
      contextual_data:
        # required
        client_id: "ocid1.client.oc1..xxxxxxEXAMPLExxxxxx"
        schema_name: schema_name_example
        schema_version: schema_version_example
        payload: payload_example
      resource: null
    ocid: ocid_example

    # optional
    contacts:
    - # optional
      contact_name: contact_name_example
      contact_email: contact_email_example
      contact_phone: contact_phone_example
      contact_type: PRIMARY
    referrer: referrer_example
    homeregion: us-phoenix-1

- name: Update incident
  oci_cims_incident:
    # required
    incident_key: incident_key_example
    csi: csi_example
    ticket:
      # optional
      severity: HIGHEST
      resource_list:
      - # optional
        item:
          # required
          type: tech

          # optional
          category:
            # optional
            category_key: category_key_example
          sub_category:
            # optional
            sub_category_key: sub_category_key_example
          issue_type:
            # optional
            issue_type_key: issue_type_key_example
          name: name_example
        region: us-phoenix-1
        availability_domain: Uocm:PHX-AD-1
      title: title_example
      description: description_example
      contextual_data:
        # required
        client_id: "ocid1.client.oc1..xxxxxxEXAMPLExxxxxx"
        schema_name: schema_name_example
        schema_version: schema_version_example
        payload: payload_example
      resource: null
    ocid: ocid_example

    # optional
    homeregion: us-phoenix-1

Return Values

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

Key Returned Description
incident
complex
on success
Details of the Incident resource acted upon by the current operation

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'}, '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
 
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.

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)