netapp.ontap.na_ontap_qtree – NetApp ONTAP manage qtrees

Note

This plugin is part of the netapp.ontap collection (version 21.1.1).

To install it use: ansible-galaxy collection install netapp.ontap.

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

New in version 2.6.0: of netapp.ontap

Synopsis
Requirements
Parameters
Notes
Examples

Synopsis

Create or destroy Qtrees.

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
cert_filepath string added in 20.6.0 of netapp.ontap		path to SSL client cert file (.pem). not supported with python 2.6.
export_policy string added in 2.9.0 of netapp.ontap		The name of the export policy to apply.
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.
flexvol_name string / required		The name of the FlexVol the qtree should exist on.
force_delete boolean added in 20.8.0 of netapp.ontap	no yes ←	Whether the qtree should be deleted even if files still exist. Note that the default of true reflect the REST API behavior. a value of false is not supported with REST.
from_name string added in 2.7.0 of netapp.ontap		Name of the qtree to be renamed.
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. 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.
name string / required		The name of the qtree to manage.
ontapi integer		The ontap api version to use
oplocks string added in 2.9.0 of netapp.ontap	enabled disabled	Whether the oplocks should be enabled or not for the qtree.
password string		Password for the specified user. aliases: pass
security_style string added in 2.9.0 of netapp.ontap	unix ntfs mixed	The security style for the qtree.
state string	present ← absent	Whether the specified qtree should exist or not.
time_out integer added in 2.9.0 of netapp.ontap	Default: 180	Maximum time to wait for qtree deletion in seconds when wait_for_completion is True. Error out if task is not completed in defined time. Default is set to 3 minutes.
unix_permissions string added in 2.9.0 of netapp.ontap		File permissions bits of the qtree.
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	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.
vserver string / required		The name of the vserver to use.
wait_for_completion boolean added in 2.9.0 of netapp.ontap	no yes ←	Only applicable for REST. When using ZAPI, the deletion is always synchronous. Deleting a qtree may take time if many files need to be deleted. Set this parameter to 'true' for synchronous execution during delete. Set this parameter to 'false' for asynchronous execution. For asynchronous, execution exits as soon as the request is sent, and the qtree is deleted in background.

Notes

Note

The modules prefixed with na\_ontap are built to support the ONTAP storage platform.

Examples

- name: Create Qtrees
  na_ontap_qtree:
    state: present
    name: ansibleQTree
    flexvol_name: ansibleVolume
    export_policy: policyName
    security_style: mixed
    oplocks: disabled
    unix_permissions:
    vserver: ansibleVServer
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Rename Qtrees
  na_ontap_qtree:
    state: present
    from_name: ansibleQTree_rename
    name: ansibleQTree
    flexvol_name: ansibleVolume
    vserver: ansibleVServer
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

Authors

NetApp Ansible Team (@carchi8py) <[email protected]>

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/netapp/ontap/na_ontap_qtree_module.html