purestorage.flasharray.purefa_directory – Manage FlashArray File System Directories
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_directory
.
New in version 1.5.0: of purestorage.flasharray
Synopsis
- Create/Delete FlashArray File Systems
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. | |
fa_url string | FlashArray management IPv4 address or Hostname. | |
filesystem string / required | Name of the filesystem the directory links to. | |
name string / required | Name of the directory | |
path string | Path of the managed directory in the file system If not provided will default to name
| |
rename string | Value to rename the specified directory to | |
state string |
| Define whether the directory should exist or not. |
Notes
Note
- This module requires the
purestorage
andpy-pure-client
Python libraries - Additional Python librarues may be required for specific modules.
- 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 direcotry foo in filesysten bar with path zeta purefa_directory: name: foo filesystem: bar path: zeta fa_url: 10.10.10.2 api_token: e31060a7-21fc-e277-6240-25983c6c4592 - name: Rename directory foo to fin in filesystem bar purefa_directory: name: foo rename: fin filesystem: bar fa_url: 10.10.10.2 api_token: e31060a7-21fc-e277-6240-25983c6c4592 - name: Delete diectory foo in filesystem bar purefa_directory: name: foo filesystem: bar 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_directory_module.html