purestorage.flasharray.purefa_snap 模块 – 管理 Pure Storage FlashArray 上的卷快照

注意

此模块是 purestorage.flasharray 集合 (版本 1.32.0) 的一部分。

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

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

要在 playbook 中使用它，请指定： purestorage.flasharray.purefa_snap。

purestorage.flasharray 1.0.0 中的新增功能

概要

  • 在 Pure Storage FlashArray 上创建或删除卷和卷快照。

需求

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

  • python >= 3.3

  • purestorage >= 1.19

  • py-pure-client >= 1.26.0

  • netaddr

  • requests

  • pycountry

  • urllib3

参数

参数

注释

api_token

字符串

具有管理员权限用户的 FlashArray API 令牌。

disable_warnings

布尔值

在 purestorage.flasharray 1.29.0 中添加

禁用调试日志中的不安全证书警告

选项

  • false ← (默认)

  • true

eradicate

布尔值

定义在删除快照时是否将其彻底删除或保留在回收站中。

选项

  • false ← (默认)

  • true

fa_url

字符串

FlashArray 管理 IPv4 地址或主机名。

ignore_repl

布尔值

仅适用于 Purity//FA 6.1 或更高版本

如果设置为 true，则允许销毁/彻底删除被复制使用的快照。

如果设置为 false，则允许销毁/彻底删除未被复制使用的快照

选项

  • false ← (默认)

  • true

name

字符串 / 必需

源卷的名称。

offload

字符串

仅适用于 Purity//FA 6.1 或更高版本

快照的卸载目标名称。

目标可以是另一个 FlashArray 或卸载目标

这仅适用于创建、删除和彻底删除快照

不支持 _state_ 为 _copy_ 的情况。

overwrite

布尔值

定义在从快照创建时是否覆盖现有卷。

选项

  • false ← (默认)

  • true

state

字符串

定义卷快照是否存在。

选项

  • "absent"

  • "copy"

  • "present" ← (默认)

  • "rename"

suffix

字符串

快照名称的后缀。

target

字符串

如果从快照创建，则为目标卷的名称。

如果重命名快照，则为新快照后缀的名称

throttle

布尔值

在 purestorage.flasharray 1.21.0 中添加

如果设置为 true，则允许快照在阵列运行状况不是最佳状态时失败。

选项

  • false ← (默认)

  • true

注释

注意

  • 此模块需要 purestorage 和 py-pure-client Python 库

  • 特定模块可能需要其他 Python 库。

  • 如果未将 _fa_url_ 和 _api_token_ 参数直接传递给模块，则必须设置 PUREFA_URL 和 PUREFA_API 环境变量

示例

- name: Create snapshot foo.ansible
  purestorage.flasharray.purefa_snap:
    name: foo
    suffix: ansible
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: present

- name: Create R/W clone foo_clone from snapshot foo.snap
  purestorage.flasharray.purefa_snap:
    name: foo
    suffix: snap
    target: foo_clone
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: copy

- name: Create R/W clone foo_clone from remote mnapshot arrayB:foo.snap
  purestorage.flasharray.purefa_snap:
    name: arrayB:foo
    suffix: snap
    target: foo_clone
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: copy

- name: Overwrite existing volume foo_clone with snapshot foo.snap
  purestorage.flasharray.purefa_snap:
    name: foo
    suffix: snap
    target: foo_clone
    overwrite: true
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: copy

- name: Delete and eradicate snapshot named foo.snap
  purestorage.flasharray.purefa_snap:
    name: foo
    suffix: snap
    eradicate: true
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: absent

- name: Rename snapshot foo.fred to foo.dave
  purestorage.flasharray.purefa_snap:
    name: foo
    suffix: fred
    target: dave
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: rename

- name: Create a remote volume snapshot on offload device arrayB
  purestorage.flasharray.purefa_snap:
    name: foo
    offload: arrayB
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Delete and eradicate a volume snapshot foo.1 on offload device arrayB
  purestorage.flasharray.purefa_snap:
    name: foo
    suffix: 1
    offload: arrayB
    eradicate: true
    state: absent
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

返回值

常见返回值已记录在 此处，以下是此模块独有的字段

键

描述

suffix

字符串

与创建的快照后缀相关的数据

返回：成功

作者

  • Pure Storage Ansible 团队 (@sdodsley)