netapp.ontap.na_ontap_fpolicy_ext_engine 模块 – NetApp ONTAP fPolicy 外部引擎配置。

注意

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

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

要安装它,请使用: ansible-galaxy collection install netapp.ontap。您需要其他要求才能使用此模块,有关详细信息,请参阅 需求

要在 playbook 中使用它,请指定: netapp.ontap.na_ontap_fpolicy_ext_engine

netapp.ontap 21.4.0 中的新增功能

概要

  • 创建、删除或修改 fpolicy 外部引擎。

需求

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

  • 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 不支持。

certificate_ca

字符串

证书颁发机构名称。此字段未设置默认值。

certificate_common_name

字符串

证书的 FQDN 或自定义通用名称。此字段未设置默认值。

certificate_serial

字符串

证书的序列号。此字段未设置默认值。

extern_engine_type

字符串

外部引擎类型。如果引擎是异步的,则不会从 FPolicy 服务器发送回复。此字段的默认值为同步。

选项

  • "synchronous"

  • "asynchronous"

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 设置为自动时,这可能会根据版本和平台功能强制切换到 ZAPI。

ZAPI 中忽略。

hostname

字符串 / 必需

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

http_port

整数

使用此端口覆盖默认端口 (80 或 443)

https

布尔值

启用和禁用 https。

使用 REST 时忽略,因为只支持 https。

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

选项

  • false ← (默认)

  • true

is_resiliency_enabled

布尔值

指示是否需要此引擎的弹性。

如果设置为 true,则通知将存储在 resiliency_directory_path 指定的路径中。

如果为 false,则不会存储通知。默认值为 false。

选项

  • false

  • true

key_filepath

字符串

netapp.ontap 20.6.0 中新增

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

max_connection_retries

整数

存储设备尝试建立与 FPolicy 服务器的断开连接的次数。此字段的默认值为 5。

max_server_reqs

整数

将为 FPolicy 服务器排队的未完成屏幕请求的最大数量。此字段的默认值为 50。

name

字符串 / 必需

外部引擎的名称。

ontapi

整数

要使用的 ONTAP API 版本

password

别名:pass

字符串

指定用户的密码。

port

整数

FPolicy 服务器应用程序的端口号。

primary_servers

列表 / 元素=字符串

主要的 FPolicy 服务器。

recv_buffer_size

整数

FPolicy 服务器连接套接字的接收缓冲区大小。此字段的默认值为 256 千字节 (256Kb)。

resiliency_directory_path

字符串

用于存储文件访问通知的 Vserver 下的目录路径。在停机期间,文件访问通知将存储在一个生成的文件中。

该路径是相对于 Vserver 根目录的完整用户可见路径,它可能跨越联接挂载点。

secondary_servers

列表 / 元素=字符串

辅助 FPolicy 服务器。此字段未设置默认值。

send_buffer_size

整数

FPolicy 服务器连接套接字的发送缓冲区大小。此字段的默认值为 256 千字节 (256Kb)。

ssl_option

字符串

外部通信的 SSL 选项。此字段未设置默认值

选项

  • "no_auth"

  • "server_auth"

  • “mutual_auth”

状态

字符串

fPolicy 外部引擎是否存在

选项

  • "present" ← (默认)

  • “absent”

use_rest

字符串

是否使用 REST 或 ZAPI。

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

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

auto – 如果模块支持 REST 且支持模块选项,则尝试使用 REST API。否则回退到 ZAPI。

默认: "auto"

用户名

别名: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

字符串 / 必需

要在其上创建外部引擎的 vserver 的名称

备注

注意

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

  • 默认情况下启用 https,并建议使用。要在集群上启用 http,必须运行以下命令“set -privilege advanced;”“system services web modify -http-enabled true;”

示例

- name: Create fPolicy external engine
  na_ontap_fpolicy_ext_engine:
    state: present
    vserver: svm1
    name: fpolicy_ext_engine
    port: 8787
    extern_engine_type: asynchronous
    primary_servers: ['10.11.12.13', '10.11.12.14']
    ssl_option: no_auth
    username: "{{ username }}"
    password: "{{ password }}"
    hostname: "{{ hostname }}"

- name: Modify fPolicy external engine
  na_ontap_fpolicy_ext_engine:
    state: present
    vserver: svm1
    name: fpolicy_ext_engine
    port: 7878
    extern_engine_type: synchronous
    primary_servers: ['10.11.12.15', '10.11.12.16']
    ssl_option: server_auth
    username: "{{ username }}"
    password: "{{ password }}"
    hostname: "{{ hostname }}"

- name: Delete fPolicy external engine
  na_ontap_fpolicy_ext_engine:
    state: absent
    vserver: svm1
    name: fpolicy_engine
    username: "{{ username }}"
    password: "{{ password }}"
    hostname: "{{ hostname }}"

作者

  • NetApp Ansible 团队 (@carchi8py)