na_ontap_quotas – NetApp ONTAP Quotas

From Get docs
Ansible/docs/2.9/modules/na ontap quotas module


na_ontap_quotas – NetApp ONTAP Quotas

New in version 2.8.


Synopsis

  • Set/Modify/Delete quota on ONTAP

Requirements

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

  • A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward
  • Ansible 2.6
  • Python2 netapp-lib (2017.10.30) or later. Install using ‘pip install netapp-lib’
  • Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’
  • 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

disk_limit

string

Default:

"-"

The amount of disk space that is reserved for the target.

file_limit

string

Default:

"-"

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

  • no

  • yes

Enable and disable https

ontapi

integer

The ontap api version to use

password

string / required

Password for the specified user.


aliases: pass

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 / required

The quota target of the type specified.

set_quota_status

boolean

  • no
  • yes

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

state

string

  • present

  • absent

Whether the specified quota should exist or not.

threshold

string

Default:

"-"

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

type

string / required

  • user
  • group
  • tree

The type of quota rule

use_rest

string

  • Never
  • Always
  • 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 / required

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/.


aliases: user

validate_certs

boolean

  • 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: 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 }}"

Status

Authors

Hint

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


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/na_ontap_quotas_module.html