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.

purefa_hg - Manage hostgroups on Pure Storage FlashArrays¶

New in version 2.4.

Synopsis
Requirements (on host that executes module)
Options
Examples
Notes
- Status

Synopsis ¶

Create, delete or modifiy hostgroups on Pure Storage FlashArrays.

Requirements (on host that executes module)¶

python >= 2.7

purestorage

Options ¶

parameter	required	default	choices	comments
api_token	yes			FlashArray API token for admin privilaged user.
fa_url	yes			FlashArray management IPv4 address or Hostname.
host	no			List of existing hosts to add to hostgroup.
hostgroup	yes			The name of the hostgroup.
state	no	present	absent present	Define whether the hostgroup should exist or not.
volume	no			List of existing volumes to add to hostgroup.

Examples ¶

- name: Create new hostgroup
  purefa_hg:
    hostgroup: foo
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

# This will disconnect all hosts and volumes in the hostgroup
- name: Delete hostgroup
  purefa_hg:
    hostgroup: foo
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: absent

- name: Create host group with hosts and volumes
  purefa_hg:
    hostgroup: bar
    host:
      - host1
      - host2
    volume:
      - vol1
      - vol2
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

Notes ¶

Note

This module requires purestorage python library
You must set PUREFA_URL and PUREFA_API environment variables if url and api_token arguments are not passed to the module directly

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.