Docs4dev
Docs
ansible / latest / collections / purestorage / flashblade / purefb_userquota_module.html

purestorage.flashblade.purefb_userquota – Manage filesystem user quotas

Note

This plugin is part of the purestorage.flashblade collection (version 1.7.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.

To use it in a playbook, specify: purestorage.flashblade.purefb_userquota.

New in version 1.7.0: of purestorage.flashblade

Synopsis

  • This module manages user quotas for filesystems on Pure Storage FlashBlade.

Requirements

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

  • python >= 2.7
  • purity_fb >= 1.9
  • netaddr
  • pytz

Parameters

Parameter Choices/Defaults Comments
api_token
string
FlashBlade API token for admin privileged user.
fb_url
string
FlashBlade management IP address or Hostname.
name
string / required
Filesystem Name.
quota
string
User quota in M, G, T or P units. This cannot be 0.
This value will override the file system's default user quota.
state
string
    Choices:
  • present ←
  • absent
Create, delete or modifies a quota.
uid
integer
The user id on which the quota is enforced.
Cannot be combined with uname
uname
string
The user name on which the quota is enforced.
Cannot be combined with uid

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 user (using UID) quota for filesystem named foo
  purefb_userquota:
    name: foo
    quota: 1T
    uid: 1234
    state: present
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

- name: Create new user (using username) quota for filesystem named foo
  purefb_userquota:
    name: foo
    quota: 1T
    uname: bar
    state: present
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

- name: Delete user quota on filesystem foo for user by UID
  purefb_userquota:
    name: foo
    uid: 1234
    state: absent
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

- name: Delete user quota on filesystem foo for user by username
  purefb_userquota:
    name: foo
    uname: bar
    state: absent
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

- name: Update user quota on filesystem foo for user by username
  purefb_userquota:
    name: foo
    quota: 20G
    uname: bar
    state: absent
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

- name: Update user quota on filesystem foo for user by UID
  purefb_userquota:
    name: foo
    quota: 20G
    uid: bar
    state: absent
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

Authors

© 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/flashblade/purefb_userquota_module.html