oracle.oci.oci_cims_incident_resource_type_facts – Fetches details about one or multiple IncidentResourceType resources in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

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

  • During support ticket creation, returns the list of all possible products that Oracle Cloud Infrastructure supports.

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
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 / required
The OCID of the tenancy.
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.
name
string
The user-friendly name of the incident type.
ocid
string / required
User OCID for Oracle Identity Cloud Service (IDCS) users who also have a federated Oracle Cloud Infrastructure account.
problem_type
string / required
The kind of support request.
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: List incident_resource_types
  oci_cims_incident_resource_type_facts:
    # required
    problem_type: problem_type_example
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    csi: csi_example
    ocid: ocid_example

    # optional
    sort_by: dateUpdated
    sort_order: ASC
    name: name_example
    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_resource_types
complex
on success
List of IncidentResourceType resources

Sample:
[{'description': 'description_example', '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'}]}]
 
description
string
on success
The description of the resource.

Sample:
description_example
 
label
string
on success
The label associated with the resource.

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

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


Authors

  • Oracle (@oracle)