netapp.ontap.na_ontap_flexcache 模块 – NetApp ONTAP FlexCache - 创建/删除关系

注意

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

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

要安装它，请使用： ansible-galaxy collection install netapp.ontap。您需要其他要求才能使用此模块，请参阅要求以了解详细信息。

要在剧本中使用它，请指定： netapp.ontap.na_ontap_flexcache。

netapp.ontap 2.8.0 中的新增功能

概要 

创建/删除 FlexCache 卷关系。
此模块不会修改现有 FlexCache 卷，但有两个例外。
使用 REST 时，可以在现有 FlexCache 卷上启动预填充。
使用 REST 时，可以挂载或卸载卷。将路径设置为 ‘’ 以卸载它。
需要挂载卷才能预填充它。
一些操作也可以通过 na_ontap_volume 使用。
在 ZAPI 中无法删除缓存卷。

要求 

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

Ansible 2.9 或更高版本 - 建议使用 2.12 或更高版本。
Python 3 - 建议使用 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 或更高版本。

参数 

参数	注释
aggr_list 别名：aggregates 列表 / 元素=字符串	承载目标 FlexCache 卷的卷集合列表。
aggr_list_multiplier 别名：constituents_per_aggregate 整数	卷集合列表重复计数。 REST - 当提及 `aggregates` 字段时，每个卷集合的 FlexCache 成员数量。
auto_provision_as 字符串	使用此参数自动选择现有卷集合进行卷配置。例如 flexgroup 请注意，将选择在集群的每个节点上至少有一个卷集合的最快卷集合类型。使用 REST 时忽略 - 省略 aggr_list 以进行自动选择。
cert_filepath 字符串 netapp.ontap 20.6.0 中新增	SSL 客户端证书文件（.pem）的路径。 python 2.6 不支持。
feature_flags 字典 netapp.ontap 20.5.0 中新增	启用或禁用新功能。这可用于启用实验性功能或禁用破坏向后兼容性的新功能。支持的键和值可能会在未经通知的情况下更改。未知键将被忽略。
force_offline 布尔值	在删除 FlexCache 关系之前，使 FlexCache 卷脱机。卷将被销毁，数据可能会丢失。选项 `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 忽略。
force_unmount 布尔值	卸载 FlexCache 卷。删除挂载卷的连接路径，然后再删除 FlexCache 关系。选项 `false` ← (默认) `true`
hostname 字符串 / 必需	ONTAP 实例的主机名或 IP 地址。
http_port 整数	使用此端口覆盖默认端口 (80 或 443)
https 布尔值	启用和禁用 https。使用 REST 时忽略，因为只支持 https。使用 SSL 证书身份验证时忽略，因为它需要 SSL。选项 `false` ← (默认) `true`
junction_path 别名：path 字符串	缓存卷的连接路径。
key_filepath 字符串 netapp.ontap 20.6.0 中新增	SSL 客户端密钥文件的路径。
name 别名：volume 字符串 / 必需在 NetApp ONTAP 21.3.0 版本中添加	FlexCache 的目标卷名称。
ontapi 整数	要使用的 ONTAP API 版本。
origin_cluster 字符串	FlexCache 的源集群名称。如果缺失，则默认为与目标 vserver 关联的集群。创建时未使用。
origin_volume 字符串	FlexCache 的源卷名称。创建时必需。
origin_vserver 字符串	FlexCache 的源 vserver 名称。创建时必需。
密码别名：pass 字符串	指定用户的密码。
prepopulate 字典在 NetApp ONTAP 21.3.0 版本中添加	使用源卷中的数据预填充 FlexCache。需要 ONTAP 9.8 或更高版本，以及 REST 支持。必须设置 dir_paths 才能使此选项生效。
dir_paths 列表 / 元素=字符串 / 必需	在拥有 SVM 的命名空间中，FlexCache 卷挂载的目录路径列表。路径必须以“/”开头。
exclude_dir_paths 列表 / 元素=字符串	需要从预填充中排除的目录路径。路径必须以“/”开头。需要 ONTAP 9.9 或更高版本。
force_prepopulate_if_already_created 布尔值	默认情况下，此模块每次调用时都会启动预填充任务，并且不是幂等的。如果设置为 false，则如果 FlexCache 已存在，则不会启动预填充任务。选项 `false` `true` ← (默认)
recurse 布尔值	指定预填充操作是否应递归搜索目录路径。如果未设置，则使用默认值“true”。选项 `false` `true`
size 整数	缓存卷的大小。
size_unit 字符串	用于解释 size 参数的单位。选项 `"bytes"` `"b"` `"kb"` `"mb"` `"gb"` ← (默认) `"tb"` `"pb"` `"eb"` `"zb"` `"yb"`
state 字符串	指定的关系是否存在。选项 `"present"` ← (默认) `"absent"`
time_out 整数	等待 FlexCache 创建或删除的时间（秒）。如果为 0，则请求为异步。默认设置为 3 分钟。默认值： `180`
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/。支持两种身份验证方法基本身份验证，使用用户名和密码； SSL 证书身份验证，使用 SSL 客户端证书文件，以及可选的私钥文件。要使用证书，必须已在 ONTAP 集群中安装证书，并且必须已启用证书身份验证。
validate_certs 布尔值	如果设置为 `no`，则不会验证 SSL 证书。仅当在使用自签名证书的个人控制站点上使用时，才应将其设置为 `False`。选项 `false` `true` ← (默认)
vserver 字符串 / 必需	FlexCache 的目标 vserver 名称。请注意，主机名、用户名和密码适用于目标 vserver。
writeback 字典在 NetApp ONTAP 22.13.0 版本中添加	FlexCache 写回。需要 ONTAP 9.12 或更高版本，并且仅支持 REST。
enabled 布尔值	指示 FlexCache 卷是否启用了写回。写回是一种存储方法，其中数据首先写入 FlexCache 卷，然后写入 FlexCache 卷的来源。选项 `false` ← (默认) `true`

备注 

注意

以 na_ontap 为前缀的模块旨在支持 ONTAP 存储平台。
默认情况下启用 https，建议使用。要在集群上启用 http，必须运行以下命令“set -privilege advanced;”“system services web modify -http-enabled true;”。

示例 

- name: Create FlexCache
  netapp.ontap.na_ontap_flexcache:
    state: present
    origin_volume: test_src
    name: test_dest
    origin_vserver: ansible_src
    vserver: ansible_dest
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Delete FlexCache
  netapp.ontap.na_ontap_flexcache:
    state: absent
    name: test_dest
    vserver: ansible_dest
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

作者

NetApp Ansible 团队 (@carchi8py)