netapp.ontap.na_ontap_user_role module – NetApp ONTAP user role configuration and management
Note
This module is part of the netapp.ontap collection (version 22.10.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_user_role.
New in netapp.ontap 2.6.0
Synopsis
Create or destroy user roles
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 |
|---|---|
The access level of the role. Use Choices:
|
|
path to SSL client cert file (.pem). not supported with python 2.6. |
|
The command or command directory to which the role has an access. Required with ZAPI. Supported with REST from ONTAP 9.11.1 or later. |
|
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. |
|
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 Ignored with ZAPI. |
|
The hostname or IP address of the ONTAP instance. |
|
Override the default port (80 or 443) with this port |
|
Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. Choices:
|
|
path to SSL client key file. |
|
The name of the role to manage. |
|
The ontap api version to use |
|
Password for the specified user. |
|
Privileges to give the user roles REST only |
|
The access level of the role. For command/command directory path, the only supported enum values are ‘none’,’readonly’ and ‘all’. Options ‘read_create’, ‘read_modify’ and ‘read_create_modify’ are supported only with REST and requires ONTAP 9.11.1 or later versions. Choices:
|
|
The api or command to which the role has an access. command or command directory path is supported from ONTAP 9.11.1 or later versions. Only rest roles are supported for earlier versions. |
|
A query for the role. The query must apply to the specified command or directory name. Query is only supported on 9.11.1+ |
|
A query for the role. The query must apply to the specified command or directory name. Use double quotes “” for modifying a existing query to none. Supported with REST from ONTAP 9.11.1 or later. |
|
Whether the specified user role should exist or not. Choices:
|
|
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: |
|
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
To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. |
|
If set to This should only set to Choices:
|
|
The name of the vserver to use. Required with ZAPI. |
Notes
Note
supports ZAPI and REST. REST requires ONTAP 9.7 or later.
supports check mode.
when trying to add a command to a role, ONTAP will affect other related commands too.
for example, ‘volume modify’ will affect ‘volume create’ and ‘volume show’, always provide all the related commands.
REST supports both role and rest-role from ONTAP 9.11.1 or later versions and only rest-role for earlier versions.
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 User Role Zapi
netapp.ontap.na_ontap_user_role:
state: present
name: ansibleRole
command_directory_name: volume
access_level: none
query: show
vserver: ansibleVServer
use_rest: never
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
- name: Modify User Role Zapi
netapp.ontap.na_ontap_user_role:
state: present
name: ansibleRole
command_directory_name: volume
access_level: none
query: ""
vserver: ansibleVServer
use_rest: never
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
- name: Create user role REST in ONTAP 9.11.1.
netapp.ontap.na_ontap_user_role:
state: present
privileges:
- path: /api/cluster/jobs
vserver: ansibleSVM
name: carchi-test-role
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
- name: Modify user role REST in ONTAP 9.11.1.
netapp.ontap.na_ontap_user_role:
state: present
privileges:
- path: /api/cluster/jobs
access: readonly
- path: /api/storage/volumes
access: readonly
vserver: ansibleSVM
name: carchi-test-role
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"