oracle.oci.oci_os_management_event – Manage an Event resource 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_os_management_event.

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to update an Event resource in Oracle Cloud Infrastructure

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 / required
The ID of the compartment in which to list resources.
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.
defined_tags
dictionary
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
This parameter is updatable.
event_id
string / required
Unique Event identifier (OCID)

aliases: id
freeform_tags
dictionary
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
This parameter is updatable.
managed_instance_id
string / required
Instance Oracle Cloud identifier (ocid)
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.
state
string
    Choices:
  • present ←
The state of the Event.
Use state=present to update an existing an Event.
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: Update event
  oci_os_management_event:
    # required
    managed_instance_id: "ocid1.managedinstance.oc1..xxxxxxEXAMPLExxxxxx"
    event_id: "ocid1.event.oc1..xxxxxxEXAMPLExxxxxx"
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

Return Values

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

Key Returned Description
event
complex
on success
Details of the Event resource acted upon by the current operation

Sample:
{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'content': {'content_availability': 'NOT_AVAILABLE', 'instance_path': 'instance_path_example', 'size': 56}, 'count': 56, 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'event_fingerprint': 'event_fingerprint_example', 'event_type': 'KERNEL_OOPS', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'instance_id': 'ocid1.instance.oc1..xxxxxxEXAMPLExxxxxx', 'reason': 'reason_example', 'summary': 'summary_example', 'system': {'architecture': 'IA_32', 'ksplice_effective_kernel_version': 'ksplice_effective_kernel_version_example', 'os_family': 'LINUX', 'os_kernel_release': 'os_kernel_release_example', 'os_kernel_version': 'os_kernel_version_example', 'os_name': 'os_name_example', 'os_system_version': 'os_system_version_example'}, 'system_tags': {}, 'tenancy_id': 'ocid1.tenancy.oc1..xxxxxxEXAMPLExxxxxx', 'time_first_occurred': '2013-10-20T19:20:30+01:00', 'timestamp': '2013-10-20T19:20:30+01:00', 'vmcore': {'backtrace': 'backtrace_example', 'component': 'component_example'}}
 
compartment_id
string
on success
OCI identifier of the compartement where the instance is

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

   
content_availability
string
on success
Status of the event content

Sample:
NOT_AVAILABLE
   
instance_path
string
on success
Path to the event content on the instance

Sample:
instance_path_example
   
size
integer
on success
size in bytes of the event content (size of the zip file uploaded)

Sample:
56
 
count
integer
on success
Event occurrence count. Number of time the event has happen on the system.

Sample:
56
 
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'}}
 
event_fingerprint
string
on success
Unique ID used to group event with the same characteristics together. The list of such groups of event can be retrieved via /recurringEvents/{EventFingerprint}

Sample:
event_fingerprint_example
 
event_type
string
on success
Type of the Event.

Sample:
KERNEL_OOPS
 
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
OCID identifier of the event

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
instance_id
string
on success
OCI identifier of the instance where the event occurred

Sample:
ocid1.instance.oc1..xxxxxxEXAMPLExxxxxx
 
reason
string
on success
reason of the crash

Sample:
reason_example
 
summary
string
on success
human readable description of the event

Sample:
summary_example
 
system
complex
on success

   
architecture
string
on success
system architecture

Sample:
IA_32
   
ksplice_effective_kernel_version
string
on success
Active ksplice kernel version (uptrack-uname -r)

Sample:
ksplice_effective_kernel_version_example
   
os_family
string
on success
The Operating System type of the managed instance.

Sample:
LINUX
   
os_kernel_release
string
on success
Operating System Kernel Release (uname -v)

Sample:
os_kernel_release_example
   
os_kernel_version
string
on success
Operating System Kernel Version (uname -r)

Sample:
os_kernel_version_example
   
os_name
string
on success
Operating System Name (OCA value)

Sample:
os_name_example
   
os_system_version
string
on success
Version of the OS (VERSION from /etc/os-release)

Sample:
os_system_version_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"}}`
 
tenancy_id
string
on success
OCID identifier of the instance tenancy.

Sample:
ocid1.tenancy.oc1..xxxxxxEXAMPLExxxxxx
 
time_first_occurred
string
on success
First occurrence time of the event

Sample:
2013-10-20T19:20:30+01:00
 
timestamp
string
on success
Time of the occurrence of the event

Sample:
2013-10-20T19:20:30+01:00
 
vmcore
complex
on success

   
backtrace
string
on success
Crash backtrace.

Sample:
backtrace_example
   
component
string
on success
Kernel module responsible of the crash.

Sample:
component_example


Authors

  • Oracle (@oracle)