purestorage.flasharray.purefa_endpoint – Manage VMware protocol-endpoints on Pure Storage FlashArrays
purestorage.flasharray.purefa_endpoint – Manage VMware protocol-endpoints on Pure Storage FlashArrays
Note
This plugin is part of the purestorage.flasharray collection (version 1.5.1).
To install it use: ansible-galaxy collection install purestorage.flasharray
.
To use it in a playbook, specify: purestorage.flasharray.purefa_endpoint
.
New in version 1.0.0: of purestorage.flasharray
Synopsis
- Create, delete or eradicate the an endpoint on a Pure Storage FlashArray.
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.7
- purestorage >= 1.19
- py-pure-client >= 1.6.0
- netaddr
- requests
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
api_token string |
FlashArray API token for admin privileged user. | |
eradicate boolean |
|
Define whether to eradicate the endpoint on delete or leave in trash. |
fa_url string |
FlashArray management IPv4 address or Hostname. | |
hgroup string |
name of hostgroup to attach endpoint to | |
host string |
name of host to attach endpoint to | |
name string / required |
The name of the endpoint. | |
rename string |
Value to rename the specified endpoint to. Rename only applies to the container the current endpoint is in. | |
state string |
|
Define whether the endpoint should exist or not. |
Notes
Note
- This module requires the
purestorage
Python library - You must set
PUREFA_URL
andPUREFA_API
environment variables if fa_url and api_token arguments are not passed to the module directly
Examples
- name: Create new endpoint named foo
purefa_endpoint:
name: test-endpoint
fa_url: 10.10.10.2
api_token: e31060a7-21fc-e277-6240-25983c6c4592
state: present
- name: Delete and eradicate endpoint named foo
purefa_endpoint:
name: foo
eradicate: yes
fa_url: 10.10.10.2
api_token: e31060a7-21fc-e277-6240-25983c6c4592
state: absent
- name: Rename endpoint foor to bar
purefa_endpoint:
name: foo
rename: bar
fa_url: 10.10.10.2
api_token: e31060a7-21fc-e277-6240-25983c6c4592
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
volume dictionary |
success |
A dictionary describing the changed volume. Only some attributes below will be returned with various actions.
| |
created string |
success |
Volume creation time
Sample: 2019-03-13T22:49:24Z | |
name string |
success |
Volume name
| |
serial string |
success |
Volume serial number
Sample: 361019ECACE43D83000120A4 | |
source string |
success |
Volume name of source volume used for volume copy
|
Authors
- Pure Storage Ansible Team (@sdodsley) <[email protected]>
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/purestorage/flasharray/purefa_endpoint_module.html