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.4.0).
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 | Choices/Defaults | Comments |
---|---|---|
access_control
string
|
|
Specifies the access control of task to be applied.
|
cert_filepath
string
added in 20.6.0 of netapp.ontap
|
path to SSL client cert file (.pem).
not supported with python 2.6.
|
|
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.
|
|
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.
|
ignore_broken_symlinks
boolean
|
|
Skip Broken Symlinks.
Options used when applying the policy to vserver.
|
key_filepath
string
added in 20.6.0 of netapp.ontap
|
path to SSL client key file.
|
|
ntfs_mode
string
|
|
Specifies NTFS Propagation Mode.
|
ntfs_sd
list
/ elements=string
|
Specifies NTFS security descriptor identifier.
|
|
ontapi
integer
|
The ontap api version to use
|
|
password
string
|
Password for the specified user.
aliases: pass |
|
path
string
|
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.
|
|
policy_name
string
/ required
|
Specifies the name of the policy.
|
|
security_type
string
|
|
Specifies the type of security.
|
state
string
|
|
Whether the specified policy or task should exist or not.
|
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
|
|
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
|
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>