netapp.ontap.na_ontap_file_directory_policy – NetApp ONTAP create, delete, or modify vserver security file-directory policy
Note
This plugin is part of the netapp.ontap collection (version 21.14.1).
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_file_directory_policy
.
New in version 20.8.0: of netapp.ontap
Synopsis
Create, modify, or destroy vserver security file-directory policy
Add or remove task from policy.
Each time a policy/task is created/modified, automatically apply policy to vserver.
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 |
---|---|
Specifies the access control of task to be applied. Choices:
|
|
path to SSL client cert file (.pem). not supported with python 2.6. |
|
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. |
|
The hostname or IP address of the ONTAP instance. |
|
Override the default port (80 or 443) with this port |
|
Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. Choices:
|
|
Skip Broken Symlinks. Options used when applying the policy to vserver. Choices:
|
|
path to SSL client key file. |
|
Specifies NTFS Propagation Mode. Choices:
|
|
Specifies NTFS security descriptor identifier. |
|
The ontap api version to use |
|
Password for the specified user. |
|
Specifies the file or folder path of the task. If path is specified and the policy which the task is adding to, does not exist, it will create the policy first then add the task to it. If path is specified, delete operation only removes task from policy. |
|
Specifies the name of the policy. |
|
Specifies the type of security. Choices:
|
|
Whether the specified policy or task should exist or not. Choices:
|
|
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 Default: “auto” |
|
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
To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. |
|
If set to This should only set to Choices:
|
|
Specifies the vserver for the policy. |
Examples
- name: create policy
na_ontap_file_directory_policy:
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
state: present
vserver: ansible
policy_name: file_policy
ignore_broken_symlinks: false
- name: add task to existing file_policy
na_ontap_file_directory_policy:
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
state: present
vserver: ansible
policy_name: file_policy
path: /vol
ntfs_sd: ansible_sd
ntfs_mode: propagate
- name: delete task from file_policy.
na_ontap_file_directory_policy:
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
state: absent
vserver: ansible
policy_name: file_policy
path: /vol
- name: delete file_policy along with the tasks.
na_ontap_file_directory_policy:
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
state: absent
vserver: ansible
policy_name: file_policy
Authors
NetApp Ansible Team (@carchi8py) <ng-ansibleteam@netapp.com>