W3cubDocs

/Ansible

netapp.ontap.na_ontap_cifs_privileges module – NetApp ONTAP CIFS privileges

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

New in netapp.ontap 22.13.0

Synopsis
Requirements
Parameters
Notes
Examples

Synopsis

Add/modify/reset privileges of the local or Active Directory user or group.

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
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`
key_filepath string added in netapp.ontap 20.6.0	path to SSL client key file.
name string / required	The name of the local or Active Directory user or group name.
password aliases: pass string	Password for the specified user.
privileges list / elements=string	Specifies the list of privileges to be retained for a user or group. SeTcbPrivilege - Allows user to act as part of the operating system SeBackupPrivilege - Allows user to back up files and directories, overriding any ACLs SeRestorePrivilege - Allows user to restore files and directories, overriding any ACLs SeTakeOwnershipPrivilege - Allows user to take ownership of files or other objects SeSecurityPrivilege - Allows user to manage auditing and viewing/dumping/clearing the security log SeChangeNotifyPrivilege - Allows user to bypass traverse checking
state string	Specifies whether to add/update or reset the specified CIFS privileges. 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://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	the name of the data vserver to use.

Notes

Note

Only supported with REST and requires ONTAP 9.10 or later.
Specified privileges will replace all the existing privileges associated with the user or group when state is present.
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: Add privileges to the specified local user
  netapp.ontap.na_ontap_cifs_privileges:
    state: present
    vserver: ansibleSVM
    name: CIFS\local_user1
    privileges: ["SeTcbPrivilege"]
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: true
    validate_certs: "{{ validate_certs }}"
    use_rest: always

- name: Update privileges of the specified local user
  netapp.ontap.na_ontap_cifs_privileges:
    state: present
    vserver: ansibleSVM
    name: CIFS\local_user1
    privileges: ["SeTcbPrivilege", "SeBackupPrivilege"]
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: true
    validate_certs: "{{ validate_certs }}"
    use_rest: always

- name: Reset privileges of the specified local user
  netapp.ontap.na_ontap_cifs_privileges:
    state: absent
    vserver: ansibleSVM
    name: CIFS\local_user1
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: true
    validate_certs: "{{ validate_certs }}"
    use_rest: always

Authors

NetApp Ansible Team (@carchi8py)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/netapp/ontap/na_ontap_cifs_privileges_module.html