netapp.ontap.na_ontap_active_directory module – NetApp ONTAP configure active directory
Note
This module is part of the netapp.ontap collection (version 22.13.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.
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_active_directory.
New in netapp.ontap 20.9.0
Synopsis
Configure Active Directory.
REST requires ONTAP 9.12.1 or later.
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 |
|---|---|
Active Directory account NetBIOS name. Modifying an existing account name is not supported. The account must be deleted and recreated. |
|
Administrator password required for Active Directory account creation. |
|
Administrator username required for Active Directory account creation. |
|
path to SSL client cert file (.pem). not supported with python 2.6. |
|
Fully qualified domain name. |
|
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. |
|
If true and a machine account with the same name as specified in ‘account-name’ exists in Active Directory, it will be overwritten and reused. Choices:
|
|
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 Ignored with ZAPI. |
|
The hostname or IP address of the ONTAP instance. |
|
Override the default port (80 or 443) with this port |
|
Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. Choices:
|
|
path to SSL client key file. |
|
The ontap api version to use |
|
Organizational unit under which the Active Directory account will be created. Modifying the organizational unit is not supported. The object must be deleted and recreated. |
|
Password for the specified user. |
|
Whether the Active Directory should exist or not Choices:
|
|
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: |
|
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
To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. |
|
If set to This should only set to Choices:
|
|
The name of the vserver to use. |
Notes
Note
Supports check_mode.
supports ZAPI and REST. REST requires ONTAP 9.12.1 or later.
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: Ontap test
hosts: localhost
collections:
- netapp.ontap
tasks:
- name: Create active directory account.
netapp.ontap.na_ontap_active_directory:
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
https: true
validate_certs: false
vserver: laurentncluster-1
state: present
account_name: carchi
admin_password: password
admin_username: carchi
domain: addomain.com
- name: Modify domain name.
netapp.ontap.na_ontap_active_directory:
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
https: true
validate_certs: false
vserver: laurentncluster-1
state: present
account_name: carchi
admin_password: password
admin_username: carchi
domain: addomain_new.com
force_account_overwrite: True
- name: Delete active directory account.
netapp.ontap.na_ontap_active_directory:
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
https: true
validate_certs: false
vserver: laurentncluster-1
state: absent
account_name: carchi
admin_password: password
admin_username: carchi
domain: addomain.com