hitachivantara.vspone_block.vsp.hv_supported_host_mode_facts module – Retrieves supported host mode options information from a specified VSP block storage system.

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_supported_host_mode_facts.

New in hitachivantara.vspone_block 4.6.0

Synopsis
Requirements
Parameters
Attributes
Examples
Returned Facts

Synopsis

This module fetches detailed information about supported host mode options available in a given VSP block storage system.
For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/supported_host_mode_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	Token used 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.
username string	Username for authentication. This is a required field.

Attributes

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

Examples

- name: Get all host groups
  hitachivantara.vspone_block.vsp.hv_supported_host_mode_facts:
    connection_info:
      address: storage1.company.com
      username: "dummy_user"
      password: "dummy_password"

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
host_modes dictionary	Information about supported host modes and options. Returned: always
host_mode_options list / elements=dictionary	List of supported host mode options. Returned: always
host_mode_option_description string	Description of the host mode option. Returned: success Sample: `"VERITAS Database Edition/Advanced Cluster"`
host_mode_option_id integer	ID of the host mode option. Returned: success Sample: `2`
required_host_modes list / elements=string	List of required host modes for this option. Returned: success Sample: `[]`
scope string	Scope of the host mode option. Returned: success Sample: `""`
host_modes list / elements=dictionary	List of supported host modes. Returned: always
host_mode_display string	Display name of the host mode. Returned: success Sample: `"LINUX/IRIX"`
host_mode_id integer	ID of the host mode. Returned: success Sample: `0`
host_mode_name string	Name of the host mode. Returned: success Sample: `"Standard"`

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_supported_host_mode_facts_module.html