netapp.ontap.na_ontap_qtree module – NetApp ONTAP manage qtrees

Note

This module is part of the netapp.ontap collection (version 21.20.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_qtree.

New in version 2.6.0: of netapp.ontap

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

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

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.

Choices:

  • no

  • yes ← (default)

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

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.

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

Whether the oplocks should be enabled or not for the qtree.

Choices:

  • enabled

  • disabled

password

aliases: pass

string

Password for the specified user.

security_style

string

added in 2.9.0 of netapp.ontap

The security style for the qtree.

Choices:

  • unix

  • ntfs

  • mixed

state

string

Whether the specified qtree should exist or not.

Choices:

  • present ← (default)

  • absent

time_out

integer

added in 2.9.0 of netapp.ontap

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.

Default: 180

unix_permissions

string

added in 2.9.0 of netapp.ontap

File permissions bits of the qtree.

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)

vserver

string / required

The name of the vserver to use.

wait_for_completion

boolean

added in 2.9.0 of netapp.ontap

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.

Choices:

  • no

  • yes ← (default)

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)