netapp.ontap.na_ontap_security_key_manager module – NetApp ONTAP security key manager.

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

New in netapp.ontap 2.8.0

Synopsis

  • Add or delete or setup key management on NetApp ONTAP.

  • With ZAPI, this module is limited to adding or removing external key servers. It does not manage certificates.

  • With REST, this module can create an external key manager and certificates are required for creation.

  • With REST, onboard key manager is supported.

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

cert_filepath

string

added in netapp.ontap 20.6.0

path to SSL client cert file (.pem).

not supported with python 2.6.

external

dictionary

added in netapp.ontap 21.23.0

Configures external key manager.

Not supported with ZAPI.

Mutually exclusive with ip_address and onboard.

client_certificate

string

Client certificate name (already installed in the cluster or SVM).

Required when creating an external key manager.

server_ca_certificates

list / elements=string

List of server CA certificate names (already installed in the cluster or SVM).

Required when creating an external key manager.

servers

list / elements=string

List of external key servers for key management.

Format - ip_address:port or FQDN:port. port defaults to the value of tcp_port when not provided.

The order in the list is not preserved if the key-manager already exists.

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

ip_address

string

The IP address of the external key management server.

Mutually exclusive with external and onboard options.

Required with ZAPI.

key_filepath

string

added in netapp.ontap 20.6.0

path to SSL client key file.

node

string

The node which key management server runs on.

Ignored, a warning is raised if present.

Deprecated as of 21.22.0, as it was never used.

onboard

dictionary

added in netapp.ontap 21.23.0

Configures onboard key management.

Not supported with ZAPI.

Mutually exclusive with ip_address and external .

from_passphrase

string

The cluster-wide passphrase.

Ignored if the onboard key manager does not already exists.

Required to change the passphrase.

passphrase

string

The cluster-wide passphrase.

synchronize

boolean

Synchronizes missing onboard keys on any node in the cluster.

Choices:

  • false ← (default)

  • true

ontapi

integer

The ontap api version to use

password

aliases: pass

string

Password for the specified user.

state

string

Whether the specified key manager should exist or not.

Choices:

  • "present" ← (default)

  • "absent"

tcp_port

integer

The TCP port on which the key management server listens for incoming connections.

Default: 5696

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

added in netapp.ontap 21.23.0

SVM name when using an external key manager.

Not supported for onboard key manager.

Not supported with ZAPI.

Notes

Note

  • Though node is accepted as a parameter, it is not used in the module.

  • Supports check_mode.

  • Only supported at cluster level with ZAPI, or for onboard.

  • ZAPI supports relies on deprecated APIs since ONTAP 9.6.

  • 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

# Assuming module_defaults are used to set up hostname, username, password, https, validate_certs

- name: Delete Key Manager
  tags:
  - delete
  netapp.ontap.na_ontap_security_key_manager:
    state: absent

- name: Add Key Manager - ZAPI
  tags:
  - add
  netapp.ontap.na_ontap_security_key_manager:
    ip_address: 0.0.0.0

- name: Add/Modify external Key Manager - REST
  netapp.ontap.na_ontap_security_key_manager:
    state: present
    external:
      servers: 10.10.10.10:5696
      client_certificate: kmip_client
      server_ca_certificates: kmip_ca
    vserver: "{{ vserver | default(omit) }}"

- name: Add/Modify external Key Manager - REST
  netapp.ontap.na_ontap_security_key_manager:
    state: present
    external:
      servers: 10.10.10.10:5696,10.10.10.10:5697,10.10.10.11:5696
      client_certificate: kmip_client
      server_ca_certificates: kmip_ca
    vserver: "{{ vserver | default(omit) }}"

- name: Add onboard Key Manager
  netapp.ontap.na_ontap_security_key_manager:
    state: present
    onboard:
      passphrase: "hello, le soleil brille, brille, brille!"

- name: Change passphrase for onboard Key Manager
  netapp.ontap.na_ontap_security_key_manager:
    state: present
    onboard:
      from_passphrase: "hello, le soleil brille, brille, brille!"
      passphrase: "hello, le soleil brille, brille, brille! - 2"
      synchronize: true

Authors

  • NetApp Ansible Team (@carchi8py)