netapp.ontap.na_ontap_kerberos_interface module – NetApp ONTAP module to modify kerberos interface.

Note

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

New in netapp.ontap 22.6.0

Synopsis

  • Enable or disable kerberos interface.

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

admin_password

string

Specifies the administrator password.

admin_username

string

Specifies the administrator username.

cert_filepath

string

added in netapp.ontap 20.6.0

path to SSL client cert file (.pem).

not supported with python 2.6.

enabled

boolean / required

Specifies whether to enable or disable Kerberos for NFS on the specified Vserver and logical interface.

service_principal_name is required when try to enable kerberos.

Choices:

  • false

  • true

feature_flags

dictionary

added in netapp.ontap 20.5.0

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.

force_ontap_version

string

added in netapp.ontap 21.23.0

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 use_rest is set to auto, this may force a switch to ZAPI based on the version and platform capabilities.

Ignored with ZAPI.

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:

  • false ← (default)

  • true

interface_name

string / required

Specifies the name of the logical interface associated with the NFS Kerberos configuration you want to modify.

key_filepath

string

added in netapp.ontap 20.6.0

path to SSL client key file.

keytab_uri

string

Specifies loading a keytab file from the specified URI.

This value must be in the form of “(ftp|http|https)://(hostname|IPv4 Address|’[‘IPv6 Address’]’)…”.

machine_account

string

Specifies the machine account to create in Active Directory.

Requires ONTAP 9.12.1 or later.

ontapi

integer

The ontap api version to use

organizational_unit

string

Specifies the organizational unit (OU) under which the Microsoft Active Directory server account will be created when you enable Kerberos using a realm for Microsoft KDC

password

aliases: pass

string

Password for the specified user.

service_principal_name

aliases: spn

string

Specifies the service principal name (SPN) of the Kerberos configuration you want to modify.

This value must be in the form nfs/host_name@REALM.

host_name is the fully qualified host name of the Kerberos server, nfs is the service, and REALM is the name of the Kerberos realm.

Specify Kerberos realm names in uppercase.

state

string

Modify kerberos interface, only present is supported.

Choices:

  • "present" ← (default)

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"

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:

  • false

  • true ← (default)

vserver

string / required

Specifies the Vserver associated with the NFS Kerberos configuration you want to modify.

Notes

Note

  • Supports check_mode.

  • Module supports only REST and requires ONTAP 9.7 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: Enable kerberos interface.
  netapp.ontap.na_ontap_kerberos_interface:
    interface_name: lif_svm1_284
    vserver: ansibleSVM
    enabled: true
    service_principal_name: nfs/lif_svm1_284@RELAM2
    admin_username: "{{ admin_user }}"
    admin_password: "{{ admin_pass }}"
    hostname: "{{ hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    https: "{{ https }}"
    validate_certs: "{{ certs }}"


- name: Disable kerberos interface.
  netapp.ontap.na_ontap_kerberos_interface:
    interface_name: lif_svm1_284
    vserver: ansibleSVM
    enabled: false
    service_principal_name: nfs/lif_svm1_284@RELAM2
    admin_username: "{{ admin_user }}"
    admin_password: "{{ admin_pass }}"
    hostname: "{{ hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    https: "{{ https }}"
    validate_certs: "{{ certs }}"

Authors

  • NetApp Ansible Team (@carchi8py)