netapp.ontap.na_ontap_export_policy_rule 模块 – 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_export_policy_rule

netapp.ontap 2.6.0 中的新增功能

概要

  • 在 ONTAP 中创建、删除或修改导出规则

要求

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

  • 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 或更高版本。

参数

参数

注释

allow_device_creation

布尔值

在 netapp.ontap 22.0.0 中添加

指定是否允许创建设备。

默认为 true。

使用 REST 时,从 ONTAP 9.9.1 版本开始支持。

选项

  • false

  • true

allow_suid

布尔值

如果为“true”,NFS 服务器将在 SETATTR 操作中遵守 SetUID 位。创建时的默认值为“true”。

选项

  • false

  • true

anonymous_user_id

字符串

匿名用户映射到的用户名或 ID。默认值为“65534”。

cert_filepath

字符串

在 netapp.ontap 20.6.0 中添加

SSL 客户端证书文件(.pem)的路径。

python 2.6 不支持。

chown_mode

字符串

在 netapp.ontap 22.0.0 中添加

指定谁被授权更改文件的拥有者模式。

使用 REST 时,从 ONTAP 9.9.1 版本开始支持。

选项

  • "restricted"

  • "unrestricted"

client_match

列表 / 元素=字符串

客户端匹配主机名、IP 地址、网络组或域的列表。

feature_flags

字典

在 netapp.ontap 20.5.0 中添加

启用或禁用新功能。

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

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

force_delete_on_first_match

布尔值

在 netapp.ontap 21.23.0 中添加

当未设置 rule_index 时,默认为在多个匹配项上报告错误。

当此选项设置时,如果 state 为 absent,则删除具有完全匹配项的规则之一。

当 state 为 present 时被忽略。

选项

  • false ← (默认)

  • true

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 时被忽略。

from_rule_index

整数

在 netapp.ontap 21.20.0 中添加

要重新索引的导出策略规则的索引

hostname

字符串 / 必需

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

http_port

整数

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

https

布尔值

启用和禁用 https。

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

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

选项

  • false ← (默认)

  • true

key_filepath

字符串

在 netapp.ontap 20.6.0 中添加

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

name

别名:policy_name

字符串 / 必需

此规则将添加到(或修改或从中删除)的导出策略的名称。

ntfs_unix_security

字符串

在 netapp.ontap 21.18.0 中添加

NTFS 导出 UNIX 安全选项。

使用 REST 时,从 ONTAP 9.9.1 版本开始支持。

选项

  • "fail"

  • "ignore"

ontapi

整数

要使用的 ontap api 版本

password

别名:pass

字符串

指定用户的密码。

protocol

别名:protocols

列表 / 元素=字符串

客户端访问协议列表。

创建期间默认值设置为“any”。

选项

  • "any"

  • "nfs"

  • "nfs3"

  • "nfs4"

  • "cifs"

  • "flexcache"

ro_rule

列表 / 元素=字符串

规则的只读访问规范列表

选项

  • "any"

  • "none"

  • "never"

  • "krb5"

  • "krb5i"

  • "krb5p"

  • "ntlm"

  • "sys"

rule_index

整数

导出策略规则的索引。

当未设置 rule_index 时,我们将尝试查找具有完全匹配项的规则。如果找到,则 state 设置为 present 时不执行任何操作,并且 state 设置为 absent 时删除该规则。如果找到多个规则,则会报告错误。

当 rule_index 设置且 state 为 present 时,如果找不到具有此索引的规则,我们将尝试查找具有完全匹配项的规则,如果找到则将索引分配给此规则。如果找不到匹配项,则会创建一个新规则。

所有设置的属性都用于完全匹配。至少需要 client_match、ro_rule 和 rw_rule。

rw_rule

列表 / 元素=字符串

规则的读写访问规范列表

选项

  • "any"

  • "none"

  • "never"

  • "krb5"

  • "krb5i"

  • "krb5p"

  • "ntlm"

  • "sys"

state

字符串

指定的导出策略规则是否存在。

选项

  • "present" ← (默认)

  • "absent"

super_user_security

列表 / 元素=字符串

规则的读写访问规范列表

选项

  • "any"

  • "none"

  • "krb5"

  • "krb5i"

  • "krb5p"

  • "ntlm"

  • "sys"

use_rest

字符串

是否使用 REST 还是 ZAPI。

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

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

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 ExportPolicyRule
  netapp.ontap.na_ontap_export_policy_rule:
    state: present
    name: default123
    rule_index: 100
    vserver: ci_dev
    client_match: 0.0.0.0/0,1.1.1.0/24
    ro_rule: krb5,krb5i
    rw_rule: any
    protocol: nfs,nfs3
    super_user_security: any
    anonymous_user_id: 65534
    allow_suid: true
    ntfs_unix_security: ignore
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Modify ExportPolicyRule
  netapp.ontap.na_ontap_export_policy_rule:
    state: present
    name: default123
    rule_index: 100
    vserver: ci_dev
    client_match: 0.0.0.0/0
    anonymous_user_id: 65521
    ro_rule: ntlm
    rw_rule: any
    protocol: any
    allow_suid: false
    ntfs_unix_security: fail
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: rename ExportPolicyRule index
  netapp.ontap.na_ontap_export_policy_rule:
    state: present
    name: default123
    from_rule_index: 100
    rule_index: 99
    client_match: 0.0.0.0/0
    anonymous_user_id: 65521
    ro_rule: ntlm
    rw_rule: any
    protocol: any
    allow_suid: false
    ntfs_unix_security: fail
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Delete ExportPolicyRule
  netapp.ontap.na_ontap_export_policy_rule:
    state: absent
    name: default123
    rule_index: 99
    vserver: ci_dev
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

作者

  • NetApp Ansible 团队 (@carchi8py)