hitachivantara.vspone_block.vsp.hv_storage_system_monitor_facts module – Retrieves alerts, hardware installed, and channel boards information from VSP block storage 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.vsp.hv_storage_system_monitor_facts.

New in hitachivantara.vspone_block 4.0.0

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Returned Facts

Synopsis

This module retrieves information about Storage System Monitor information from VSP block storage systems.
For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/storage_system_monitor_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.
api_token string	This field is used to pass the value of the lock token to operate on locked resources.
connection_type string	Type of connection to the storage system. Choices: `"direct"` ← (default)
password string	Password for authentication. This is a required field if api_token is not provided.
username string	Username for authentication. This is a required field if api_token is not provided.
spec dictionary / required	Specification for the Storage System Monitor facts to be gathered.
alert_count integer	This field is valid when query field is `alerts`. Then this field is optional. Numbrt of alerts to be retrieved. If you specified `DKC` for the alert_type parameter, specify a value in the range from 1 to 10240. If you specified `CTL1` or `CTL2` for the alert_type parameter, specify a value in the range from 1 to 256. If this parameter is omitted, 10 alerts will be obtained. Required for the Get alerts information task.
alert_start_number integer	This field is valid when query field is `alerts`. Then this field is optional. Alerts are sorted by date and time in descending order. Specify the number of the alert from which you want to start obtaining information. If you specified `DKC` for the alert_type parameter, specify a value in the range from 1 to 10240. If you specified `CTL1` or `CTL2` for the alert_type parameter, specify a value in the range from 1 to 256. If this parameter is omitted, alert information will be obtained starting from the first alert. Required for the Get alerts information task.
alert_type string	Type of the alerts. This field is valid when query field is `alerts`. Then this field is required. Possible value is one of, `DKC`, `CTL1`, `CTL2` Required for the Get alerts information task. Choices: `"DKC"` `"CTL1"` `"CTL2"`
include_component_option boolean	This field is valid when query field is `hardware_installed`. Then this field is optional. If set to true, it will bring the information about the components, otherwise not. Required for the Get Hardware Installed information task. Choices: `false` `true`
query string / required	Specify the component for which you want the monitor information from the storage system. Possible value is one of, `alerts`, `hardware_installed`, `channel_boards`. Required for the Get alerts information /Get Hardware Installed information /Get Channel Boards information tasks. Choices: `"alerts"` `"hardware_installed"` `"channel_boards"`

Attributes

Attribute	Support	Description
check_mode	Support: full	Determines if the module should run in check mode.

Notes

Note

Connection type gateway was removed starting from version 3.4.0. Please use an earlier version if you require this connection type.

Examples

- name: Get alerts information
  hitachivantara.vspone_block.vsp.hv_storage_system_monitor_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      alert_type: "CTL1"
      alert_start_number: 1
      alert_count: 2
      query: "alerts"

- name: Get Hardware Installed information
  hitachivantara.vspone_block.vsp.hv_storage_system_monitor_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      query: "hardware_installed"
      include_component_option: false

- name: Get Channel Boards information
  hitachivantara.vspone_block.vsp.hv_storage_system_monitor_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      query: "channel_boards"

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
alerts list / elements=dictionary	The alerts information. Returned: success
action_codes dictionary	The following information related to the action code of the alert is displayed. Returned: success
acc_location string	The location of the component in which the error occurred is displayed. Returned: success Sample: `"-"`
action_code integer	Action code. Returned: success Sample: `1492123648`
possible_failure_parts string	The name of the part that is assumed to be the cause of the error is displayed. Returned: success Sample: `"TSC CALL"`
alert_id integer	Alert ID. Returned: success Sample: `1`
alertIndex string	Character string that uniquely identifies an alert. Returned: success Sample: `"134fe7104e8b-0f06a-7d1700"`
error_detail string	Details of the alert. Returned: success Sample: `"Failed ESM force stop succeeded"`
error_level string	One of the following values is displayed as the error level. Service, Moderate, Serious, Acute. Returned: success Sample: `"Moderate"`
error_section string	Information about where the alert occurred. Returned: success Sample: `"ESM detection error"`
location string	The location of the component or part for which the error occurred. Returned: success Sample: `"CTL01"`
occurence_time string	Date and time when the alert occurred. Returned: success Sample: `"2025-02-25T05:35:07"`
reference_code integer	SIM reference code (in decimal number format). Returned: success Sample: `8197888`
storage_serial_number string	The serial number of the storage. Returned: success Sample: `"810045"`

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/vsp.hv_storage_system_monitor_facts_module.html