netapp.ontap.na_ontap_quotas module – NetApp ONTAP Quotas

Note

This module is part of the netapp.ontap collection (version 21.23.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 or later - 2.12 or later is recommended.

  • Python3 - 3.9 or later is recommended.

  • When using ZAPI, 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

Parameters

Parameter

Comments

activate_quota_on_change

string

added in 20.12.0 of netapp.ontap

Method to use to activate quota on a change.

Choices:

  • resize ← (default)

  • reinitialize

  • none

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.

Expects a number followed with KB, MB, GB, TB.

If the unit is not present KB is assumed.

Examples - 10MB, 20GB, 1TB

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.

force_ontap_version

string

added in 21.23.0 of netapp.ontap

Override the cluster ONTAP version when using REST.

The behavior is undefined if the version does not match the target cluster.

This is provided as a work-around when the cluster version cannot be read because of permission issues. See https://github.com/ansible-collections/netapp.ontap/wiki/Known-issues.

This should be in the form 9.10 or 9.10.1 with each element being an integer number.

When use_rest is set to auto, this may force a switch to ZAPI based on the version and platform capabilities.

Ignored with ZAPI.

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

Enable and disable https.

Ignored when using REST as only https is supported.

Ignored when using SSL certificate authentication as it requires SSL.

Choices:

  • no ← (default)

  • yes

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

aliases: pass

string

Password for the specified user.

perform_user_mapping

boolean

added in 20.12.0 of netapp.ontap

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.

Choices:

  • no

  • yes

policy

string

Name of the quota policy from which the quota rule should be obtained.

qtree

string

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 “”.

Default: “”

quota_target

string

The quota target of the type specified.

Required to create or modify a rule.

set_quota_status

boolean

Whether the specified volume should have quota status on or off.

Choices:

  • no

  • yes

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.

See disk_limit for format description.

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

Whether the specified quota should exist or not.

Choices:

  • present ← (default)

  • absent

threshold

string

The amount of disk space the target would have to exceed before a message is logged.

See disk_limit for format description.

type

string

The type of quota rule

Required to create or modify a rule.

Choices:

  • user

  • group

  • tree

use_rest

string

Whether to use REST or ZAPI.

always – will always use the REST API if the module supports REST. A warning is issued if the module does not support REST. An error is issued if a module option is not supported in REST.

never – will always use ZAPI if the module supports ZAPI. An error may be issued if a REST option is not supported in ZAPI.

auto – will try to use the REST API if the module supports REST and modules options are supported. Reverts to ZAPI otherwise.

Default: “auto”

username

aliases: user

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.

validate_certs

boolean

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.

Choices:

  • no

  • yes ← (default)

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.

  • https is enabled by default and recommended. To enable http on the cluster you must run the following commands ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’

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

  • NetApp Ansible Team (@carchi8py)