netapp.ontap.na_ontap_ldap_client – NetApp ONTAP LDAP client

Note

This plugin is part of the netapp.ontap collection (version 21.4.0).

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 Choices/Defaults Comments
ad_domain
string
Active Directory Domain Name
base_dn
string
LDAP base DN
base_scope
string
    Choices:
  • subtree
  • onelevel
  • base
LDAP search scope
bind_as_cifs_server
boolean
    Choices:
  • no
  • yes
The cluster uses the CIFS server's credentials to bind to the LDAP server.
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
    Choices:
  • no ←
  • yes
Enable and disable https.
Ignored when using REST as only https is supported.
Ignored when using SSL certificate authentication as it requires SSL.
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
    Choices:
  • anonymous
  • simple
  • sasl
Minimal LDAP server bind level.
name
string / required
The name of LDAP client configuration
ontapi
integer
The ontap api version to use
password
string
Password for the specified user.

aliases: pass
preferred_ad_servers
list / elements=string
Preferred Active Directory (AD) Domain Controllers
query_timeout
integer
LDAP server query timeout
referral_enabled
boolean
    Choices:
  • no
  • yes
LDAP Referral Chasing
schema
string
    Choices:
  • AD-IDMU
  • AD-SFU
  • MS-AD-BIS
  • RFC-2307
LDAP schema
Required if state=present.
session_security
string
    Choices:
  • none
  • sign
  • seal
Client Session Security
state
string
    Choices:
  • present ←
  • absent
Whether the specified LDAP client configuration exist or not.
tcp_port
integer
added in 21.3.0 of netapp.ontap
LDAP server TCP port
use_rest
string
Default:
"auto"
REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI.
always -- will always use the REST API
never -- will always use the ZAPI
auto -- will try to use the REST Api
use_start_tls
boolean
    Choices:
  • no
  • yes
Start TLS on LDAP connection
username
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.

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