ibm.storage_virtualize.ibm_svc_hostcluster (2.3.1) — module

Install collection

Install with ansible-galaxy collection install ibm.storage_virtualize:==2.3.1

Add to requirements.yml

  collections:
    - name: ibm.storage_virtualize
      version: 2.3.1

Description

Ansible interface to manage 'mkhostcluster', 'chhostcluster' and 'rmhostcluster' host commands.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Define a new host cluster
  ibm.storage_virtualize.ibm_svc_hostcluster:
    clustername: "{{clustername}}"
    domain: "{{domain}}"
    username: "{{username}}"
    password: "{{password}}"
    log_path: /tmp/playbook.debug
    name: hostcluster0
    state: present
    ownershipgroup: group1

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Update the ownershipgroup of a host cluster
  ibm.storage_virtualize.ibm_svc_hostcluster:
    clustername: "{{clustername}}"
    domain: "{{domain}}"
    username: "{{username}}"
    password: "{{password}}"
    log_path: /tmp/playbook.debug
    name: hostcluster0
    state: present
    noownershipgroup: True

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Delete a host cluster
  ibm.storage_virtualize.ibm_svc_hostcluster:
    clustername: "{{clustername}}"
    domain: "{{domain}}"
    username: "{{username}}"
    password: "{{password}}"
    log_path: /tmp/playbook.debug
    name: hostcluster0
    state: absent
    removeallhosts: True

Inputs

    
name:
    description:
    - Specifies a name or label for the new host cluster object.
    required: true
    type: str

state:
    choices:
    - absent
    - present
    description:
    - Creates (C(present)) or removes (C(absent)) a host cluster.
    required: true
    type: str

token:
    description:
    - The authentication token to verify a user on the Storage Virtualize system.
    - To generate a token, use the M(ibm.storage_virtualize.ibm_svc_auth) module.
    type: str

domain:
    description:
    - Domain for the Storage Virtualize system.
    - Valid when hostname is used for the parameter I(clustername).
    type: str

log_path:
    description:
    - Path of debug log file.
    type: str

password:
    description:
    - REST API password for the Storage Virtualize system.
    - The parameters I(username) and I(password) are required if not using I(token) to
      authenticate a user.
    type: str

username:
    description:
    - REST API username for the Storage Virtualize system.
    - The parameters I(username) and I(password) are required if not using I(token) to
      authenticate a user.
    type: str

clustername:
    description:
    - The hostname or management IP of the Storage Virtualize system.
    required: true
    type: str

ownershipgroup:
    description:
    - The name of the ownership group to which the host cluster object is being added.
    - Parameters I(ownershipgroup) and I(noownershipgroup) are mutually exclusive.
    - Applies when I(state=present).
    type: str
    version_added: 1.6.0
    version_added_collection: ibm.storage_virtualize

removeallhosts:
    description:
    - Specifies that all hosts in the host cluster and the associated host cluster object
      be deleted.
    - Applies when I(state=absent).
    type: bool

validate_certs:
    default: false
    description:
    - Validates certification.
    type: bool

noownershipgroup:
    description:
    - If specified True, the host cluster object is removed from the ownership group to
      which it belongs.
    - Parameters I(ownershipgroup) and I(noownershipgroup) are mutually exclusive.
    - Applies when I(state=present) to modify an existing hostcluster.
    type: bool
    version_added: 1.6.0
    version_added_collection: ibm.storage_virtualize