W3cubDocs

/Ansible

purefa_host - Manage hosts on Pure Storage FlashArrays

New in version 2.4.

Synopsis

  • Create, delete or modify hosts 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
 yes
The name of the host.
iqn
 no
List of IQNs of the host if protocol is iscsi.
protocol
 no iscsi
  • fc
  • iscsi
Defines the host connection protocol for volumes.
state
 no present
  • absent
  • present
Define whether the host should exist or not.
When removing host all connected volumes will be disconnected.
volume
 no
Volume name to map to the host.
wwns
 no
List of wwns of the host if protocol is fc.

Examples

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

- name: Delete host
  purefa_host:
    host: foo
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: absent

- name: Make sure host bar is available with wwn ports
  purefa_host:
    host: bar
    protocol: fc
    wwns:
    - 00:00:00:00:00:00:00
    - 11:11:11:11:11:11:11
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Make sure host bar is available with iSCSI ports
  purefa_host:
    host: bar
    protocol: iscsi
    iqn:
    - iqn.1994-05.com.redhat:7d366003913
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Map host foo to volume bar
  purefa_host:
    host: foo
    volume: bar
    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.

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/purefa_host_module.html