netapp.ontap.na_ontap_security_key_manager 模块 – NetApp ONTAP 安全密钥管理器。

注意

此模块是 netapp.ontap 集合（版本 22.13.0）的一部分。

如果您正在使用 ansible 包，则可能已经安装了此集合。 它不包含在 ansible-core 中。 要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install netapp.ontap。您需要进一步的要求才能使用此模块，有关详细信息，请参阅要求。

要在 playbook 中使用它，请指定：netapp.ontap.na_ontap_security_key_manager。

netapp.ontap 2.8.0 中的新功能

概要

  • 在 NetApp ONTAP 上添加、删除或设置密钥管理。

  • 使用 ZAPI，此模块仅限于添加或删除外部密钥服务器。它不管理证书。

  • 使用 REST，此模块可以创建外部密钥管理器，并且创建时需要证书。

  • 使用 REST，支持板载密钥管理器。

要求

执行此模块的主机需要满足以下要求。

  • Ansible 2.9 或更高版本 - 建议使用 2.12 或更高版本。

  • Python3 - 建议使用 3.9 或更高版本。

  • 使用 ZAPI 时，netapp-lib 2018.11.13 或更高版本（使用“pip install netapp-lib”安装），强烈建议使用 netapp-lib 2020.3.12，因为它为连接问题提供了更好的错误报告。

  • 物理或虚拟集群 Data ONTAP 系统，这些模块支持 Data ONTAP 9.1 及更高版本，REST 支持需要 ONTAP 9.6 或更高版本。

参数

参数

注释

cert_filepath

字符串

在 netapp.ontap 20.6.0 中添加

SSL 客户端证书文件（.pem）的路径。

不支持 python 2.6。

external

字典

在 netapp.ontap 21.23.0 中添加

配置外部密钥管理器。

ZAPI 不支持。

与 ip_address 和 onboard 互斥。

client_certificate

字符串

客户端证书名称（已安装在集群或 SVM 中）。

创建外部密钥管理器时是必需的。

server_ca_certificates

list / elements=string

服务器 CA 证书名称的列表（已安装在集群或 SVM 中）。

创建外部密钥管理器时是必需的。

servers

list / elements=string

用于密钥管理的外部密钥服务器列表。

格式 - ip_address:port 或 FQDN:port。如果未提供，则端口默认为 tcp_port 的值。

如果密钥管理器已存在，则不会保留列表中的顺序。

feature_flags

字典

在 netapp.ontap 20.5.0 中添加

启用或禁用新功能。

这可用于启用实验性功能或禁用破坏向后兼容性的新功能。

支持的键和值可能会更改，恕不另行通知。未知的键将被忽略。

force_ontap_version

字符串

在 netapp.ontap 21.23.0 中添加

使用 REST 时覆盖集群 ONTAP 版本。

如果版本与目标集群不匹配，则行为未定义。

当由于权限问题而无法读取集群版本时，将其作为一种解决方法提供。请参阅 https://github.com/ansible-collections/netapp.ontap/wiki/Known-issues。

这应该是 9.10 或 9.10.1 的形式，每个元素都是一个整数。

当 use_rest 设置为 auto 时，这可能会强制根据版本和平台功能切换到 ZAPI。

使用 ZAPI 时忽略。

hostname

string / required

ONTAP 实例的主机名或 IP 地址。

http_port

整数

使用此端口覆盖默认端口（80 或 443）

https

布尔值

启用和禁用 https。

使用 REST 时忽略，因为仅支持 https。

使用 SSL 证书身份验证时忽略，因为它需要 SSL。

选择

  • false ←（默认）

  • true

ip_address

字符串

外部密钥管理服务器的 IP 地址。

与 external 和 onboard 选项互斥。

使用 ZAPI 时是必需的。

key_filepath

字符串

在 netapp.ontap 20.6.0 中添加

SSL 客户端密钥文件的路径。

node

字符串

运行密钥管理服务器的节点。

忽略，如果存在则会引发警告。

自 21.22.0 起已弃用，因为它从未使用过。

onboard

字典

在 netapp.ontap 21.23.0 中添加

配置板载密钥管理。

ZAPI 不支持。

与 ip_address 和 external 互斥。

from_passphrase

字符串

集群范围内的密码。

如果板载密钥管理器尚不存在，则忽略。

更改密码是必需的。

passphrase

字符串

集群范围内的密码。

synchronize

布尔值

同步集群中任何节点上缺少的板载密钥。

选择

  • false ←（默认）

  • true

ontapi

整数

要使用的 ontap api 版本

password

别名：pass

字符串

指定用户的密码。

state

字符串

指定的密钥管理器是否应该存在。

选择

  • "present" ←（默认）

  • "absent"

tcp_port

整数

密钥管理服务器侦听传入连接的 TCP 端口。

默认： 5696

use_rest

字符串

是否使用 REST 或 ZAPI。

always – 如果模块支持 REST，则始终使用 REST API。 如果模块不支持 REST，则会发出警告。 如果 REST 中不支持模块选项，则会发出错误。

never – 如果模块支持 ZAPI，则始终使用 ZAPI。 如果 ZAPI 中不支持 REST 选项，可能会发出错误。

auto – 如果模块支持 REST 且支持模块选项，则会尝试使用 REST API。 否则会恢复为 ZAPI。

默认： "auto"

username

别名：user

字符串

这可以是集群范围或 SVM 范围的帐户，具体取决于是否需要集群级别或 SVM 级别的 API。

更多信息，请阅读文档 https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/。

支持两种身份验证方法

  1. 基本身份验证，使用用户名和密码，

  2. SSL 证书身份验证，使用 SSL 客户端证书文件，以及可选的私钥文件。

要使用证书，必须已在 ONTAP 集群中安装证书，并且必须启用证书身份验证。

validate_certs

布尔值

如果设置为 no，则不会验证 SSL 证书。

仅当在个人控制的站点上使用自签名证书时，才应将其设置为 False。

选择

  • false

  • true ← (默认)

vserver

字符串

在 netapp.ontap 21.23.0 中添加

使用外部密钥管理器时的 SVM 名称。

不支持板载密钥管理器。

ZAPI 不支持。

注释

注意

  • 虽然 node 被接受为一个参数，但它在模块中不使用。

  • 支持 check_mode。

  • 仅在集群级别使用 ZAPI 或板载密钥管理器时支持。

  • 自 ONTAP 9.6 起，ZAPI 支持依赖于已弃用的 API。

  • 前缀为 na_ontap 的模块旨在支持 ONTAP 存储平台。

  • 默认启用并推荐使用 https。要在集群上启用 http，您必须运行以下命令：‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’

示例

# 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

作者

  • NetApp Ansible 团队 (@carchi8py)