na_ontap_unix_user – NetApp ONTAP UNIX users
New in version 2.8.
Synopsis
- Create, delete or modify UNIX users local to ONTAP.
Requirements
The below requirements are needed on the host that executes this module.
- A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward
- Ansible 2.6
- Python2 netapp-lib (2017.10.30) or later. Install using ‘pip install netapp-lib’
- Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’
- To enable http on the cluster you must run the following commands ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
full_name - | Specifies the full name of the UNIX user Optional for create, modifiable. | |
group_id - | Specifies the primary group identification number for the UNIX user Required for create, modifiable. | |
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 |
id - | Specifies an identification number for the UNIX user. Required for create, modifiable. | |
name - / required | Specifies user's UNIX account name. Non-modifiable. | |
ontapi integer | The ontap api version to use | |
password string / required | Password for the specified user. aliases: pass | |
state - |
| Whether the specified user should exist or not. |
username string / required | 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/. aliases: user | |
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. |
vserver - / required | Specifies the Vserver for the UNIX user. Non-modifiable. |
Notes
Note
- The modules prefixed with na\_ontap are built to support the ONTAP storage platform.
Examples
- name: Create UNIX User na_ontap_unix_user: state: present name: SampleUser vserver: ansibleVServer group_id: 1 id: 2 full_name: Test User hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Delete UNIX User na_ontap_unix_user: state: absent name: SampleUser vserver: ansibleVServer hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}"
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- NetApp Ansible Team (@carchi8py) <ng-ansibleteam@netapp.com>
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/na_ontap_unix_user_module.html