netapp.ontap.na_ontap_file_directory_policy module – NetApp ONTAP create, delete, or modify vserver security file-directory policy

Note

This module is part of the netapp.ontap collection (version 22.14.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. You need further requirements to be able to use this module, see Requirements for details.

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

New in netapp.ontap 20.8.0

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.

• This module only supports ZAPI and is deprecated.

• The final version of ONTAP to support ZAPI is 9.12.1.

Requirements

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

• Ansible 2.9 or later - 2.12 or later is recommended.

• Python3 - 3.9 or later is recommended.

• When using ZAPI, 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.

Parameters

Parameter	Comments
access_control string	Specifies the access control of task to be applied. Choices: "file_directory" "slag"
cert_filepath string added in netapp.ontap 20.6.0	path to SSL client cert file (.pem). not supported with python 2.6.
feature_flags dictionary added in netapp.ontap 20.5.0	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. Choices: false ← (default) true
ignore_broken_symlinks boolean	Skip Broken Symlinks. Options used when applying the policy to vserver. Choices: false true
key_filepath string added in netapp.ontap 20.6.0	path to SSL client key file.
ntfs_mode string	Specifies NTFS Propagation Mode. Choices: "propagate" "ignore" "replace"
ntfs_sd list / elements=string	Specifies NTFS security descriptor identifier.
ontapi integer	The ontap api version to use
password aliases: pass string	Password for the specified user.
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. Choices: "ntfs" "nfsv4"
state string	Whether the specified policy or task should exist or not. Choices: "present" ← (default) "absent"
use_rest string	This module only supports ZAPI and can not be swtiched to 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 always use ZAPI. Default: "never"
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://docs.netapp.com/us-en/ontap/authentication/create-svm-user-accounts-task.html. Two authentication methods are supported Basic authentication, using username and password. 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: false true ← (default)
vserver string / required	Specifies the vserver for the policy.

Notes

Note

• The modules prefixed with na_ontap are built to support the ONTAP storage platform.

• https is enabled by default and recommended. To enable http on the cluster you must run the following commands ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’

Examples

- name: Create policy
  netapp.ontap.na_ontap_file_directory_policy:
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    state: present
    vserver: ansible
    policy_name: file_policy
    ignore_broken_symlinks: false

- name: Add task to existing file_policy
  netapp.ontap.na_ontap_file_directory_policy:
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    state: present
    vserver: ansible
    policy_name: file_policy
    path: /vol
    ntfs_sd: ansible_sd
    ntfs_mode: propagate

- name: Delete task from file_policy.
  netapp.ontap.na_ontap_file_directory_policy:
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    state: absent
    vserver: ansible
    policy_name: file_policy
    path: /vol

- name: Delete file_policy along with the tasks.
  netapp.ontap.na_ontap_file_directory_policy:
    hostname: "{{ hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    state: absent
    vserver: ansible
    policy_name: file_policy

Authors

• NetApp Ansible Team (@carchi8py)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)