hitachivantara.vspone_block.vsp.hv_nvm_subsystems module – Manages NVM subsystems on 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_nvm_subsystems.

New in hitachivantara.vspone_block 3.2.0

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Return Values

Synopsis

This module allows creation, deletion, and other operations on NVM subsystems on VSP block storage systems.
For examples go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/nvm_subsystems.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.
password string	Password for authentication. This is a required field.
username string	Username for authentication. This is a required field.
spec dictionary / required	Specification for the NVM subsystems to be used.
enable_namespace_security boolean	Namespace security settings. Required for the Create an NVM Subsystem with a specific ID task. Optional for the Create an NVM Subsystem with a free ID task. Choices: `false` `true` ← (default)
force boolean	This flag is used to force the operation. Required for the Remove namespace from an NVM Subsystem with specific Id or Name using force /Remove host NQNs from an NVM Subsystem with a specific Id or Name using force /Delete an NVM Subsystem with a specific Id forcefully /Delete an NVM Subsystem with a specific name forcefully tasks. Choices: `false` ← (default) `true`
host_mode string	The host mode of the NVM subsystem. Required for the Create an NVM Subsystem with a specific ID /Create an NVM Subsystem with a free ID tasks.
host_nqns list / elements=dictionary	The host NQNs of the NVM subsystem. Required for the Create an NVM Subsystem with a specific ID /Add host NQNs to an NVM Subsystem with a specific ID /Add host NQNs to an NVM Subsystem with a specific Name /Remove host NQNs from an NVM Subsystem with a specific Id or Name /Remove host NQNs from an NVM Subsystem with a specific Id or Name using force /Update host NQNs nickname of an NVM Subsystem with a specific Id or Name tasks. Optional for the Create an NVM Subsystem with a free ID task.
id integer	The ID of the NVM subsystem. Required for the Create an NVM Subsystem with a specific ID /Add host NQNs to an NVM Subsystem with a specific ID /Add namespaces and namespace paths to an NVM Subsystem with a specific ID /Add ports to an NVM Subsystem with a specific ID /Remove ports from an NVM Subsystem with a specific Name or ID /Remove namespace paths from an NVM Subsystem with specific Id or Name /Remove namespace from an NVM Subsystem with specific Id or Name /Remove namespace from an NVM Subsystem with specific Id or Name using force /Remove host NQNs from an NVM Subsystem with a specific Id or Name /Remove host NQNs from an NVM Subsystem with a specific Id or Name using force /Update host NQNs nickname of an NVM Subsystem with a specific Id or Name /Update namespace nicknames of an NVM Subsystem with a specific Id or Name /Delete an NVM Subsystem with a specific Id /Delete an NVM Subsystem with a specific Id forcefully tasks.
name string	The name of the NVM subsystem.If not given, it assigns the name of the NVM subsystem to “smrha-<10 digit random number>”. Optional for the Create an NVM Subsystem with a specific ID /Create an NVM Subsystem with a free ID tasks. Required for the Add host NQNs to an NVM Subsystem with a specific Name /Add namespaces and namespace paths to an NVM Subsystem with a specific name /Add ports to an NVM Subsystem with a specific Name /Remove ports from an NVM Subsystem with a specific Name or ID /Remove namespace from an NVM Subsystem with specific Id or Name /Remove namespace from an NVM Subsystem with specific Id or Name using force /Remove host NQNs from an NVM Subsystem with a specific Id or Name /Remove host NQNs from an NVM Subsystem with a specific Id or Name using force /Update host NQNs nickname of an NVM Subsystem with a specific Id or Name /Update namespace nicknames of an NVM Subsystem with a specific Id or Name /Delete an NVM Subsystem with a specific name /Delete an NVM Subsystem with a specific name forcefully tasks.
namespaces list / elements=dictionary	The namespaces of the NVM subsystem. Required for the Create an NVM Subsystem with a specific ID /Add namespaces and namespace paths to an NVM Subsystem with a specific ID /Add namespaces and namespace paths to an NVM Subsystem with a specific name /Remove namespace paths from an NVM Subsystem with specific Id or Name /Remove namespace from an NVM Subsystem with specific Id or Name /Remove namespace from an NVM Subsystem with specific Id or Name using force /Update namespace nicknames of an NVM Subsystem with a specific Id or Name tasks. Optional for the Create an NVM Subsystem with a free ID task.
ldev_id string / required	The LDEV ID of the namespace. Can be decimal or hexadecimal. Required for the Create an NVM Subsystem with a specific ID /Create an NVM Subsystem with a free ID /Add namespaces and namespace paths to an NVM Subsystem with a specific ID /Add namespaces and namespace paths to an NVM Subsystem with a specific name /Remove namespace paths from an NVM Subsystem with specific Id or Name /Remove namespace from an NVM Subsystem with specific Id or Name /Remove namespace from an NVM Subsystem with specific Id or Name using force /Update namespace nicknames of an NVM Subsystem with a specific Id or Name tasks.
nickname string	The nickname of the namespace. Required for the Create an NVM Subsystem with a specific ID /Create an NVM Subsystem with a free ID /Add namespaces and namespace paths to an NVM Subsystem with a specific ID /Add namespaces and namespace paths to an NVM Subsystem with a specific name /Remove namespace paths from an NVM Subsystem with specific Id or Name /Remove namespace from an NVM Subsystem with specific Id or Name /Remove namespace from an NVM Subsystem with specific Id or Name using force /Update namespace nicknames of an NVM Subsystem with a specific Id or Name tasks.
paths list / elements=string	The paths of the namespace. Required for the Create an NVM Subsystem with a specific ID /Create an NVM Subsystem with a free ID /Add namespaces and namespace paths to an NVM Subsystem with a specific ID /Add namespaces and namespace paths to an NVM Subsystem with a specific name /Remove namespace paths from an NVM Subsystem with specific Id or Name /Remove namespace from an NVM Subsystem with specific Id or Name /Remove namespace from an NVM Subsystem with specific Id or Name using force /Update namespace nicknames of an NVM Subsystem with a specific Id or Name tasks.
port_ids aliases: ports list / elements=string	The ports of the NVM subsystem. Required for the Create an NVM Subsystem with a specific ID /Create an NVM Subsystem with a free ID /Add ports to an NVM Subsystem with a specific ID /Add ports to an NVM Subsystem with a specific Name /Remove ports from an NVM Subsystem with a specific Name or ID tasks.
state string	The specific operation to perform on the NVM subsystem. `add_port` - Add ports to the NVM subsystem. `remove_port` - Remove ports from the NVM subsystem. `add_host_nqn` - Add host NQNs to the NVM subsystem. `remove_host_nqn` - Remove host NQNs from the NVM subsystem. `add_namespace` - Add namespaces to the NVM subsystem. `remove_namespace` - Remove namespaces from the NVM subsystem. `add_namespace_path` - Add paths to the namespace. `remove_namespace_path` - Remove paths from the namespace. Choices: `"add_port"` `"remove_port"` `"add_host_nqn"` `"remove_host_nqn"` `"add_namespace"` `"remove_namespace"` `"add_namespace_path"` `"remove_namespace_path"`
state string	The desired state of the NVM subsystem. Choices: `"present"` ← (default) `"absent"`
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: none	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: Create an NVM Subsystem
  hitachivantara.vspone_block.vsp.hv_nvm_subsystems:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    state: "present"
    spec:
      name: "nvm_tcp_01"
      id: 1000
      host_mode: "VMWARE_EX"
      enable_namespace_security: true
      port_ids: ["CL1-D"]
      host_nqns:
        - nqn: "nqn.2014-08.org.example:uuid:4b73e622-ddc1-449a-99f7-412c0d3baa40"
          nickname: "my_host_nqn_40"
      namespaces:
        - ldev_id: 11101
          nickname: "nickname"
          paths: ["nqn.2014-08.org.example:uuid:4b73e622-ddc1-449a-99f7-412c0d3baa40"]

- name: Add host NQNs to an NVM Subsystem with a specific ID
  hitachivantara.vspone_block.vsp.hv_nvm_subsystems:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      id: 1000
      state: "add_host_nqn"
      host_nqns:
        - nqn: "nqn.2014-08.org.example:uuid:4b73e622-ddc1-449a-99f7-412c0d3baa41"
          nickname: "my_host_nqn_41"

- name: Remove host NQNs from an NVM Subsystem with a specific ID
  hitachivantara.vspone_block.vsp.hv_nvm_subsystems:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      id: 1000
      state: "remove_host_nqn"
      host_nqns:
        - nqn: "nqn.2014-08.org.example:uuid:4b73e622-ddc1-449a-99f7-412c0d3baa41"
          nickname: "my_host_nqn_41"

- name: Delete an NVM Subsystem with a specific Id forcefully
  hitachivantara.vspone_block.vsp.hv_nvm_subsystems:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    state: "absent"
    spec:
      id: "nvm_subsystems_id_18"
      force: true

Return Values

Common return values are documented here, the following are the fields unique to this module:

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.com.ucpa-sc-hv:nvme:scpodl-esxi235"`
host_nqn_nickname string	Nickname for the host NQN. Returned: success Sample: `""`
namespace_paths_info list / elements=dictionary	List of namespace paths information. Returned: success
host_nqn string	Host NQN. Returned: success Sample: `"nqn.2014-08.com.ucpa-sc-hv:nvme:scpodl-esxi235"`
ldev_id integer	Logical device ID. Returned: success Sample: `5555`
ldev_id_hex string	Logical device hex ID. Returned: success Sample: `"00:15:B3"`
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: `20971520`
capacity_in_mb float	Capacity in MB. Returned: success Sample: `10240.0`
capacity_in_unit string	Capacity in human-readable unit. Returned: success Sample: `"10.00GB"`
ldev_id integer	Logical device ID. Returned: success Sample: `2000`
ldev_id_hex string	Logical device hex ID. Returned: success Sample: `"00:07:D0"`
namespace_id integer	Namespace ID. Returned: success Sample: `2`
namespace_nickname string	Nickname for the namespace. Returned: success Sample: `""`
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: `1`
nvm_subsystem_name string	NVM subsystem name. Returned: success Sample: `"NVME-TCP-CL1-D-01"`
resource_group_id integer	Resource group ID. Returned: success Sample: `8`
t10pi_mode string	T10PI mode. Returned: success Sample: `"Disable"`
port_info 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: `"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_nvm_subsystems_module.html