Documentation

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
FlashBlade API token for admin privilaed user.
eradicate
    Choices:
  • no ←
  • yes
Define whether to eradicate the filesystem on delete or leave in trash.
fastremove
    Choices:
  • no ←
  • yes
Define whether the fast remove directory is enabled for the filesystem.
fb_url
FlashBlade management IP address or Hostname.
http
    Choices:
  • no ←
  • yes
Define whether to HTTP/HTTPS protocol is enabled for the filesystem.
name
required
Filesystem Name.
nfs
    Choices:
  • no
  • yes ←
Define whether to NFS protocol is enabled for the filesystem.
nfs_rules Default:
*(rw,no_root_squash)
Define the NFS rules in operation.
size Default:
32G
Volume size in M, G, T or P units. See examples.
smb
    Choices:
  • no ←
  • yes
Define whether to SMB protocol is enabled for the filesystem.
snapshot
    Choices:
  • no ←
  • yes
Define whether a snapshot directory is enabled for the filesystem.
state
    Choices:
  • present ←
  • absent
Create, delete or modifies a filesystem.

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
    nfs : true
    nfs_rules: '*(ro)'
    snapshot: true
    fastremove: true
    smb: true
    state: present
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • Simon Dodsley (@sdodsley)

Hint

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