purefa_hg - Manage hostgroups on Pure Storage FlashArrays¶

New in version 2.4.

Synopsis
- Requirements
Parameters
Notes
Examples
Status
Maintenance
- Author

Synopsis ¶

Create, delete or modifiy hostgroups on Pure Storage FlashArrays.

Requirements ¶

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

python >= 2.7
purestorage

Parameters ¶

Parameter	Choices/Defaults	Comments
api_token required		FlashArray API token for admin privilaged user.
fa_url required		FlashArray management IPv4 address or Hostname.
host		List of existing hosts to add to hostgroup.
hostgroup required		The name of the hostgroup.
state	Choices: absent present ←	Define whether the hostgroup should exist or not.
volume		List of existing volumes to add to hostgroup.

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

Examples ¶

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

- name: Add hosts and volumes to existing or new hostgroup
  purefa_hg:
    hostgroup: foo
    host:
      - host1
      - host2
    volume:
      - vol1
      - vol2
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Delete hosts and volumes from hostgroup
  purefa_hg:
    hostgroup: foo
    host:
      - host1
      - host2
    volume:
      - vol1
      - vol2
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: absent

# 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

Status ¶

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

Maintenance ¶

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author ¶

Simon Dodsley (@sdodsley)

Hint

If you notice any issues in this documentation you can edit this document to improve it.