purefa_host – Manage hosts on Pure Storage FlashArrays¶
New in version 2.4.
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
-
/ required
|
The name of the host.
|
|
iqn
-
|
List of IQNs of the host if protocol is iscsi or mixed.
|
|
personality
-
added in 2.7 |
|
Define which operating systen the host is. Recommend for ActiveCluster integration
|
protocol
-
|
|
Defines the host connection protocol for volumes.
|
state
-
|
|
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.
|
Notes¶
Note
- This module requires purestorage python library
- You must set
PUREFA_URL
andPUREFA_API
environment variables if url and api_token arguments are not passed to the module directly
Examples¶
- name: Create new AIX host
purefa_host:
host: foo
personaility: aix
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
Status¶
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors¶
- Simon Dodsley (@sdodsley)
Hint
If you notice any issues in this documentation you can edit this document to improve it.