W3cubDocs

/Ansible

hitachivantara.vspone_block.vsp.hv_nvm_subsystems_facts module – Retrieves information about NVM subsystems from Hitachi VSP storage systems.

Note

This module is part of the hitachivantara.vspone_block collection (version 3.5.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_nvm_subsystems_facts.

New in hitachivantara.vspone_block 3.1.0

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Returned Facts

Synopsis

This module gathers facts about NVM subsystems from Hitachi VSP storage systems.
For examples go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/nvm_subsystem_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.
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	Specification for the NVM subsystems facts to be gathered.
id integer	The ID of the NVM subsystem to retrieve.
name string	The name of the NVM subsystem to retrieve.
storage_system_info dictionary	Information about the storage system. This field is an optional field.
serial string	The serial number of the storage system.

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 all NVM subsystems
  hitachivantara.vspone_block.vsp.hv_nvm_subsystems_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"

- name: Get a specific NVM subsystem
  hitachivantara.vspone_block.vsp.hv_nvm_subsystems_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      name: "Nvm_subsystem_01"

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
nvm_subsystems list / elements=dictionary	The NVM subsystem information. Returned: success
host_nqn_info list / elements=dictionary	List of host NQN information. Returned: success
host_nqn string	Host NQN. Returned: success Sample: `"nqn.2014-08.org.example:uuid:4b73e622-ddc1-449a-99f7-412c0d3baa40"`
host_nqn_nickname string	Nickname for the host NQN. Returned: success Sample: `"my_host_nqn_40"`
namespace_paths_info list / elements=dictionary	List of namespace paths information. Returned: success
host_nqn string	Host NQN. Returned: success Sample: `"nqn.2014-08.org.example:uuid:4b73e622-ddc1-449a-99f7-412c0d3baa40"`
ldev_hex_id string	Logical device hex ID. Returned: success Sample: `"00:2b:5c"`
ldev_id integer	Logical device ID. Returned: success Sample: `11101`
namespace_id integer	Namespace ID. Returned: success Sample: `3`
namespaces_info list / elements=dictionary	List of namespaces information. Returned: success
block_capacity integer	Block capacity of the namespace. Returned: success Sample: `23068672`
capacity_in_unit string	Capacity in human-readable unit. Returned: success Sample: `"11.00 G"`
ldev_hex_id string	Logical device hex ID. Returned: success Sample: `"00:2b:5c"`
ldev_id integer	Logical device ID. Returned: success Sample: `11101`
namespace_id integer	Namespace ID. Returned: success Sample: `3`
namespace_nickname string	Nickname for the namespace. Returned: success Sample: `"nickname"`
nvm_subsystem_info dictionary	Information about the NVM subsystem. Returned: success
host_mode string	Host mode. Returned: success Sample: `"VMWARE_EX"`
namespace_security_setting string	Namespace security setting. Returned: success Sample: `"Enable"`
nvm_subsystem_id integer	NVM subsystem ID. Returned: success Sample: `1000`
nvm_subsystem_name string	NVM subsystem name. Returned: success Sample: `"nvm_tcp_01"`
resource_group_id integer	Resource group ID. Returned: success Sample: `0`
t10pi_mode string	T10PI mode. Returned: success Sample: `"Disable"`
port list / elements=dictionary	List of port information. Returned: success
port_id string	Port ID. Returned: success Sample: `"CL1-D"`
port_type string	Port type. Returned: success Sample: `"NVME_TCP"`
storage_serial_number string	The serial number of the storage system. Returned: success Sample: `"810005"`

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/ansible/latest/collections/hitachivantara/vspone_block/vsp.hv_nvm_subsystems_facts_module.html