purestorage.flasharray.purefa_pgsnap 模块 – 管理 Pure Storage FlashArray 上的保护组快照

注意

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

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

要安装它，请使用：ansible-galaxy collection install purestorage.flasharray。您需要其他要求才能使用此模块，请参阅 要求 以了解详情。

要在剧本中使用它，请指定：purestorage.flasharray.purefa_pgsnap。

purestorage.flasharray 1.0.0 中的新增功能

概要

  • 在 Pure Storage FlashArray 上创建或删除保护组快照。

  • 启用在副本目标阵列上恢复复制快照。

  • 支持 ActiveCluster 和卷组保护组。

要求

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

  • python >= 3.3

  • purestorage >= 1.19

  • py-pure-client >= 1.26.0

  • netaddr

  • requests

  • pycountry

  • urllib3

参数

参数

注释

add_to_pgs

列表 / 元素=字符串

在 purestorage.flasharray 1.27.0 中添加

从快照创建的卷将添加到指定的保护组

api_token

字符串

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

apply_retention

布尔值

将保留计划设置应用于快照

选项

  • false ← (默认)

  • true

disable_warnings

布尔值

在 purestorage.flasharray 1.29.0 中添加

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

选项

  • false ← (默认)

  • true

eradicate

布尔值

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

选项

  • false ← (默认)

  • true

fa_url

字符串

FlashArray 管理 IPv4 地址或主机名。

name

字符串 / 必需

源保护组的名称。

now

布尔值

是否立即启动保护组的快照

选项

  • false ← (默认)

  • true

offload

字符串

存在快照的卸载目标的名称。

这仅适用于删除和清除快照

overwrite

布尔值

定义如果目标卷已存在是否覆盖它。

选项

  • false ← (默认)

  • true

remote

布尔值

强制立即将快照复制到远程目标

选项

  • false ← (默认)

  • true

restore

字符串

从保护组快照还原特定卷。

不需要保护组名称。只需提供要还原的卷的名称。

state

字符串

定义保护组快照是否存在。复制 (在 2.7 中添加) 将创建快照的完整读/写克隆。

选项

  • "absent"

  • "present" ← (默认)

  • "copy"

  • "rename"

suffix

字符串

快照名称的后缀。

特殊情况。如果为 *latest*，模块将选择组中创建的最新快照

target

字符串

将指定卷还原到的卷。

如果未提供，这将默认为 *restore* 中定义的卷

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

throttle

布尔值

在 purestorage.flasharray 1.21.0 中添加

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

选项

  • false ← (默认)

  • true

with_default_protection

布尔值

在 purestorage.flasharray 1.27.0 中添加

是否将 *add_to_pgs* 中指定的默认容器保护组添加到从快照创建的卷的初始保护中。

选项

  • false

  • true ← (默认)

注释

注意

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

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

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

示例

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

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

- name: Restore volume data from local protection group snapshot named foo.snap to volume data2
  purestorage.flasharray.purefa_pgsnap:
    name: foo
    suffix: snap
    restore: data
    target: data2
    overwrite: true
    with_default_protection: false
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: copy

- name: Restore remote protection group snapshot arrayA:pgname.snap.data to local copy
  purestorage.flasharray.purefa_pgsnap:
    name: arrayA:pgname
    suffix: snap
    restore: data
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: copy

- name: Restore AC pod  protection group snapshot pod1::pgname.snap.data to pod1::data2
  purestorage.flasharray.purefa_pgsnap:
    name: pod1::pgname
    suffix: snap
    restore: data
    target: pod1::data2
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: copy

- name: Create snapshot of existing pgroup foo with suffix and force immeadiate copy to remote targets
  purestorage.flasharray.purefa_pgsnap:
    name: pgname
    suffix: force
    now: true
    apply_retention: true
    remote: true
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Delete and eradicate snapshot named foo.snap on offload target bar from arrayA
  purestorage.flasharray.purefa_pgsnap:
    name: "arrayA:foo"
    suffix: snap
    offload: bar
    eradicate: true
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: absent

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

返回值

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

键

描述

snapshot

字符串

已创建的保护组快照的后缀。

已返回：成功

作者

  • Pure Storage Ansible 团队 (@sdodsley)