netapp.ontap.na_ontap_snapshot 模块 – NetApp ONTAP 快照管理

注意

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

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

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

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

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

参数 

参数	注释
async_bool 布尔值	如果为 true，则异步创建快照。选项 `false` `true`
cert_filepath 字符串 netapp.ontap 20.6.0 中新增	SSL 客户端证书文件路径（.pem）。 python 2.6 不支持。
comment 字符串	附加到快照的人类可读注释。注释大小最多为 255 个字符。
expiry_time 字符串 netapp.ontap 21.8.0 中新增	快照过期时间，仅适用于 REST。格式应为集群配置的时区。
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` 设置为 auto 时，这可能会根据版本和平台功能强制切换到 ZAPI。 ZAPI 中忽略。
from_name 字符串 netapp.ontap 2.8.0 中新增	要重命名为的现有快照的名称。
hostname 字符串 / 必填	ONTAP 实例的主机名或 IP 地址。
http_port 整数	使用此端口覆盖默认端口 (80 或 443)
https 布尔值	启用和禁用 https。使用 REST 时忽略，因为仅支持 https。使用 SSL 证书身份验证时忽略，因为它需要 SSL。选项 `false` ← (默认) `true`
ignore_owners 布尔值	如果此字段为 true，即使其他进程正在访问快照，它也会被删除。选项 `false` `true`
key_filepath 字符串 netapp.ontap 20.6.0 中新增	SSL 客户端密钥文件路径。
ontapi 整数	要使用的 ontap api 版本
password 别名：pass 字符串	指定用户的密码。
snapmirror_label 字符串	附加到快照的人类可读 SnapMirror 标签。标签大小最多为 31 个字符。在 Ontap 9.7 或更高版本上支持 REST。
snapshot 字符串 / 必填	要管理的快照的名称。最大字符串长度为 256 个字符。
snapshot_instance_uuid 字符串	以 UUID 形式表示的 128 位唯一快照标识符。
state 字符串	如果您想创建/修改快照或删除它。选项 `"present"` ← (默认) `"absent"`
use_rest 字符串	是否使用 REST 或 ZAPI。 always – 如果模块支持 REST，则始终使用 REST API。如果模块不支持 REST，则会发出警告。如果模块选项在 REST 中不受支持，则会发出错误。如果模块支持 ZAPI，则始终使用 ZAPI。如果 REST 选项在 ZAPI 中不受支持，则可能会发出错误。如果模块支持 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 字符串 / 必填	Vserver 名称

备注 

注意

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

示例 

- name: create SnapShot
  tags:
    - create
  netapp.ontap.na_ontap_snapshot:
    state: present
    snapshot: "{{ snapshot name }}"
    volume: "{{ vol name }}"
    comment: "i am a comment"
    expiry_time: "2022-02-04T14:00:00-05:00"
    vserver: "{{ vserver name }}"
    username: "{{ netapp username }}"
    password: "{{ netapp password }}"
    hostname: "{{ netapp hostname }}"
- name: delete SnapShot
  tags:
    - delete
  netapp.ontap.na_ontap_snapshot:
    state: absent
    snapshot: "{{ snapshot name }}"
    volume: "{{ vol name }}"
    vserver: "{{ vserver name }}"
    username: "{{ netapp username }}"
    password: "{{ netapp password }}"
    hostname: "{{ netapp hostname }}"
- name: modify SnapShot
  tags:
    - modify
  netapp.ontap.na_ontap_snapshot:
    state: present
    snapshot: "{{ snapshot name }}"
    comment: "New comments are great"
    volume: "{{ vol name }}"
    vserver: "{{ vserver name }}"
    username: "{{ netapp username }}"
    password: "{{ netapp password }}"
    hostname: "{{ netapp hostname }}"

作者

NetApp Ansible 团队 (@carchi8py)