na_ontap_kerberos_realm – NetApp ONTAP vserver nfs kerberos realm

From Get docs
Ansible/docs/2.9/modules/na ontap kerberos realm module


na_ontap_kerberos_realm – NetApp ONTAP vserver nfs kerberos realm

New in version 2.9.


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
  • Ansible 2.6
  • 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’
  • 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

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 parameter is '749'

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

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

  • no

  • yes

Enable and disable https

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

  • Other
  • Microsoft

The vendor of the Key Distribution Centre (KDC) server

Required if state=present

ontapi

integer

The ontap api version to use

password

string / required

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

  • present

  • absent

Whether the Kerberos realm is present or absent.

use_rest

string

  • Never
  • Always
  • 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 / required

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


aliases: user

validate_certs

boolean

  • 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
  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 }}"

Status

Authors

Hint

If you notice any issues in this documentation, you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/na_ontap_kerberos_realm_module.html