hitachivantara.vspone_object.oneobject_node.hv_events_facts module – Get events from VSP One Object

Note

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

To use it in a playbook, specify: hitachivantara.vspone_object.oneobject_node.hv_events_facts.

New in hitachivantara.vspone_object 1.0.0

Synopsis

  • This module query system or GMS events from Hitachi VSP One Object Node.

Requirements

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

  • python >= 3.7

Parameters

Parameter

Comments

connection_info

dictionary / required

Information required to establish a connection to the system.

cluster_name

string / required

Cluster name of the system.

http_request_retry_interval_seconds

integer / required

Interval between retries of an HTTP request.

http_request_retry_times

integer / required

Number of times to retry an HTTP request.

http_request_timeout

integer / required

Timeout for HTTP requests.

oneobject_node_client_id

string / required

Id for authentication.

oneobject_node_client_secret

string

Secret for authentication.

oneobject_node_username

string / required

Username for authentication.

oneobject_node_userpass

string / required

Password for authentication.

region

string / required

Region of the system.

ssl

dictionary

SSL configuration.

ca_certs

string

Path to the CA certificates file.

Default: ""

ca_path

string

Path to the CA certificate file.

Default: ""

check_hostname

boolean

Whether to check the hostname.

Choices:

  • false ← (default)

  • true

client_cert

string

Path to the client certificate file.

Default: ""

client_key

string

Path to the client key file.

Default: ""

ssl_cipher

string

SSL cipher to use.

Default: ""

ssl_version

string

SSL version to use.

Default: ""

validate_certs

boolean / required

Whether to validate SSL certificates.

Choices:

  • false

  • true

spec

dictionary / required

Request parameters for fetching events.

category

string

A category the event falls into, such as user, bucket, KMIP and S3 settings.

count

integer

Number of Events to be fetched.

end_timestamp

string

Date and time of the event till when it has to be fetched in the format yyyy-mm-ddThh:mm:ssZ.

event_type_id

integer

A unique identifier for a specific type of event.

query_type

string / required

Defines which events needs to be fetched

Choices:

  • "GMS"

  • "SYSTEM"

severity

string

Event severity.

Choices:

  • "INFO"

  • "SEVERE"

  • "WARNING"

start_timestamp

string

Date and time of the event from when it has to be fetched in the format yyyy-mm-ddThh:mm:ssZ.

user

integer

ID of the user.

Attributes

Attribute

Support

Description

check_mode

Support: full

Determines if the module should run in check mode.

Examples

- name: Get system events
  hitachivantara.vspone_object.oneobject_node.hv_events_facts:
    connection_info:
      http_request_timeout: 300
      http_request_retry_times: 3
      http_request_retry_interval_seconds: 5
      cluster_name: "your_cluster_name"
      region: "your_region"
      oneobject_node_username: "your_username"
      oneobject_node_userpass: "your_password"
      oneobject_node_client_id: "vsp-object-external-client"
    spec:
      query_type: "SYSTEM"
- name: Get GMS events
  hitachivantara.vspone_object.oneobject_node.hv_events_facts:
    connection_info:
      http_request_timeout: 300
      http_request_retry_times: 3
      http_request_retry_interval_seconds: 5
      cluster_name: "your_cluster_name"
      region: "your_region"
      oneobject_node_username: "your_username"
      oneobject_node_userpass: "your_password"
      oneobject_node_client_id: "vsp-object-external-client"
    spec:
      query_type: "GMS"

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

events

list / elements=dictionary

List of events with their attributes.

Returned: success

category

string

The category of the event.

Returned: success

Sample: "STORAGE_COMPONENT"

event_type_id

string

The unique identifier for the event type.

Returned: success

Sample: "10206"

message

string

A descriptive message about the event.

Returned: success

Sample: "Failed to retrieve capacity usage"

region_id

string

The region identifier where the event occurred.

Returned: success

Sample: "us-west-2"

severity

string

The severity level of the event.

Returned: success

Sample: "SEVERE"

subject

string

The subject of the event.

Returned: success

Sample: "Failed to Retrieve Storage Capacity"

timestamp

string

The timestamp when the event occurred.

Returned: success

Sample: "2025-02-27T20:31:49.034Z"

Authors

  • Hitachi Vantara, LTD. (@hitachi-vantara)