hitachivantara.vspone_block.vsp.hv_cmd_dev module – Manages command devices for 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_cmd_dev.

New in hitachivantara.vspone_block 3.2.0

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Return Values

Synopsis

This module allows to enable and to disable a command device on VSP block storage systems.
It also allows to modify the settings of the command device.
For examples go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/cmd_dev.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.
connection_type string	Type of connection to the storage system. Choices: `"direct"` ← (default)
password string / required	Password for authentication. This is a required field.
username string / required	Username for authentication. This is a required field.
spec dictionary	Specification for the command device.
is_device_group_definition_enabled boolean	Specify whether to enable the device group definition settings for the command device. Choices: `false` `true`
is_security_enabled boolean	Specify whether to enable the security settings for the command device. Choices: `false` `true`
is_user_authentication_enabled boolean	Specify whether to enable the user authentication settings for the command device. Choices: `false` `true`
ldev_id string / required	The id of the LDEV. Required for Enable/Update/Disable tasks. Can be decimal or hexadecimal.
state string	The level of the resource group task. 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: Enable a Command Device
  hitachivantara.vspone_block.vsp.hv_cmd_dev:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      ldev_id: 98
      is_security_enabled: false
      is_user_authentication_enabled: false
      is_device_group_definition_enabled: false

- name: Update the settings of a Command Device
  hitachivantara.vspone_block.vsp.hv_cmd_dev:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      ldev_id: 98
      is_security_enabled: true
      is_user_authentication_enabled: true
      is_device_group_definition_enabled: true

- name: Disable a Command Device
  hitachivantara.vspone_block.vsp.hv_cmd_dev:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    state: absent
    spec:
      ldev_id: 98
      is_security_enabled: false
      is_user_authentication_enabled: false
      is_device_group_definition_enabled: false

Return Values

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

Key	Description
command_device dictionary	The command device information. Returned: always except when state is absent
canonical_name string	Unique identifier for the command device. Returned: success Sample: `"naa.60060e80282742005080274200000078"`
clpr_id integer	CLPR identifier. Returned: success Sample: `0`
compression_acceleration_status string	Compression acceleration status. Returned: success Sample: `""`
data_reduction_process_mode string	Data reduction process mode. Returned: success Sample: `""`
dedup_compression_progress integer	Progress percentage of deduplication and compression. Returned: success Sample: `-1`
dedup_compression_status string	Status of deduplication and compression. Returned: success Sample: `"DISABLED"`
deduplication_compression_mode string	Mode of deduplication and compression. Returned: success Sample: `"disabled"`
emulation_type string	Emulation type of the command device. Returned: success Sample: `"OPEN-V-CVS-CM"`
hostgroups list / elements=dictionary	List of host groups associated with the command device. Returned: success
is_alua boolean	Indicates if ALUA is enabled. Returned: success Sample: `false`
is_command_device boolean	Indicates if it is a command device. Returned: success Sample: `true`
is_compression_acceleration_enabled boolean	Indicates if compression acceleration is enabled. Returned: success
is_data_reduction_share_enabled boolean	Indicates if data reduction share is enabled. Returned: success Sample: `false`
is_device_group_definition_enabled boolean	Indicates if device group definition is enabled. Returned: success
is_encryption_enabled boolean	Indicates if encryption is enabled. Returned: success Sample: `false`
is_full_allocation_enabled boolean	Indicates if full allocation is enabled. Returned: success Sample: `false`
is_relocation_enabled boolean	Indicates if relocation is enabled. Returned: success
is_security_enabled boolean	Indicates if security is enabled. Returned: success
is_user_authentication_enabled boolean	Indicates if user authentication is enabled. Returned: success
is_write_protected boolean	Indicates if the command device is write-protected. Returned: success
is_write_protected_by_key boolean	Indicates if the command device is write-protected by key. Returned: success
iscsi_targets list / elements=dictionary	List of iSCSI targets associated with the command device. Returned: success
ldev_id integer	The ID of the LDEV. Returned: success Sample: `120`
ldev_id_hex string	Logical unit ID in hexadecimal format. Returned: success Sample: `"00:00:78"`
mp_blade_id integer	Management processor blade id. Returned: success Sample: `1`
name string	Name of the command device. Returned: success Sample: `"smrha-120"`
num_of_ports integer	Number of ports associated with the command device. Returned: success Sample: `-1`
nvm_subsystems list / elements=dictionary	List of NVM subsystems associated with the command device. Returned: success
parity_group_id string	ID of the parity group. Returned: success Sample: `""`
path_count integer	Number of paths associated with the command device. Returned: success Sample: `-1`
pool_id integer	ID of the pool. Returned: success Sample: `10`
provision_type string	Provision type of the command device. Returned: success Sample: `"CMD,CVS,HDP"`
qos_settings dictionary	Quality of Service settings for the command device. Returned: success
resource_group_id integer	ID of the resource group. Returned: success Sample: `0`
snapshots list / elements=dictionary	List of snapshots associated with the command device. Returned: success
status string	Status of the command device. Returned: success Sample: `"NML"`
storage_serial_number string	Serial number of the storage system. Returned: success Sample: `"810050"`
tiering_policy dictionary	Tiering policy details. Returned: success Sample: `{}`
total_capacity string	Total capacity of the command device. Returned: success Sample: `"1.00GB"`
total_capacity_in_mb float	Total capacity in megabytes. Returned: success Sample: `1024.0`
used_capacity string	Used capacity of the command device. Returned: success Sample: `"0.00B"`
used_capacity_in_mb float	Used capacity in megabytes. Returned: success Sample: `0.0`
virtual_ldev_id integer	ID of the virtual LDEV. Returned: success Sample: `-1`
virtual_ldev_id_hex string	Virtual LDEV ID in hex format. Returned: success Sample: `""`

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