netapp.ontap.na_ontap_cg_snapshot 模块 – 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_cg_snapshot。

netapp.ontap 2.7.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 或更高版本。

参数 

参数	注释
cert_filepath 字符串在 netapp.ontap 20.6.0 中添加	SSL 客户端证书文件（.pem）的路径。不支持 Python 2.6。
注释字符串在 netapp.ontap 22.8.0 中添加	快照副本的注释。仅支持 REST。
consistency_group 字符串在 netapp.ontap 22.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 时忽略。
hostname 字符串 / 必需	ONTAP 实例的主机名或 IP 地址。
http_port 整数	使用此端口覆盖默认端口（80 或 443）
https 布尔值	启用和禁用 https。当使用 REST 时忽略，因为仅支持 https。当使用 SSL 证书身份验证时忽略，因为它需要 SSL。选项 `false` ← (默认) `true`
key_filepath 字符串在 netapp.ontap 20.6.0 中添加	SSL 客户端密钥文件的路径。
ontapi 整数	要使用的 ontap api 版本
password 别名：pass 字符串	指定用户的密码。
snapmirror_label 字符串	要附加到一致性组快照副本的人类可读的 SnapMirror 标签。
snapshot 字符串 / 必需	在每个卷中创建的快照的提供名称。
state 字符串	指定是创建还是删除快照。只有 REST 才支持选择“absent”。选项 `"present"` ← (默认) `"absent"`
timeout 字符串	超时选择器。 REST 不支持。选项 `"urgent"` `"medium"` ← (默认) `"relaxed"`
use_rest 字符串	是否使用 REST 或 ZAPI。 always – 如果模块支持 REST，将始终使用 REST API。如果模块不支持 REST，则会发出警告。如果 REST 不支持模块选项，则会发出错误。 never – 如果模块支持 ZAPI，将始终使用 ZAPI。如果 ZAPI 不支持 REST 选项，则可能会发出错误。 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` ← (默认)
volumes list / elements=string	此文件管理器中属于此 CG 操作一部分的卷列表。使用 ZAPI 时是必需的。
vserver 字符串 / 必需	vserver 的名称。

注释 

注意

REST 支持需要 ONTAP 9.10 或更高版本。
仅 REST 支持删除操作。
以 na_ontap 为前缀的模块旨在支持 ONTAP 存储平台。
默认情况下启用并推荐使用 https。要在集群上启用 http，必须运行以下命令“set -privilege advanced;” ‘system services web modify -http-enabled true;’

示例 

- name:
  na_ontap_cg_snapshot:
    state: present
    vserver: vserver_name
    snapshot: snapshot name
    volumes: vol_name
    username: "{{ netapp username }}"
    password: "{{ netapp password }}"
    hostname: "{{ netapp hostname }}"

- name: Create CG snapshot using CG name - REST
  na_ontap_cg_snapshot:
    state: present
    vserver: vserver_name
    snapshot: snapshot_name
    consistency_group: cg_name
    snapmirror_label: sm_label
    username: "{{ netapp username }}"
    password: "{{ netapp password }}"
    hostname: "{{ netapp hostname }}"

- name: Create CG snapshot using volumes - REST
  na_ontap_cg_snapshot:
    state: present
    vserver: vserver_name
    snapshot: snapshot_name
    volumes:
      - vol1
      - vol2
    snapmirror_label: sm_label
    username: "{{ netapp username }}"
    password: "{{ netapp password }}"
    hostname: "{{ netapp hostname }}"

- name: Delete CG snapshot - REST
  na_ontap_cg_snapshot:
    state: absent
    vserver: vserver_name
    snapshot: snapshot_name
    consistency_group: cg_name
    username: "{{ netapp username }}"
    password: "{{ netapp password }}"
    hostname: "{{ netapp hostname }}"

作者

NetApp Ansible 团队 (@carchi8py)