Documentation
  • Docs »
  • na_ontap_user – NetApp ONTAP user configuration and management

na_ontap_user – NetApp ONTAP user configuration and management

New in version 2.6.

Synopsis

  • Create or destroy users.

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
applications
list / required
    Choices:
  • console
  • http
  • ontapi
  • rsh
  • snmp
  • service-processor
  • sp
  • ssh
  • telnet
List of application to grant access to.

aliases: application
authentication_method
- / required
    Choices:
  • community
  • password
  • publickey
  • domain
  • nsswitch
  • usm
Authentication method for the application.
Not all authentication methods are valid for an application.
Valid authentication methods for each application are as denoted in authentication_choices_description.
Password for console application
Password, domain, nsswitch, cert for http application.
Password, domain, nsswitch, cert for ontapi application.
Community for snmp application (when creating SNMPv1 and SNMPv2 users).
The usm and community for snmp application (when creating SNMPv3 users).
Password for sp application.
Password for rsh application.
Password for telnet application.
Password, publickey, domain, nsswitch for ssh application.
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
    Choices:
  • no ←
  • yes
Enable and disable https
lock_user
boolean
    Choices:
  • no
  • yes
Whether the specified user account is locked.
name
- / required
The name of the user to manage.
ontapi
integer
The ontap api version to use
password
string / required
Password for the specified user.

aliases: pass
role_name
-
The name of the role. Required when state=present
set_password
-
Password for the user account.
It is ignored for creating snmp users, but is required for creating non-snmp users.
For an existing user, this value will be used as the new password.
state
-
    Choices:
  • present ←
  • absent
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
    Choices:
  • no
  • yes ←
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
The name of the vserver to use.

Notes

Note

  • The modules prefixed with na\_ontap are built to support the ONTAP storage platform.

Examples

- name: Create User
  na_ontap_user:
    state: present
    name: SampleUser
    applications: ssh,console
    authentication_method: password
    set_password: apn1242183u1298u41
    lock_user: True
    role_name: vsadmin
    vserver: ansibleVServer
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Delete User
  na_ontap_user:
    state: absent
    name: SampleUser
    applications: ssh
    authentication_method: password
    vserver: ansibleVServer
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

Status

Authors

Hint

If you notice any issues in this documentation you can edit this document to improve it.