You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

netapp.ontap.na_ontap_ldap_client module – NetApp ONTAP LDAP client

Note

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

New in netapp.ontap 2.9.0

Synopsis 

Create, modify or delete LDAP client on NetApp 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.
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
ad_domain string	Active Directory Domain Name.
base_dn string	LDAP base DN.
base_scope string	LDAP search scope. Choices: `"subtree"` `"onelevel"` `"base"`
bind_as_cifs_server boolean	The cluster uses the CIFS server’s credentials to bind to the LDAP server. Choices: `false` `true`
bind_dn string	LDAP bind user DN.
bind_password string	LDAP bind user password.
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.
ldaps_enabled boolean added in netapp.ontap 21.22.0	Specifies whether or not LDAPS is enabled. Choices: `false` `true`
min_bind_level string	Minimal LDAP server bind level. Choices: `"anonymous"` `"simple"` `"sasl"`
name string	The name of LDAP client configuration. Supported only in ZAPI.
ontapi integer	The ontap api version to use
password aliases: pass string	Password for the specified user.
port aliases: tcp_port integer added in netapp.ontap 21.3.0	LDAP server TCP port.
preferred_ad_servers list / elements=string	Preferred Active Directory (AD) Domain Controllers.
query_timeout integer	LDAP server query timeout.
referral_enabled boolean	LDAP Referral Chasing. Choices: `false` `true`
schema string	LDAP schema. Required if state=present. default schemas - ‘AD-IDMU’, ‘AD-SFU’, ‘MS-AD-BIS’, ‘RFC-2307’. custom schemas are allowed as well.
servers aliases: ldap_servers list / elements=string	Comma separated list of LDAP servers. FQDN’s or IP addreses. Required if state=present.
session_security string	Client Session Security. Choices: `"none"` `"sign"` `"seal"`
state string	Whether the specified LDAP client configuration exist or not. Choices: `"present"` ← (default) `"absent"`
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: `"auto"`
use_start_tls boolean	Start TLS on LDAP connection. Choices: `false` `true`
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://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/. 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	vserver/svm that holds LDAP client configuration.

Notes 

Note

LDAP client created using ZAPI should be deleted using ZAPI.
LDAP client created using REST should be deleted using REST.
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 LDAP client
  netapp.ontap.na_ontap_ldap_client:
    state:         present
    name:          'example_ldap'
    vserver:       'vserver1'
    ldap_servers:  'ldap1.example.company.com,ldap2.example.company.com'
    base_dn:       'dc=example,dc=company,dc=com'
    hostname:      "{{ netapp_hostname }}"
    username:      "{{ netapp_username }}"
    password:      "{{ netapp_password }}"

- name: modify LDAP client
  netapp.ontap.na_ontap_ldap_client:
    state:         present
    name:          'example_ldap'
    vserver:       'vserver1'
    ldap_servers:  'ldap1.example.company.com'
    base_dn:       'dc=example,dc=company,dc=com'
    hostname:      "{{ netapp_hostname }}"
    username:      "{{ netapp_username }}"
    password:      "{{ netapp_password }}"

- name: Delete LDAP client
  netapp.ontap.na_ontap_ldap_client:
    state:         absent
    name:          'example_ldap'
    vserver:       'vserver1'
    ldap_servers:  'ldap1.example.company.com,ldap2.example.company.com'
    hostname:      "{{ netapp_hostname }}"
    username:      "{{ netapp_username }}"
    password:      "{{ netapp_password }}"

Authors

Milan Zink (@zeten30) /

Collection links

Issue Tracker Homepage Repository (Sources)

netapp.ontap.na_ontap_ldap_client module – NetApp ONTAP LDAP client

Synopsis

Requirements

Parameters

Notes

Examples