netapp.ontap.na_ontap_volume_snaplock 模块 – NetApp ONTAP 管理卷 SnapLock 保留策略。
注意
此模块是 netapp.ontap 集合(版本 22.13.0)的一部分。
如果您使用的是 ansible
包,您可能已经安装了这个集合。它不包含在 ansible-core
中。要检查是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用: ansible-galaxy collection install netapp.ontap
。您需要其他要求才能使用此模块,请参阅 要求 了解详细信息。
要在 playbook 中使用它,请指定: netapp.ontap.na_ontap_volume_snaplock
。
netapp.ontap 20.2.0 新增功能
概要
修改 NetApp ONTAP 上卷的 SnapLock 保留策略。
要求
以下要求需要在执行此模块的主机上满足。
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 或更高版本。
参数
参数 |
注释 |
---|---|
指定 snaplock 卷的自动提交周期。 格式为“<数字> <单位>”,例如“8 hours”,以下单位有效 seconds minutes hours days months years |
|
SSL 客户端证书文件(.pem)的路径。 不支持 python 2.6。 |
|
指定将应用的默认保留期限。 格式为“<数字> <单位>”,例如“10 days”,以下单位有效 seconds minutes hours days months years 如果此选项指定为“max”,则将使用 maximum_retention_period 作为默认保留期限。 |
|
启用或禁用新功能。 这可以用于启用实验性功能或禁用破坏向后兼容性的新功能。 支持的键和值可能会更改,恕不另行通知。未知的键将被忽略。 |
|
ONTAP 实例的主机名或 IP 地址。 |
|
使用此端口覆盖默认端口(80 或 443) |
|
启用和禁用 https。 使用 REST 时忽略,因为仅支持 https。 使用 SSL 证书身份验证时忽略,因为它需要 SSL。 选项
|
|
指定是否必须启用或禁用卷追加模式。 只能在卷未挂载且没有任何数据或快照副本时修改。 SnapLock 审计日志卷不支持卷追加模式。 启用后,默认情况下,在该卷上创建的具有写入权限的所有文件都将是 WORM 可追加文件。 对于超过卷的自动提交周期未修改的所有 WORM 可追加文件,也将被提交为 WORM 只读状态。 选项
|
|
SSL 客户端密钥文件的路径。 |
|
指定将应用的允许的最大保留期限。 格式为“<数字> <单位>”,例如“2 years”,以下单位有效 seconds minutes hours days months years |
|
指定将应用的允许的最小保留期限。 格式为“<数字> <单位>”,例如“1 days”,以下单位有效 seconds minutes hours days months years |
|
要管理的卷的名称。 |
|
要使用的 ontap api 版本 |
|
指定用户的密码。 |
|
此模块仅支持 ZAPI,不能切换到 REST。 never – 如果模块支持 ZAPI,将始终使用 ZAPI。如果 ZAPI 不支持 REST 选项,则可能会发出错误。 auto – 将始终使用 ZAPI。 默认值: |
|
这可以是集群范围或 SVM 范围的帐户,具体取决于需要集群级还是 SVM 级 API。 有关详细信息,请阅读文档 https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/。 支持两种身份验证方法
要使用证书,必须已在 ONTAP 集群中安装证书,并且必须已启用证书身份验证。 |
|
如果设置为 仅应在个人控制的站点上使用自签名证书时将其设置为 选项
|
|
要使用的 vserver 的名称。 |
备注
注意
仅支持 ZAPI。
对于 REST,从 21.18.0 开始,na_ontap_volume 中支持 snaplock。
以 na_ontap 为前缀的模块旨在支持 ONTAP 存储平台。
默认启用并推荐使用 https。 要在集群上启用 http,您必须运行以下命令:‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’
示例
- name: Set volume snaplock
na_ontap_volume_snaplock:
vserver: svm
name: ansibleVolume
default_retention_period: "5 days"
minimum_retention_period: "0 years"
maximum_retention_period: "10 days"
is_volume_append_mode_enabled: False
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"