netapp.ontap.na_ontap_kerberos_realm – NetApp ONTAP vserver nfs kerberos realm

Note

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

To install it use: ansible-galaxy collection install netapp.ontap.

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

New in version 2.9.0: of netapp.ontap

Synopsis

  • Create, modify or delete vserver kerberos realm configuration

Requirements

The below requirements are needed on the host that executes this module.

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

  • Ansible 2.6

  • Ansible 2.9 or later is strongly recommended as it enables the new collection delivery system.

  • Python2 netapp-lib (2017.10.30) or later. Install using ‘pip install netapp-lib’

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

  • 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_server_ip
string
added in 20.4.0 of netapp.ontap
IP Address of the Active Directory Domain Controller (DC). This is a mandatory parameter if the kdc-vendor is 'microsoft'.
ad_server_name
string
added in 20.4.0 of netapp.ontap
Host name of the Active Directory Domain Controller (DC). This is a mandatory parameter if the kdc-vendor is 'microsoft'.
admin_server_ip
string
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.
admin_server_port
string
The TCP port on the Kerberos administration server where the Kerberos administration service is running.
The default for this parmater is '749'
cert_filepath
string
added in 20.6.0 of netapp.ontap
path to SSL client cert file (.pem).
not supported with python 2.6.
clock_skew
string
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.
comment
string
Optional comment
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.
kdc_ip
string
IP address of the Key Distribution Centre (KDC) server
Required if state=present
kdc_port
string
TCP port on the KDC to be used for Kerberos communication.
The default for this parameter is '88'.
kdc_vendor
string
    Choices:
  • other
  • microsoft
The vendor of the Key Distribution Centre (KDC) server
Required if state=present
key_filepath
string
added in 20.6.0 of netapp.ontap
path to SSL client key file.
ontapi
integer
The ontap api version to use
password
string
Password for the specified user.

aliases: pass
pw_server_ip
string
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.
pw_server_port
string
The TCP port on the Kerberos password-changing server where the Kerberos password-changing service is running.
The default for this parameter is '464'.
realm
string / required
Kerberos realm name
state
string
    Choices:
  • present ←
  • absent
Whether the Kerberos realm is present or absent.
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
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 with kerberos realm configured

Notes

Note

  • The modules prefixed with na\_ontap are built to support the ONTAP storage platform.

Examples

- name: Create kerberos realm other kdc vendor
  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
  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 }}"

Authors