Docs4dev
Docs
ansible / latest / collections / netapp / ontap / na_ontap_quotas_module.html

netapp.ontap.na_ontap_quotas – NetApp ONTAP Quotas

Note

This plugin is part of the netapp.ontap collection (version 21.12.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 netapp.ontap.

To use it in a playbook, specify: netapp.ontap.na_ontap_quotas.

New in version 2.8.0: of netapp.ontap

Synopsis

  • Set/Modify/Delete quota on ONTAP

Requirements

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

  • Ansible 2.9
  • Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’
  • netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues.
  • A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward.
  • REST support requires ONTAP 9.6 or later.
  • To enable http on the cluster you must run the following commands ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’

Parameters

Parameter Choices/Defaults Comments
activate_quota_on_change
string
added in 20.12.0 of netapp.ontap
    Choices:
  • resize ←
  • reinitialize
  • none
Method to use to activate quota on a change.
cert_filepath
string
added in 20.6.0 of netapp.ontap
path to SSL client cert file (.pem).
not supported with python 2.6.
disk_limit
string
The amount of disk space that is reserved for the target.
feature_flags
dictionary
added in 20.5.0 of netapp.ontap
Enable or disable a new feature.
This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility.
Supported keys and values are subject to change without notice. Unknown keys are ignored.
file_limit
string
The number of files that the target can have.
hostname
string / required
The hostname or IP address of the ONTAP instance.
http_port
integer
Override the default port (80 or 443) with this port
https
boolean
    Choices:
  • no ←
  • yes
Enable and disable https.
Ignored when using REST as only https is supported.
Ignored when using SSL certificate authentication as it requires SSL.
key_filepath
string
added in 20.6.0 of netapp.ontap
path to SSL client key file.
ontapi
integer
The ontap api version to use
password
string
Password for the specified user.

aliases: pass
perform_user_mapping
boolean
added in 20.12.0 of netapp.ontap
    Choices:
  • no
  • yes
Whether quota management will perform user mapping for the user specified in quota-target.
User mapping can be specified only for a user quota rule.
policy
string
Name of the quota policy from which the quota rule should be obtained.
qtree
string
Default:
""
Name of the qtree for the quota.
For user or group rules, it can be the qtree name or "" if no qtree.
For tree type rules, this field must be "".
quota_target
string
The quota target of the type specified.
Required to create or modify a rule.
set_quota_status
boolean
    Choices:
  • no
  • yes
Whether the specified volume should have quota status on or off.
soft_disk_limit
string
The amount of disk space the target would have to exceed before a message is logged and an SNMP trap is generated.
soft_file_limit
string
The number of files the target would have to exceed before a message is logged and an SNMP trap is generated.
state
string
    Choices:
  • present ←
  • absent
Whether the specified quota should exist or not.
threshold
string
The amount of disk space the target would have to exceed before a message is logged.
type
string
    Choices:
  • user
  • group
  • tree
The type of quota rule
Required to create or modify a rule.
use_rest
string
Default:
"auto"
REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI.
always -- will always use the REST API
never -- will always use the ZAPI
auto -- will try to use the REST Api
username
string
This can be a Cluster-scoped or SVM-scoped account, depending on whether a Cluster-level or SVM-level API is required.
For more information, please read the documentation https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/.
Two authentication methods are supported
1. basic authentication, using username and password,
2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file.
To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled.

aliases: user
validate_certs
boolean
    Choices:
  • no
  • yes ←
If set to no, the SSL certificates will not be validated.
This should only set to False used on personally controlled sites using self-signed certificates.
volume
string / required
The name of the volume that the quota resides on.
vserver
string / required
Name of the vserver to use.

Notes

Note

  • The modules prefixed with na_ontap are built to support the ONTAP storage platform.

Examples

- name: Add/Set quota
  na_ontap_quotas:
    state: present
    vserver: ansible
    volume: ansible
    quota_target: /vol/ansible
    type: user
    policy: ansible
    file_limit: 2
    disk_limit: 3
    set_quota_status: True
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
- name: Resize quota
  na_ontap_quotas:
    state: present
    vserver: ansible
    volume: ansible
    quota_target: /vol/ansible
    type: user
    policy: ansible
    file_limit: 2
    disk_limit: 3
    set_quota_status: True
    activate_quota_on_change: resize
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
- name: Reinitialize quota
  na_ontap_quotas:
    state: present
    vserver: ansible
    volume: ansible
    quota_target: /vol/ansible
    type: user
    policy: ansible
    file_limit: 2
    disk_limit: 3
    set_quota_status: True
    activate_quota_on_change: reinitialize
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
- name: modify quota
  na_ontap_quotas:
    state: present
    vserver: ansible
    volume: ansible
    quota_target: /vol/ansible
    type: user
    policy: ansible
    file_limit: 2
    disk_limit: 3
    threshold: 3
    set_quota_status: False
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
- name: Delete quota
  na_ontap_quotas:
    state: absent
    vserver: ansible
    volume: ansible
    quota_target: /vol/ansible
    type: user
    policy: ansible
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

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/netapp/ontap/na_ontap_quotas_module.html