hitachivantara.vspone_block.sds_block.hv_sds_block_event_logs_facts module – Get event logs from VSP One SDS Block and Cloud systems.

Note

This module is part of the hitachivantara.vspone_block collection (version 4.8.1).

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
Parameters
Attributes
Examples
Returned Facts

Synopsis

Get event logs from storage system with various filtering options
For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/events_log_facts.yml

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) Required for the Get event logs by specifying optional parameters task.
id string	Filter events by exact event ID. Optional for the Get event logs by specifying optional parameters task.
max_events integer	Maximum number of events to retrieve (1-1000) Required for the Get event logs by specifying optional parameters task. Default: `1000`
severity string	Filter events by exact severity level. If you specify severity_ge, you can’t specify this. Optional for the Get event logs by specifying optional parameters task. Choices: `"Info"` `"Warning"` `"Error"` `"Critical"`
severity_ge string	Filter events by severity level greater than or equal to. If you specify severity, you can’t specify this. Choices: `"Info"` `"Warning"` `"Error"` `"Critical"`
start_time string	Start time for event log retrieval (ISO 8601 format) Optional for the Get event logs by specifying optional parameters task.

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
event_logs dictionary	Wrapper for event logs results. Returned: success
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 Sample: `""`
id string	Unique identifier for the event log entry. Returned: success Sample: `"ec99bd4b-68f0-4b3b-899c-a70744f16e5e"`
message string	Detailed message about the event. Returned: success Sample: `"The job has completed successfully. (Operation = CHAP_USER_DELETE, Job ID = 286bf06d-811c-4359-8cc7-c66417884866)"`
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: `"152d2d10-4e18-44aa-86a4-fbd4f7e4cb08"`
severity string	Severity level as a string. Returned: success Sample: `"Info"`
severity_level string	Numerical or categorized severity level (if available). Returned: success Sample: `""`
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: `"2025-11-26T10:41:47Z"`
time_in_microseconds integer	Timestamp in microseconds. Returned: success Sample: `1764153707900467`

Authors

Hitachi Vantara LTD (@hitachi-vantara)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/hitachivantara/vspone_block/sds_block.hv_sds_block_event_logs_facts_module.html