oracle.oci.oci_os_management_hub_event – Manage an Event 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_os_management_hub_event.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • This resource has the following action operations in the oracle.oci.oci_os_management_hub_event_actions module: change_compartment, import_event_content.

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.
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. For more information, see Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}`
This parameter is updatable.
event_id
string / required
The OCID of the event.

aliases: id
freeform_tags
dictionary
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{"Department": "Finance"}`
This parameter is updatable.
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 ←
  • absent
The state of the Event.
Use state=present to update an existing an Event.
Use state=absent to delete 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
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Examples

- name: Update event
  oci_os_management_hub_event:
    # required
    event_id: "ocid1.event.oc1..xxxxxxEXAMPLExxxxxx"

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

- name: Delete event
  oci_os_management_hub_event:
    # required
    event_id: "ocid1.event.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

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', 'data': {'additional_details': {'exploit_cves': [], 'initiator_id': 'ocid1.initiator.oc1..xxxxxxEXAMPLExxxxxx', 'vmcore': {'backtrace': 'backtrace_example', 'component': 'component_example'}, 'work_request_ids': []}, 'content': {'content_availability': 'NOT_AVAILABLE', 'content_location': 'content_location_example', 'exploit_detection_log_content': 'exploit_detection_log_content_example', 'exploit_object_store_location': 'exploit_object_store_location_example', 'size': 56, 'type': 'KERNEL'}, 'count': 56, 'event_fingerprint': 'event_fingerprint_example', 'operation_type': 'LIST_PACKAGES', 'reason': 'reason_example', 'status': 'SUCCEEDED', 'time_first_occurred': '2013-10-20T19:20:30+01:00'}, 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'event_details': 'event_details_example', 'event_summary': 'event_summary_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_managed_by_autonomous_linux': True, 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'resource_id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'system_details': {'architecture': 'X86_64', 'ksplice_effective_kernel_version': 'ksplice_effective_kernel_version_example', 'os_family': 'ORACLE_LINUX_9', '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': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_occurred': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'type': 'KERNEL_OOPS'}
 
compartment_id
string
on success
The OCID of the compartment.

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

   
additional_details
complex
on success

     
exploit_cves
list / elements=string
on success
List of CVEs in the exploit.
     
initiator_id
string
on success
The OCID of the resource that triggered the event, such as scheduled job id.

Sample:
ocid1.initiator.oc1..xxxxxxEXAMPLExxxxxx
     
vmcore
complex
on success

       
backtrace
string
on success
Kernel vmcore backtrace.

Sample:
backtrace_example
       
component
string
on success
Kernel vmcore component.

Sample:
component_example
     
work_request_ids
list / elements=string
on success
List of all work request OCIDs associated with the event.
   
content
complex
on success

     
content_availability
string
on success
Crash content availability status: * 'NOT_AVAILABLE' indicates the content is not available on the instance nor in the service * 'AVAILABLE_ON_INSTANCE' indicates the content is only available on the instance. * 'AVAILABLE_ON_SERVICE' indicates the content is only available on the service. * 'AVAILABLE_ON_INSTANCE_AND_SERVICE' indicates the content is available both on the instance and the service * 'AVAILABLE_ON_INSTANCE_UPLOAD_IN_PROGRESS' indicates the content is available on the instance and its upload to the service is in progress.

Sample:
NOT_AVAILABLE
     
content_location
string
on success
Location of the Kernel event content.

Sample:
content_location_example
     
exploit_detection_log_content
string
on success
The content of the exploit detection log.

Sample:
exploit_detection_log_content_example
     
exploit_object_store_location
string
on success
The location of the exploit detection log within object storage.

Sample:
exploit_object_store_location_example
     
size
integer
on success
Size of the event content.

Sample:
56
     
type
string
on success
Event type: * `KERNEL` - Used to identify a kernel oops/crash content * `EXPLOIT_ATTEMPT` - Used to identify a known exploit detection content

Sample:
KERNEL
   
count
integer
on success
Number of times the event has occurred.

Sample:
56
   
event_fingerprint
string
on success
Fingerprint of the event.

Sample:
event_fingerprint_example
   
operation_type
string
on success
Type of agent operation.

Sample:
LIST_PACKAGES
   
reason
string
on success
Reason for the event.

Sample:
reason_example
   
status
string
on success
Status of the agent operation.

Sample:
SUCCEEDED
   
time_first_occurred
string
on success
The date and time that the event first occurred.

Sample:
2013-10-20T19:20:30+01:00
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
event_details
string
on success
Details of an event.

Sample:
event_details_example
 
event_summary
string
on success
Summary of the event.

Sample:
event_summary_example
 
freeform_tags
dictionary
on success
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{"Department": "Finance"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
The OCID of the event.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
is_managed_by_autonomous_linux
boolean
on success
Indicates whether the event occurred on a resource that is managed by the Autonomous Linux service.

Sample:
True
 
lifecycle_details
string
on success
Describes the current state of the event in more detail. For example, the message can provide actionable information for a resource in the 'FAILED' state.

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
The current state of the event.

Sample:
CREATING
 
resource_id
string
on success
The OCID of the managed instance or resource where the event occurred.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
system_details
complex
on success

   
architecture
string
on success
Architecture type.

Sample:
X86_64
   
ksplice_effective_kernel_version
string
on success
Version of the Ksplice effective kernel.

Sample:
ksplice_effective_kernel_version_example
   
os_family
string
on success
Operating system type.

Sample:
ORACLE_LINUX_9
   
os_kernel_release
string
on success
Release of the kernel.

Sample:
os_kernel_release_example
   
os_kernel_version
string
on success
Version of the kernel.

Sample:
os_kernel_version_example
   
os_name
string
on success
Name of the operating system.

Sample:
os_name_example
   
os_system_version
string
on success
Version of the operating system.

Sample:
os_system_version_example
 
system_tags
dictionary
on success
System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
 
time_created
string
on success
The date and time the Event was created, in the format defined by RFC 3339.
Example: `2016-08-25T21:10:29.600Z`

Sample:
2013-10-20T19:20:30+01:00
 
time_occurred
string
on success
The date and time that the event occurred.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The date and time that the event was updated (in RFC 3339 format). Example: `2016-08-25T21:10:29.600Z`

Sample:
2013-10-20T19:20:30+01:00
 
type
string
on success
Event type: * `KERNEL_OOPS` - Used to identify a kernel panic condition event * `KERNEL_CRASH` - Used to identify an internal fatal kernel error that cannot be safely recovered from * `EXPLOIT_ATTEMPT` - Used to identify a known exploit detection as identified by Ksplice * `SOFTWARE_UPDATE` - Software updates - Packages * `KSPLICE_UPDATE` - Ksplice updates * `SOFTWARE_SOURCE` - Software source * `AGENT` - Agent * `MANAGEMENT_STATION` - Management Station

Sample:
KERNEL_OOPS


Authors

  • Oracle (@oracle)