ansible.builtin.purefa_hg (v2.9.27) — module

Manage hostgroups on Pure Storage FlashArrays

| "added in version" 2.4 of ansible.builtin"

Authors: Pure Storage ansible Team (@sdodsley) <pure-ansible-team@purestorage.com>

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

Create, delete or modify hostgroups on Pure Storage FlashArrays.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create empty hostgroup
  purefa_hg:
    hostgroup: foo
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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

Inputs

    
host:
    description:
    - List of existing hosts to add to hostgroup.
    type: list

state:
    choices:
    - absent
    - present
    default: present
    description:
    - Define whether the hostgroup should exist or not.
    type: str

fa_url:
    description:
    - FlashArray management IPv4 address or Hostname.
    required: true
    type: str

volume:
    description:
    - List of existing volumes to add to hostgroup.
    type: list

api_token:
    description:
    - FlashArray API token for admin privileged user.
    required: true
    type: str

hostgroup:
    description:
    - The name of the hostgroup.
    required: true
    type: str