Docs4dev
Docs
ansible / latest / collections / netapp / elementsw / na_elementsw_ldap_module.html

netapp.elementsw.na_elementsw_ldap – NetApp Element Software Manage ldap admin users

Note

This plugin is part of the netapp.elementsw collection (version 21.6.1).

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

To use it in a playbook, specify: netapp.elementsw.na_elementsw_ldap.

New in version 2.7.0: of netapp.elementsw

Synopsis

  • Enable, disable ldap, and add ldap users

Requirements

The below requirements are needed on the host that executes this module.

  • The modules were developed with SolidFire 10.1
  • solidfire-sdk-python (1.1.0.92) or greater. Install using ‘pip install solidfire-sdk-python’

Parameters

Parameter Choices/Defaults Comments
authType
string
    Choices:
  • DirectBind
  • SearchAndBind
Identifies which user authentication method to use.
groupSearchBaseDn
string
The base DN of the tree to start the group search (will do a subtree search from here)
groupSearchCustomFilter
string
For use with the CustomFilter Search type
groupSearchType
string
    Choices:
  • NoGroup
  • ActiveDirectory
  • MemberDN
Controls the default group search filter used
hostname
string / required
The hostname or IP address of the SolidFire cluster.
For na_elementsw_cluster, the Management IP (MIP) or hostname of the node to initiate the cluster creation from.
password
string / required
Password for the specified user.

aliases: pass
searchBindDN
string
A dully qualified DN to log in with to perform an LDAp search for the user (needs read access to the LDAP directory).
searchBindPassword
string
The password for the searchBindDN account used for searching
serverURIs
string
A comma-separated list of LDAP server URIs
state
string
    Choices:
  • present ←
  • absent
Whether the specified volume should exist or not.
userDNTemplate
string
A string that is used form a fully qualified user DN.
username
string / required
Please ensure that the user has the adequate permissions. For more information, please read the official documentation https://mysupport.netapp.com/documentation/docweb/index.html?productID=62636&language=en-US.

aliases: user
userSearchBaseDN
string
The base DN of the tree to start the search (will do a subtree search from here)
userSearchFilter
string
the LDAP Filter to use

Notes

Note

  • The modules prefixed with na\_elementsw are built to support the SolidFire storage platform.

Examples

- name: disable ldap authentication
  na_elementsw_ldap:
    state: absent
    username: "{{ admin username }}"
    password: "{{ admin password }}"
    hostname: "{{ hostname }}"

- name: Enable ldap authentication
  na_elementsw_ldap:
    state: present
    username: "{{ admin username }}"
    password: "{{ admin password }}"
    hostname: "{{ hostname }}"
    authType: DirectBind
    serverURIs: ldap://svmdurlabesx01spd_ldapclnt
    groupSearchType: MemberDN
    userDNTemplate:  uid=%USERNAME%,cn=users,cn=accounts,dc=corp,dc="{{ company name }}",dc=com

Authors

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