netapp.ontap.na_ontap_fdspt module – NetApp ONTAP create, delete or modify File Directory security policy tasks

Note

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

New in netapp.ontap 21.8.0

Synopsis

• Create, modify or remove file directory security policy tasks.

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 access control of the task. 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.
force_ontap_version string added in netapp.ontap 21.23.0	Override the cluster ONTAP version when using REST. The behavior is undefined if the version does not match the target cluster. This is provided as a work-around when the cluster version cannot be read because of permission issues. See https://github.com/ansible-collections/netapp.ontap/wiki/Known-issues. This should be in the form 9.10 or 9.10.1 with each element being an integer number.
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
index_num integer	Specifies the index number of a task. Tasks are applied in order. A task with a larger index value is applied after a task with a lower index number. If you do not specify this optional parameter, new tasks are applied to the end of the index list.
key_filepath string added in netapp.ontap 20.6.0	path to SSL client key file.
name string / required	Specifies the name of the policy the task will be associated with.
ntfs_mode string	Specifies NTFS propagation mode. Choices: "propagate" "ignore" "replace"
ntfs_sd list / elements=string	Specifies the NTFS security descriptor name.
password aliases: pass string	Password for the specified user.
path string / required	Specifies the file or folder path of the task. In case of SLAG this path specify the volume or qtree mounted path.
security_type string	Specifies the type of security. If not specified ONTAP will default to ntfs. Choices: "ntfs" "nfsv4"
state string	Whether the specified Policy Task should exist or not. Choices: "present" ← (default) "absent"
use_rest string	This module only supports REST. always – will always use the REST API. A warning is issued if the module does not support REST. Default: "always"
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 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 File Directory security policy.

Notes

Note

• check_mode is supported for this module.

• 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 File Directory Security Policy Task
  netapp.ontap.na_ontap_na_ontap_fdspt:
    state: present
    name: "ansible_pl"
    access_control: "file_directory"
    ntfs_sd: "ansible1_sd"
    ntfs_mode: "replace"
    security_type: "ntfs"
    path: "/volume1"
    hostname: "{{ hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"

- name: Modify File Directory Security Policy Task
  netapp.ontap.na_ontap_na_ontap_fdspt:
    state: present
    name: "ansible_pl"
    access_control: "file_directory"
    path: "/volume1"
    ntfs_sd: "ansible1_sd"
    ntfs_mode: "replace"
    security_type: "ntfs"
    hostname: "{{ hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"

- name: Remove File Directory Security Policy Task
  netapp.ontap.na_ontap_na_ontap_fdspt:
    state: absent
    vserver: "SVM1"
    name: "ansible_pl"
    access_control: "file_directory"
    path: "/volume1"
    hostname: "{{ hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"

Authors

• NetApp Ansible Team (@carchi8py)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)