purestorage.flashblade.purefb_fs module – Manage filesystemon Pure Storage FlashBlade`
Note
This module is part of the purestorage.flashblade collection (version 1.22.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.flashblade.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: purestorage.flashblade.purefb_fs.
New in purestorage.flashblade 1.0.0
Synopsis
This module manages filesystems on Pure Storage FlashBlade.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.9
py-pure-client
netaddr
datetime
pytz
distro
pycountry
urllib3
Parameters
Parameter |
Comments |
|---|---|
The access control style that is utilized for client actions such as setting file and directory ACLs. Choices:
|
|
FlashBlade API token for admin privileged user. |
|
Whether to cancel any existing storage class transitons that are in progress if the file system is requested to changed to another storage class Choices:
|
|
Name of SMB client policy to assign to filesystem Only valid with REST 2.10 or higher Remove policy with empty string |
|
Name of fleet member on which to perform the operation. This requires the array receiving the request is a member of a fleet and the context name to be a member of the same fleet. Default: |
|
Defines if the file system will be continuously available during disruptive scenarios such as network disruption, blades failover, etc Choices:
|
|
Define if the filesystem can be deleted even if it has a replica link Choices:
|
|
Disable insecure certificate warnings Choices:
|
|
Allow a filesystem to be demoted. Choices:
|
|
Define whether to eradicate the filesystem on delete or leave in trash. Choices:
|
|
Name of NFS export policy to assign to filesystem Overrides nfs_rules |
|
Define whether the fast remove directory is enabled for the filesystem. Choices:
|
|
FlashBlade management IP address or Hostname. |
|
The group ownership for new files and directories in a file system Choices:
|
|
Default quota in M, G, T or P units for a group under this file system. |
|
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. Choices:
|
|
Define whether to HTTP/HTTPS protocol is enabled for the filesystem. Choices:
|
|
Allow update operations that lead to a hard_limit_enabled file system with usage over its limiting value Choices:
|
|
Filesystem Name. |
|
Define the NFS rules in operation. If not set at filesystem creation time it defaults to *(rw,no_root_squash) Supported binary options are ro/rw, secure/insecure, fileid_32bit/no_fileid_32bit, root_squash/no_root_squash, all_squash/no_all_squash and atime/noatime Supported non-binary options are anonuid=#, anongid=#, sec=(sys|krb5) Superceeded by export_policy if provided |
|
Define whether to NFSv3 protocol is enabled for the filesystem. Choices:
|
|
Define whether to NFSv4.1 protocol is enabled for the filesystem. Choices:
|
|
Filesystem policy to assign to or remove from a filesystem. |
|
Add or delete a policy from a filesystem Choices:
|
|
Promote/demote a filesystem. Can only demote the file-system if it is in a replica-link relationship. Choices:
|
|
Safeguards ACLs on a filesystem. Performs different roles depending on the filesystem protocol enabled. See Purity//FB documentation for detailed description. Choices:
|
|
Name of SMB share policy to assign to filesystem Only valid with REST 2.10 or higher Remove policy with empty string |
|
Volume size in M, G, T or P units. See examples. If size is not set at filesystem creation time the filesystem size becomes unlimited. |
|
Define whether to SMB protocol is enabled for the filesystem. Choices:
|
|
Specify the ACL mode for the SMB protocol. Deprecated from Purity//FB 3.1.1. Use access_control instead. Choices:
|
|
Define whether a snapshot directory is enabled for the filesystem. Choices:
|
|
Create, delete or modifies a filesystem. Choices:
|
|
Name of storage class in Fusion fleet file system is associated with |
|
Default quota in M, G, T or P units for a user under this file system. |
|
Define if a filesystem is writable. Choices:
|
Notes
Note
You must set
PUREFB_URLandPUREFB_APIenvironment variables if fb_url and api_token arguments are not passed to the module directly
Examples
- name: Create new filesystem named foo
purestorage.flashblade.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
purestorage.flashblade.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
purestorage.flashblade.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
purestorage.flashblade.purefb_fs:
name: foo
state: absent
eradicate: true
fb_url: 10.10.10.2
api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641
- name: Promote filesystem named foo ready for failover
purestorage.flashblade.purefb_fs:
name: foo
promote: true
fb_url: 10.10.10.2
api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641
- name: Demote filesystem named foo after failover
purestorage.flashblade.purefb_fs:
name: foo
promote: false
fb_url: 10.10.10.2
api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641
- name: Modify attributes of an existing filesystem named foo
purestorage.flashblade.purefb_fs:
name: foo
size: 2T
nfsv3: false
nfsv4: true
user_quota: 10K
group_quota: 25M
nfs_rules: '10.21.200.0/24(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