- Docs »
- purefa_host - Manage hosts on Pure Storage FlashArrays
-
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_host - Manage hosts on Pure Storage FlashArrays
- Create, delete or modify hosts on Pure Storage FlashArrays.
The below requirements are needed on the host that executes this module.
- python >= 2.7
- purestorage
Parameter |
Choices/Defaults |
Comments |
api_token
required |
|
FlashArray API token for admin privilaged user.
|
fa_url
required |
|
FlashArray management IPv4 address or Hostname.
|
host
required |
|
The name of the host.
|
iqn
|
|
List of IQNs of the host if protocol is iscsi or mixed.
|
protocol
|
Choices:
- fc
iscsi ←
- mixed
|
Defines the host connection protocol for volumes.
|
state
|
Choices:
- absent
present ←
|
Define whether the host should exist or not.
When removing host all connected volumes will be disconnected.
|
volume
|
|
Volume name to map to the host.
|
wwns
|
|
List of wwns of the host if protocol is fc or mixed.
|
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
- 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 host bar 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 host bar 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: Make mixed protocol host
purefa_host:
host: bar
protocol: mixed
iqn:
- iqn.1994-05.com.redhat:7d366003914
wwns:
- 00:00:00:00:00:00:01
- 11:11:11:11:11:11:12
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
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
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.
- Simon Dodsley (@sdodsley)
Hint
If you notice any issues in this documentation you can edit this document to improve it.