netapp.ontap.na_ontap_ldap_client module – NetApp ONTAP LDAP client

Note

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

To use it in a playbook, specify: netapp.ontap.na_ontap_ldap_client.

New in version 2.9.0: of netapp.ontap

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

  • Python3 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.

  • To enable http on the cluster you must run the following commands ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’

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:

  • no

  • yes

bind_dn

string

LDAP bind user DN.

bind_password

string

LDAP bind user password.

cert_filepath

string

added in 20.6.0 of netapp.ontap

path to SSL client cert file (.pem).

not supported with python 2.6.

feature_flags

dictionary

added in 20.5.0 of netapp.ontap

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.

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:

  • no ← (default)

  • yes

key_filepath

string

added in 20.6.0 of netapp.ontap

path to SSL client key file.

ldap_servers

list / elements=string

Comma separated list of LDAP servers. FQDN’s or IP addreses.

Required if state=present.

min_bind_level

string

Minimal LDAP server bind level.

Choices:

  • anonymous

  • simple

  • sasl

name

string / required

The name of LDAP client configuration.

ontapi

integer

The ontap api version to use

password

aliases: pass

string

Password for the specified user.

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:

  • no

  • yes

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.

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

tcp_port

integer

added in 21.3.0 of netapp.ontap

LDAP server TCP port.

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:

  • no

  • yes

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

  1. basic authentication, using username and password,

  2. 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:

  • no

  • yes ← (default)

vserver

string / required

vserver/svm that holds LDAP client configuration.

Notes

Note

  • The modules prefixed with na_ontap are built to support the ONTAP storage platform.

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 }}"

Authors

  • Milan Zink (@zeten30) /