netapp.ontap.na_ontap_cifs_acl module – NetApp ONTAP manage cifs-share-access-control

Note

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

Synopsis
Requirements
Parameters
Notes
Examples

Synopsis

Create or destroy or modify cifs-share-access-controls on ONTAP

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.
netapp-lib only when using ZAPI (install using ‘pip install netapp-lib’), Please note that netapp-lib is deprecated and no longer maintained. Proceed at your own risk.
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. When `use_rest` is set to auto, this may force a switch to ZAPI based on the version and platform capabilities. Ignored with ZAPI.
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.
lambda_config dictionary added in netapp.ontap 23.4.0	Configuration parameters for AWS Lambda proxy functionality. These option and suboptions are only supported with REST.
aws_profile string	The name of the AWS profile to use for authentication.
aws_region string / required	The name of the AWS region.
function_name string / required	The name of the AWS Lambda function to invoke.
ontapi integer	The ontap api version to use
password aliases: pass string	Password for the specified user.
permission string	The access rights that the user or group has on the defined CIFS share. Choices: `"no_access"` `"read"` `"change"` `"full_control"`
share_name aliases: share string / required	The name of the cifs-share-access-control to manage.
state string	Whether the specified CIFS share acl should exist or not. Choices: `"present"` ← (default) `"absent"`
type string added in netapp.ontap 21.17.0	The type (also known as user-group-type) of the user or group to add to the ACL. Type is required for create, delete and modify unix-user or unix-group to/from the ACL in ZAPI. Choices: `"windows"` `"unix_user"` `"unix_group"`
use_lambda boolean added in netapp.ontap 23.2.0	Specifies if AWS Lambda proxy functionality should be used to connect to the ONTAP system. Supported only with REST. Choices: `false` ← (default) `true`
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: `"always"`
user_or_group string / required	The user or group name for which the permissions are listed.
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	Name of the vserver to use.

Notes

Note

Supports AWS Lambda proxy functionality when using REST. See the README file for examples.
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 CIFS share ACL
  netapp.ontap.na_ontap_cifs_acl:
    state: present
    share_name: cifsShareName
    user_or_group: Everyone
    permission: read
    vserver: "{{ netapp_vserver }}"
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Modify CIFS share ACL permission
  netapp.ontap.na_ontap_cifs_acl:
    state: present
    share_name: cifsShareName
    user_or_group: Everyone
    permission: change
    vserver: "{{ netapp_vserver }}"
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Delete CIFS share ACL
  netapp.ontap.na_ontap_cifs_acl:
    state: absent
    share_name: cifsShareName
    user_or_group: localUser
    permission: read
    vserver: "{{ netapp_vserver }}"
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

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/projects/ansible/latest/collections/netapp/ontap/na_ontap_cifs_acl_module.html