You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

ibm.spectrum_virtualize.ibm_svc_host module – This module manages hosts on IBM Spectrum Virtualize family storage systems

Note

This module is part of the ibm.spectrum_virtualize collection (version 1.10.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 ibm.spectrum_virtualize.

To use it in a playbook, specify: ibm.spectrum_virtualize.ibm_svc_host.

New in ibm.spectrum_virtualize 1.0.0

Synopsis

• Ansible interface to manage ‘mkhost’, ‘chhost’, and ‘rmhost’ host commands.

Parameters

Parameter	Comments
clustername string / required	The hostname or management IP of the Spectrum Virtualize storage system.
domain string	Domain for the Spectrum Virtualize storage system. Valid when hostname is used for the parameter clustername.
fcwwpn string	List of Initiator WWPNs to be added to the host. The complete list of WWPNs must be provided. The parameters fcwwpn and iscsiname are mutually exclusive. Required when state=present, to create or modify a Fibre Channel (FC) host.
hostcluster string added in ibm.spectrum_virtualize 1.5.0	Specifies the name of the host cluster to which the host object is to be added. A host cluster must exist before a host object can be added to it. Parameters hostcluster and nohostcluster are mutually exclusive. Valid when state=present, to create or modify a host.
iogrp string	Specifies a set of one or more input/output (I/O) groups from which the host can access the volumes. Once specified, this parameter cannot be modified. Valid when state=present, to create a host.
iscsiname string	Initiator IQN to be added to the host. The parameters fcwwpn and iscsiname are mutually exclusive. Valid when state=present, to create host.
log_path string	Path of debug log file.
name string / required	Specifies a name or label for the new host object.
nohostcluster boolean added in ibm.spectrum_virtualize 1.5.0	If specified as True, host object is removed from the host cluster. Parameters hostcluster and nohostcluster are mutually exclusive. Valid when state=present, to modify an existing host. Choices: false true
old_name string added in ibm.spectrum_virtualize 1.9.0	Specifies the old name of the host while renaming. Valid when state=present, to rename an existing host.
password string	REST API password for the Spectrum Virtualize storage system. The parameters username and password are required if not using token to authenticate a user.
protocol string	Specifies the protocol used by the host to communicate with the storage system. Only ‘scsi’ protocol is supported. Valid when state=present, to create a host.
site string	Specifies the site name of the host. Valid when state=present, to create or modify a host.
state string / required	Creates or updates (present) or removes (absent) a host. Choices: "absent" "present"
token string added in ibm.spectrum_virtualize 1.5.0	The authentication token to verify a user on the Spectrum Virtualize storage system. To generate a token, use the ibm.spectrum_virtualize.ibm_svc_auth module.
type string	Specifies the type of host. Valid when state=present, to create or modify a host.
username string	REST API username for the Spectrum Virtualize storage system. The parameters username and password are required if not using token to authenticate a user.
validate_certs boolean	Validates certification. Choices: false ← (default) true

Notes

Note

• This module supports check_mode.

Examples

- name: Define a new iSCSI host
  ibm.spectrum_virtualize.ibm_svc_host:
    clustername: "{{clustername}}"
    domain: "{{domain}}"
    username: "{{username}}"
    password: "{{password}}"
    log_path: /tmp/playbook.debug
    name: host4test
    state: present
    iscsiname: iqn.1994-05.com.redhat:2e358e438b8a
    iogrp: 0:1:2:3
    protocol: scsi
    type: generic
    site: site-name
- name: Add a host to an existing host cluster
  ibm.spectrum_virtualize.ibm_svc_host:
    clustername: "{{clustername}}"
    domain: "{{domain}}"
    username: "{{username}}"
    password: "{{password}}"
    log_path: /tmp/playbook.debug
    name: host4test
    state: present
    hostcluster: hostcluster0
- name: Define a new FC host
  ibm.spectrum_virtualize.ibm_svc_host:
    clustername: "{{clustername}}"
    domain: "{{domain}}"
    username: "{{username}}"
    password: "{{password}}"
    log_path: /tmp/playbook.debug
    name: host4test
    state: present
    fcwwpn: 100000109B570216:1000001AA0570266
    iogrp: 0:1:2:3
    protocol: scsi
    type: generic
    site: site-name
- name: Rename an existing host
  ibm.spectrum_virtualize.ibm_svc_host:
    clustername: "{{ clustername }}"
    domain: "{{ domain }}"
    username: "{{ username }}"
    password: "{{ password }}"
    old_name: "host4test"
    name: "new_host_name"
    state: "present"
- name: Delete a host
  ibm.spectrum_virtualize.ibm_svc_host:
    clustername: "{{clustername}}"
    domain: "{{domain}}"
    username: "{{username}}"
    password: "{{password}}"
    log_path: /tmp/playbook.debug
    name: new_host_name
    state: absent

Authors

• Sreshtant Bohidar (@Sreshtant-Bohidar)

• Rohit Kumar (@rohitk-github)

Collection links

Issue Tracker Repository (Sources)