netapp.ontap.na_ontap_volume_snaplock 模块 – 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_volume_snaplock

netapp.ontap 20.2.0 中的新增功能

概要

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

参数

参数

注释

autocommit_period

字符串

指定快照锁定卷的自动提交周期。

格式为“ ”,例如“8 hours”,以下单位有效:

分钟

小时

cert_filepath

字符串

netapp.ontap 20.6.0 中新增

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

不支持 python 2.6。

default_retention_period

字符串

指定将应用的默认保留期限。

格式为“ ”,例如“10 days”,以下单位有效:

分钟

小时

如果此选项指定为“max”,则 maximum_retention_period 将用作默认保留期限。

feature_flags

字典

netapp.ontap 20.5.0 中新增

启用或禁用新功能。

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

支持的键和值可能会在未经通知的情况下更改。未知键将被忽略。

hostname

字符串 / 必需

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

http_port

整数

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

https

布尔值

启用和禁用 https。

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

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

选项

  • false ← (默认)

  • true

is_volume_append_mode_enabled

布尔值

指定是否必须启用或禁用卷追加模式。

只有在卷未挂载且没有任何数据或快照副本时才能修改它。

快照锁定审核日志卷不支持卷追加模式。

启用后,默认情况下,使用写入权限在卷上创建的所有文件都将是 WORM 可追加文件。

所有未修改时间超过卷自动提交周期的 WORM 可追加文件也将提交到 WORM 只读状态。

选项

  • false

  • true

key_filepath

字符串

netapp.ontap 20.6.0 中新增

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

maximum_retention_period

字符串

指定将应用的允许最大保留期限。

格式为“ ”,例如“2 years”,以下单位有效:

分钟

小时

minimum_retention_period

字符串

指定将应用的允许最小保留期限。

格式为“ ”,例如“1 days”,以下单位有效:

分钟

小时

name

字符串 / 必需

要管理的卷的名称。

ontapi

整数

要使用的 ontap api 版本

password

别名:pass

字符串

指定用户的密码。

use_rest

字符串

此模块仅支持 ZAPI,无法切换到 REST。

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

auto – 始终使用 ZAPI。

默认值: "never"

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

字符串 / 必需

要使用的 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 }}"

作者

  • NetApp Ansible 团队 (@carchi8py)