purefb_fs – Manage filesystemon Pure Storage FlashBlade`

New in version 2.6.

Synopsis

• This module manages filesystems on Pure Storage FlashBlade.

Requirements

The below requirements are needed on the host that executes this module.

• python >= 2.7
• purity_fb >= 1.1

Parameters

Parameter	Choices/Defaults	Comments
api_token string		FlashBlade API token for admin privileged user.
eradicate boolean	Choices: no ← yes	Define whether to eradicate the filesystem on delete or leave in trash.
fastremove boolean	Choices: no ← yes	Define whether the fast remove directory is enabled for the filesystem.
fb_url string		FlashBlade management IP address or Hostname.
group_quota string added in 2.9		Default quota in M, G, T or P units for a group under this file system.
hard_limit boolean added in 2.8	Choices: no ← yes	Define whether the capacity for a filesystem is a hard limit. CAUTION This will cause the filesystem to go Read-Only if the capacity has already exceeded the logical size of the filesystem.
http boolean	Choices: no ← yes	Define whether to HTTP/HTTPS protocol is enabled for the filesystem.
name string / required		Filesystem Name.
nfs boolean	Choices: no yes ←	(Deprecate) Define whether to NFSv3 protocol is enabled for the filesystem. This option will be deprecated in 2.10, use nfsv3 instead.
nfs_rules string	Default: "*(rw,no_root_squash)"	Define the NFS rules in operation.
nfsv3 boolean added in 2.9	Choices: no yes ←	Define whether to NFSv3 protocol is enabled for the filesystem.
nfsv4 boolean added in 2.9	Choices: no yes ←	Define whether to NFSv4.1 protocol is enabled for the filesystem.
size string	Default: "32G"	Volume size in M, G, T or P units. See examples.
smb boolean	Choices: no ← yes	Define whether to SMB protocol is enabled for the filesystem.
snapshot boolean	Choices: no ← yes	Define whether a snapshot directory is enabled for the filesystem.
state string	Choices: present ← absent	Create, delete or modifies a filesystem.
user_quota string added in 2.9		Default quota in M, G, T or P units for a user under this file system.

Notes

Note

• This module requires the purity_fb Python library
• You must set PUREFB_URL and PUREFB_API environment variables if fb_url and api_token arguments are not passed to the module directly

Examples

- name: Create new filesystem named foo
  purefb_fs:
    name: foo
    size: 1T
    state: present
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

- name: Delete filesystem named foo
  purefb_fs:
    name: foo
    state: absent
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

- name: Recover filesystem named foo
  purefb_fs:
    name: foo
    state: present
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

- name: Eradicate filesystem named foo
  purefb_fs:
    name: foo
    state: absent
    eradicate: true
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

- name: Modify attributes of an existing filesystem named foo
  purefb_fs:
    name: foo
    size: 2T
    nfsv3 : false
    nfsv4 : true
    user_quota: 10K
    group_quota: 25M
    nfs_rules: '*(ro)'
    snapshot: true
    fastremove: true
    hard_limit: true
    smb: true
    state: present
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

Status

• This module is not guaranteed to have a backwards compatible interface. [preview]
• This module is maintained by the Ansible Community. [community]

Authors

• Pure Storage Ansible Team (@sdodsley) <pure-ansible-team@purestorage.com>

Hint

If you notice any issues in this documentation, you can edit this document to improve it.