netapp.ontap.na_ontap_ntfs_sd module – NetApp ONTAP create, delete or modify NTFS security descriptor

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_ntfs_sd.

New in version 20.4.0: of netapp.ontap

Synopsis

  • Create, modify or destroy NTFS security descriptor

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.

control_flags_raw

integer

Specifies the security descriptor control flags.

1… …. …. …. = Self Relative

.0.. …. …. …. = RM Control Valid

..0. …. …. …. = SACL Protected

…0 …. …. …. = DACL Protected

…. 0… …. …. = SACL Inherited

…. .0.. …. …. = DACL Inherited

…. ..0. …. …. = SACL Inherit Required

…. …0 …. …. = DACL Inherit Required

…. …. ..0. …. = SACL Defaulted

…. …. …0 …. = SACL Present

…. …. …. 0… = DACL Defaulted

…. …. …. .1.. = DACL Present

…. …. …. ..0. = Group Defaulted

…. …. …. …0 = Owner Defaulted

At present only the following flags are honored. Others are ignored.

..0. …. …. …. = SACL Protected

…0 …. …. …. = DACL Protected

…. …. ..0. …. = SACL Defaulted

…. …. …. 0… = DACL Defaulted

…. …. …. ..0. = Group Defaulted

…. …. …. …0 = Owner Defaulted

Convert the 16 bit binary flags and convert to decimal for the input.

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.

group

string

Specifies the group’s SID or domain account of the NTFS security descriptor.

Need to provide the full path of the group.

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

Specifies the NTFS security descriptor name. Not modifiable.

ontapi

integer

The ontap api version to use

owner

string

Specifies the owner’s SID or domain account of the NTFS security descriptor.

Need to provide the full path of the owner.

password

aliases: pass

string

Password for the specified user.

state

string

Whether the specified NTFS security descriptor should exist or not.

Choices:

  • present ← (default)

  • absent

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

Specifies the vserver for the NTFS security descriptor.

Notes

Note

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

Examples

- name: Create NTFS Security Descriptor
  na_ontap_ntfs_sd:
    state: present
    vserver: SVM1
    name: ansible_sd
    owner: DOMAIN\Account
    group: DOMAIN\Group
    control_flags_raw: 0
    hostname: "{{ hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"

- name: Modify NTFS Security Descriptor
  na_ontap_ntfs_sd:
    state: present
    vserver: SVM1
    name: ansible_sd
    owner: DOMAIN\Account
    group: DOMAIN\Group
    control_flags_raw: 0
    hostname: "{{ hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"

- name: Delete NTFS Security Descriptor
  na_ontap_ntfs_sd:
    state: absent
    vserver: SVM1
    name: ansible_sd
    hostname: "{{ hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"

Authors

  • NetApp Ansible Team (@carchi8py)