purestorage.flasharray.purefa_export – Manage FlashArray File System Exports
Note
This plugin is part of the purestorage.flasharray collection (version 1.11.0).
You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install purestorage.flasharray.
To use it in a playbook, specify: purestorage.flasharray.purefa_export.
New in version 1.5.0: of purestorage.flasharray
Synopsis
- Create/Delete FlashArray File Systems Exports
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. | |
| directory string / required | Name of the managed directory in the file system the export applies to | |
| fa_url string | FlashArray management IPv4 address or Hostname. | |
| filesystem string / required | Name of the filesystem the export applies to | |
| name string / required | Name of the export | |
| nfs_policy string | Name of NFS Policy to apply to the export | |
| smb_policy string | Name of SMB Policy to apply to the export | |
| state string |
| Define whether the export should exist or not. You must specify an NFS or SMB policy, or both on creation and deletion. |
Notes
Note
- This module requires the
purestorageandpy-pure-clientPython libraries - Additional Python librarues may be required for specific modules.
- You must set
PUREFA_URLandPUREFA_APIenvironment variables if fa_url and api_token arguments are not passed to the module directly
Examples
- name: Create NFS and SMB exports for directory foo in filesysten bar
purefa_export:
name: export1
filesystem: bar
directory: foo
nfs_policy: nfs-example
smb_polict: smb-example
fa_url: 10.10.10.2
api_token: e31060a7-21fc-e277-6240-25983c6c4592
- name: Delete NFS export for directory foo in filesystem bar
purefa_export:
name: export1
filesystem: bar
directory: foo
nfs_policy: nfs-example
state: absent
fa_url: 10.10.10.2
api_token: e31060a7-21fc-e277-6240-25983c6c4592
Authors
- Pure Storage Ansible Team (@sdodsley) <pure-ansible-team@purestorage.com>
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/purestorage/flasharray/purefa_export_module.html