hitachivantara.vspone_block.vsp.hv_hg module – Manages host group on Hitachi VSP storage system.

Note

This module is part of the hitachivantara.vspone_block collection (version 3.4.0).

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

New in hitachivantara.vspone_block 3.0.0

Synopsis

• This module provides the following host group management operations

• 1. create host group.

• 2. delete host group.

• 3. add logical unit to host group.

• 4. remove logical unit from host group.

• 5. add host WWN to host group.

• 6. remove host WWN from host group.

• 7. set host mode.

• 8. add host mode option to host group.

• 9. remove host mode option from host group.

• For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/hostgroup.yml

Requirements

The below requirements are needed on the host that executes this module.

• python >= 3.8

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.
username string	Username for authentication. This is a required field.
spec dictionary	Specification for hostgroup operation.
host_mode string	Host mode of host group. Choices: "LINUX" "VMWARE" "HP" "OPEN_VMS" "TRU64" "SOLARIS" "NETWARE" "WINDOWS" "HI_UX" "AIX" "VMWARE_EXTENSION" "WINDOWS_EXTENSION" "UVM" "HP_XP" "DYNIX"
host_mode_options list / elements=integer	List of host group host mode option numbers. 0 # RESERVED 2 # VERITAS_DB_EDITION_ADV_CLUSTER 6 # TPRLO 7 # AUTO_LUN_RECOGNITION 12 # NO_DISPLAY_FOR_GHOST_LUN 13 # SIM_REPORT_AT_LINK_FAILURE 14 # HP_TRUECLUSTER_WITH_TRUECOPY 15 # RAID_HACMP 22 # VERITAS_CLUSTER_SERVER 23 # REC_COMMAND_SUPPORT 25 # SUPPORT_SPC_3_PERSISTENT_RESERVATION 33 # SET_REPORT_DEVICE_ID_ENABLE 39 # CHANGE_NEXUS_SPECIFIED_IN_SCSI_TARGET_RESET 40 # VVOL_EXPANSION 41 # PRIORITIZED_DEVICE_RECOGNITION 42 # PREVENT_OHUB_PCI_RETRY 43 # QUEUE_FULL_RESPONSE 48 # HAM_SVOL_READ 49 # BB_CREDIT_SETUP_1 50 # BB_CREDIT_SETUP_2 51 # ROUND_TRIP_SETUP 52 # HAM_AND_CLUSTER_SW_FOR_SCSI_2 54 # EXTENDED_COPY 57 # HAM_RESPONSE_CHANGE 60 # LUN0_CHANGE_GUARD 61 # EXPANDED_PERSISTENT_RESERVE_KEY 63 # VSTORAGE_APIS_ON_T10_STANDARDS 65 # ROUND_TRIP_EXTENDED_SETUP 67 # CHANGE_OF_ED_TOV_VALUE 68 # PAGE_RECLAMATION_LINUX 69 # ONLINE_LUSE_EXPANSION 71 # CHANGE_UNIT_ATTENTION_FOR_BLOCKED_POOL_VOLS 72 # AIX_GPFS 73 # WS2012 78 # NON_PREFERRED_PATH 91 # DISABLE_IO_WAIT_FOR_OPEN_STACK 95 # CHANGE_SCSI_LU_RESET_NEXUS_VSP_HUS_VM 96 # CHANGE_SCSI_LU_RESET_NEXUS 97 # PROPRIETARY_ANCHOR_COMMAND_SUPPORT 100 # HITACHI_HBA_EMULATION_CONNECTION_OPTION 102 # GAD_STANDARD_INQURY_EXPANSION_HCS 105 # TASK_SET_FULL_RESPONSE_FOR_IO_OVERLOAD 110 # ODX Support for WS2012 113 # iSCSI CHAP Authentication Log 114 # Auto Asynchronous Reclamation on ESXi 6.5+ 122 # TASK_SET_FULL_RESPONSE_AFTER_QOS_UPPER_LIMIT 124 # GUARANTEED_RESPONSE_DURING_CONTROLLER_FAILURE 131 # WCE_BIT_OFF_MODE
ldevs list / elements=string	LDEVs to be mapped/unmapped with the host group. Supported format can be decimal or HEX.
name string	Name of the host group. If not given, it will create the name with prefix “smrha-” and add 10 digit random number at the end, for example “smrha-0806262996”.
port string / required	FC Port.
should_delete_all_ldevs boolean	If the value is true, destroy the logical devices that are no longer attached to any host group or iSCSI target. Choices: false true
state string	Subtask operation. Choices: "present_ldev" "unpresent_ldev" "add_wwn" "remove_wwn" "set_host_mode_and_hmo" "present" ← (default)
wwns list / elements=string	List of host WWN to add or remove.
state string	Set state to present for create and update host group Set state to absent for delete host group 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.

Examples

- name: Create host group with LUN in decimal
  hitachivantara.vspone_block.vsp.hv_hg:
    state: present
    connection_info:
      address: storage1.company.com
      username: "dummy_user"
      password: "dummy_password"
    spec:
      name: 'testhg26dec'
      port: 'CL1-A'
      host_mode: 'VMWARE_EXTENSION'
      host_mode_options: [40]
      wwns: ['100000109B583B2D', '100000109B583B2C']
      ldevs: [393, 851]

- name: Create host group with LUN in HEX
  hitachivantara.vspone_block.vsp.hv_hg:
    state: present
    connection_info:
      address: storage1.company.com
      username: "dummy_user"
      password: "dummy_password"
    host_group_info:
      name: 'testhg26dec'
      port: 'CL1-A'
      host_mode: 'VMWARE_EXTENSION'
      host_mode_options: [54, 63]
      wwns: ['100000109B583B2D', '100000109B583B2C']
      ldevs: ['00:23:A4']

- name: Delete host group
  hitachivantara.vspone_block.vsp.hv_hg:
    state: absent
    connection_info:
      address: storage1.company.com
      username: "dummy_user"
      password: "dummy_password"
    spec:
      name: 'testhg26dec'
      port: 'CL1-A'

- name: Present LUN
  hitachivantara.vspone_block.vsp.hv_hg:
    state: present
    connection_info:
      address: storage1.company.com
      username: "dummy_user"
      password: "dummy_password"
    spec:
      state: present_ldev
      name: 'testhg26dec'
      port: 'CL1-A'
      ldevs: ['00:05:77', '00:05:7D']

- name: Unpresent LUN
  hitachivantara.vspone_block.vsp.hv_hg:
    state: present
    connection_info:
      address: storage1.company.com
      username: "dummy_user"
      password: "dummy_password"
    spec:
      state: unpresent_ldev
      name: 'testhg26dec'
      port: 'CL1-A'
      ldevs: [800, 801]

- name: Add WWN
  hitachivantara.vspone_block.vsp.hv_hg:
    state: present
    connection_info:
      address: storage1.company.com
      username: "dummy_user"
      password: "dummy_password"
    spec:
      state: add_wwn
      name: 'testhg26dec'
      port: 'CL1-A'
      wwns: ['200000109B3C0FD3']

- name: Remove WWN
  hitachivantara.vspone_block.vsp.hv_hg:
    state: present
    connection_info:
      address: storage1.company.com
      username: "dummy_user"
      password: "dummy_password"
    spec:
      state: remove_wwn
      name: 'testhg26dec'
      port: 'CL1-A'
      wwns: ['200000109B3C0FD3']

- name: Update host group
  hitachivantara.vspone_block.vsp.hv_hg:
    state: present
    connection_info:
      address: storage1.company.com
      username: "dummy_user"
      password: "dummy_password"
    spec:
      state: set_host_mode_and_hmo
      name: 'testhg26dec'
      port: 'CL1-A'
      host_mode: 'VMWARE_EXTENSION'
      host_mode_options: [54, 63]

Return Values

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

Key	Description
hostGroups dictionary	Information of host group. Returned: always
host_group_id integer	ID of the host group. Returned: success Sample: 93
host_group_name string	Name of the host group. Returned: success Sample: "ansible-test-hg"
host_mode string	Host mode of the host group. Returned: success Sample: "STANDARD"
host_mode_options list / elements=dictionary	List of host mode options for the host group. Returned: success
host_mode_option string	Name of the host mode option. Returned: success Sample: "EXTENDED_COPY"
host_mode_option_number integer	Number of the host mode option. Returned: success Sample: 54
lun_paths list / elements=dictionary	List of LUN paths for the host group. Returned: success
ldevId integer	ID of the logical device. Returned: success Sample: 166
lunId integer	ID of the LUN. Returned: success Sample: 0
port string	Port associated with the host group. Returned: success Sample: "CL1-A"
resource_group_id integer	Resource group ID associated with the host group. Returned: success Sample: 0
storage_id string	Storage ID associated with the host group. Returned: success Sample: "storage-39f4eef0175c754bb90417358b0133c3"
wwns list / elements=dictionary	List of WWNs associated with the host group. Returned: success
id string	ID of the WWN. Returned: success Sample: "1212121212121212"
name string	Name of the WWN. Returned: success Sample: ""

Authors

• Hitachi Vantara LTD (@hitachi-vantara)

Collection links

• Issue Tracker
• Repository (Sources)