netapp.ontap.na_ontap_kerberos_realm module – NetApp ONTAP vserver nfs kerberos realm
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_kerberos_realm.
New in netapp.ontap 2.9.0
Synopsis
Create, modify or delete vserver kerberos realm configuration
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 |
|---|---|
IP Address of the Active Directory Domain Controller (DC). This is a mandatory parameter if the kdc-vendor is ‘microsoft’. |
|
Host name of the Active Directory Domain Controller (DC). This is a mandatory parameter if the kdc-vendor is ‘microsoft’. |
|
IP address of the host where the Kerberos administration daemon is running. This is usually the master KDC. If this parameter is omitted, the address specified in kdc_ip is used. This option is not supported with REST. |
|
The TCP port on the Kerberos administration server where the Kerberos administration service is running. The default for this parmater is ‘749’. This option is not supported with REST. |
|
path to SSL client cert file (.pem). not supported with python 2.6. |
|
The clock skew in minutes is the tolerance for accepting tickets with time stamps that do not exactly match the host’s system clock. The default for this parameter is ‘5’ minutes. This option is not supported with REST. |
|
Optional comment |
|
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. |
|
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:
|
|
IP address of the Key Distribution Centre (KDC) server Required if state=present |
|
TCP port on the KDC to be used for Kerberos communication. The default for this parameter is 88. |
|
The vendor of the Key Distribution Centre (KDC) server Required if state=present Choices:
|
|
path to SSL client key file. |
|
The ontap api version to use |
|
Password for the specified user. |
|
IP address of the host where the Kerberos password-changing server is running. Typically, this is the same as the host indicated in the adminserver-ip. If this parameter is omitted, the IP address in kdc-ip is used. This option is not supported with REST. |
|
The TCP port on the Kerberos password-changing server where the Kerberos password-changing service is running. The default for this parameter is ‘464’. This option is not supported with REST. |
|
Kerberos realm name |
|
Whether the Kerberos realm is present or absent. 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:
|
|
vserver/svm with kerberos realm configured |
Notes
Note
supports ZAPI and REST. REST requires ONTAP 9.6 or later.
supports check mode.
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 kerberos realm other kdc vendor
netapp.ontap.na_ontap_kerberos_realm:
state: present
realm: 'EXAMPLE.COM'
vserver: 'vserver1'
kdc_ip: '1.2.3.4'
kdc_vendor: 'other'
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
- name: Create kerberos realm Microsoft kdc vendor
netapp.ontap.na_ontap_kerberos_realm:
state: present
realm: 'EXAMPLE.COM'
vserver: 'vserver1'
kdc_ip: '1.2.3.4'
kdc_vendor: 'microsoft'
ad_server_ip: '0.0.0.0'
ad_server_name: 'server'
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"