hitachivantara.vspone_block.sds_block.hv_sds_block_event_logs_facts module – Get event logs from storage system

Note

This module is part of the hitachivantara.vspone_block collection (version 4.1.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 hitachivantara.vspone_block. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: hitachivantara.vspone_block.sds_block.hv_sds_block_event_logs_facts.

New in hitachivantara.vspone_block 4.1.0

Synopsis

Requirements

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

  • python >= 3.9

Parameters

Parameter

Comments

connection_info

dictionary / required

Information required to establish a connection to the storage system.

address

string / required

IP address or hostname of the storage system.

connection_type

string

Type of connection to the storage system.

Choices:

  • "direct" ← (default)

password

string / required

Password for authentication. This is a required field.

username

string / required

Username for authentication. This is a required field.

spec

dictionary

Specification for retrieving CHAP user information.

end_time

string

End time for event log retrieval (ISO 8601 format)

max_events

integer

Maximum number of events to retrieve (1-1000)

Default: 1000

severity

string

Filter events by exact severity level

Choices:

  • "Info"

  • "Warning"

  • "Error"

  • "Critical"

severity_ge

string

Filter events by severity level greater than or equal to

Choices:

  • "Info"

  • "Warning"

  • "Error"

  • "Critical"

start_time

string

Start time for event log retrieval (ISO 8601 format)

Attributes

Attribute

Support

Description

check_mode

Support: full

Determines if the module should run in check mode.

Examples

- name: Retrieve information about all Event logss
  hitachivantara.vspone_block.sds_block.hv_sds_block_event_logs_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"

- name: Retrieve information about Event logs by specifying optional parameters
  hitachivantara.vspone_block.sds_block.hv_sds_block_event_logs_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
        severity: "Info"
        severity_ge: "Warning"
        start_time: "2023-01-01T00:00:00Z"
        end_time: "2023-12-31T23:59:59Z"
        max_events: 10

Returned Facts

Facts returned by this module are added/updated in the hostvars host facts and can be referenced by name just like any other host fact. They do not need to be registered in order to use them.

Key

Description

data

list / elements=dictionary

List of event log entries.

Returned: success

category

string

Category of the event.

Returned: success

Sample: "Service"

event_name

string

Name or short description of the event.

Returned: success

Sample: "Successful completion of job"

event_type

string

Type of the event (if available).

Returned: success

id

string

Unique identifier for the event log entry.

Returned: success

Sample: "de90dc2f-dd0a-4edf-8562-41504571b8ba"

message

string

Detailed message about the event.

Returned: success

Sample: "The job has completed successfully. (Operation = STORAGE_NODE_DELETE, Job ID = b5911f59-c35a-4db9-82d9-09d6f67594e3)"

message_id

string

Message identifier code.

Returned: success

Sample: "KARS13010-I"

node_location

string

Unique identifier of the node location associated with the event.

Returned: success

Sample: "086e0c50-4b8d-430e-be47-bd65da4ca229"

severity

string

Severity level as a string.

Returned: success

Sample: "Info"

severity_level

string

Numerical or categorized severity level (if available).

Returned: success

Sample: "Warning"

solution

string

Suggested solution or resolution for the event, if any.

Returned: success

Sample: ""

time

string

Time when the event occurred (ISO 8601 format).

Returned: success

Sample: "2023-03-20T06:51:22Z"

time_in_microseconds

integer

Timestamp in microseconds.

Returned: success

Sample: 1679295082702433

Authors

  • Hitachi Vantara LTD (@hitachi-vantara)