dellemc.powerflex.snapshot_policy 模块 – 在 Dell PowerFlex 上管理快照策略

注意

此模块是 dellemc.powerflex 集合 (版本 2.5.0) 的一部分。

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

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

要在剧本中使用它，请指定：dellemc.powerflex.snapshot_policy。

dellemc.powerflex 1.7.0 中的新增功能

概要

  • 在 PowerFlex 存储系统上管理快照策略包括创建、获取详细信息、修改属性、添加源卷、删除源卷和删除快照策略。

要求

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

  • Dell PowerFlex 存储系统版本 3.6 或更高版本。

  • PyPowerFlex 1.12.0。

参数

参数

注释

access_mode

字符串

快照策略的访问模式。

选项

  • "READ_WRITE"

  • "READ_ONLY"

auto_snapshot_creation_cadence

字典

快照策略的自动快照创建节奏。

时间

整数

两次快照创建之间的时间间隔。

单位

字符串

自动快照创建节奏的单位。

选项

  • "分钟" ← (默认)

  • "小时"

  • "天"

  • "周"

主机名

别名：gateway_host

字符串 / 必填

PowerFlex 主机的 IP 或 FQDN。

new_name

字符串

快照策略的新名称。

num_of_retained_snapshots_per_level

列表 / 元素=整数

每个级别保留的快照数量。

password

字符串 / 必填

PowerFlex 主机的密码。

pause

布尔值

是否暂停或恢复快照策略。

选项

  • false

  • true

port

整数

与 PowerFlex 主机通信的端口号。

默认值： 443

secure_snapshots

布尔值

是否保护快照。

仅在创建操作中使用。

选项

  • false

  • true

snapshot_policy_id

字符串

快照策略的唯一标识符。

除创建操作外，所有其他操作都可以使用 *snapshot_policy_id* 执行。

与 *snapshot_policy_name* 互斥。

snapshot_policy_name

字符串

快照策略的名称。

在 PowerFlex 阵列中是唯一的。

与 *snapshot_policy_id* 互斥。

source_volume

列表 / 元素=字典

要添加或删除的源卷详细信息。

auto_snap_removal_action

字符串

处理策略创建的快照（自动快照）的方法。

当 *state* 设置为 'absent' 时必须提供。

选项

  • "删除"

  • "分离"

detach_locked_auto_snapshots

布尔值

在删除源卷时是否分离锁定的自动快照。

选项

  • false

  • true

id

字符串

要添加或删除的源卷的唯一标识符。

与 *name* 互斥。

name

字符串

要添加或删除的源卷的名称。

与 *id* 互斥。

state

字符串

源卷的状态。

当 present 时，源卷将添加到快照策略。

当 absent 时，源卷将从快照策略中删除。

选项

  • "present" ← (默认)

  • "absent"

state

字符串

快照策略的状态。

选项

  • "present" ← (默认)

  • "absent"

timeout

整数

连接将在其后终止的时间。

以秒为单位。

默认值： 120

username

字符串 / 必填

PowerFlex 主机的用户名。

validate_certs

别名：verifycert

布尔值

布尔变量，用于指定是否验证 SSL 证书。

true - 表示应验证 SSL 证书。

false - 表示不应验证 SSL 证书。

选项

  • false

  • true ← (默认)

备注

注意

  • 支持 *check_mode*。

  • 名为“dellemc.powerflex”的集合中的模块旨在支持 Dell PowerFlex 存储平台。

示例

- name: Create a snapshot policy
  dellemc.powerflex.snapshot_policy:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    snapshot_policy_name: "snapshot_policy_name_1"
    access_mode: "READ_WRITE"
    secure_snapshots: false
    auto_snapshot_creation_cadence:
      time: 1
      unit: "Hour"
    num_of_retained_snapshots_per_level:
      - 20
    state: "present"

- name: Get snapshot policy details using name
  dellemc.powerflex.snapshot_policy:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    snapshot_policy_name: "snapshot_policy_name_1"

- name: Get snapshot policy details using id
  dellemc.powerflex.snapshot_policy:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    snapshot_policy_id: "snapshot_policy_id_1"

- name: Modify a snapshot policy
  dellemc.powerflex.snapshot_policy:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    snapshot_policy_name: "snapshot_policy_name_1"
    auto_snapshot_creation_cadence:
      time: 2
      unit: "Hour"
    num_of_retained_snapshots_per_level:
      - 40

- name: Rename a snapshot policy
  dellemc.powerflex.snapshot_policy:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    snapshot_policy_name: "snapshot_policy_name_1"
    new_name: "snapshot_policy_name_1_new"

- name: Add source volume
  dellemc.powerflex.snapshot_policy:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    snapshot_policy_name: "snapshot_policy_name_1"
    source_volume:
      - name: "source_volume_name_1"
      - id: "source_volume_id_2"
        state: "present"

- name: Remove source volume
  dellemc.powerflex.snapshot_policy:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    snapshot_policy_name: "{{snapshot_policy_name}}"
    source_volume:
      - name: "source_volume_name_1"
        auto_snap_removal_action: 'Remove'
        state: "absent"
      - id: "source_volume_id_2"
        auto_snap_removal_action: 'Remove'
        detach_locked_auto_snapshots: true
        state: "absent"

- name: Pause a snapshot policy
  dellemc.powerflex.snapshot_policy:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    snapshot_policy_name: "{{snapshot_policy_name}}"
    pause: true

- name: Resume a snapshot policy
  dellemc.powerflex.snapshot_policy:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    snapshot_policy_name: "{{snapshot_policy_name}}"
    pause: false

- name: Delete a snapshot policy
  dellemc.powerflex.snapshot_policy:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    snapshot_policy_name: "snapshot_policy_name"
    state: "absent"

返回值

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

键

描述

changed

布尔值

资源是否已更改。

返回：始终

示例： false

snapshot_policy_details

字典

快照策略的详细信息。

返回：当快照策略存在时

示例： {"autoSnapshotCreationCadenceInMin": 120, "id": "15ae842800000004", "lastAutoSnapshotCreationFailureReason": "NR", "lastAutoSnapshotFailureInFirstLevel": false, "links": [{"href": "/api/instances/SnapshotPolicy::15ae842800000004", "rel": "self"}, {"href": "/api/instances/SnapshotPolicy::15ae842800000004/relationships/Statistics", "rel": "/api/SnapshotPolicy/relationship/Statistics"}, {"href": "/api/instances/SnapshotPolicy::15ae842800000004/relationships/SourceVolume", "rel": "/api/SnapshotPolicy/relationship/SourceVolume"}, {"href": "/api/instances/SnapshotPolicy::15ae842800000004/relationships/AutoSnapshotVolume", "rel": "/api/SnapshotPolicy/relationship/AutoSnapshotVolume"}, {"href": "/api/instances/System::0e7a082862fedf0f", "rel": "/api/parent/relationship/systemId"}], "maxVTreeAutoSnapshots": 40, "name": "Sample_snapshot_policy_1", "nextAutoSnapshotCreationTime": 1683709201, "numOfAutoSnapshots": 0, "numOfCreationFailures": 0, "numOfExpiredButLockedSnapshots": 0, "numOfLockedSnapshots": 0, "numOfRetainedSnapshotsPerLevel": [40], "numOfSourceVolumes": 0, "secureSnapshots": false, "snapshotAccessMode": "ReadWrite", "snapshotPolicyState": "Active", "statistics": {"autoSnapshotVolIds": [], "expiredButLockedSnapshotsIds": [], "numOfAutoSnapshots": 0, "numOfExpiredButLockedSnapshots": 0, "numOfSrcVols": 0, "srcVolIds": []}, "systemId": "0e7a082862fedf0f", "timeOfLastAutoSnapshot": 0, "timeOfLastAutoSnapshotCreationFailure": 0}

autoSnapshotCreationCadenceInMin

整数

快照策略的快照规则。

返回：成功

id

字符串

快照策略的ID。

返回：成功

lastAutoSnapshotCreationFailureReason

字符串

上次自动快照创建失败的原因。

返回：成功

lastAutoSnapshotFailureInFirstLevel

布尔值

第一级上次自动快照是否失败。

返回：成功

maxVTreeAutoSnapshots

整数

VTree自动快照的最大数量。

返回：成功

name

字符串

快照策略的名称。

返回：成功

nextAutoSnapshotCreationTime

整数

下次自动快照创建的时间。

返回：成功

numOfAutoSnapshots

整数

自动快照的数量。

返回：成功

numOfCreationFailures

整数

创建失败的次数。

返回：成功

numOfExpiredButLockedSnapshots

整数

已过期但被锁定的快照数量。

返回：成功

numOfLockedSnapshots

整数

已锁定快照的数量。

返回：成功

numOfRetainedSnapshotsPerLevel

列表 / 元素=字符串

每级保留的快照数量

返回：成功

numOfSourceVolumes

整数

源卷的数量。

返回：成功

secureSnapshots

布尔值

快照是否安全。

返回：成功

snapshotAccessMode

字符串

快照的访问模式。

返回：成功

snapshotPolicyState

字符串

快照策略的状态。

返回：成功

statistics

字典

快照策略的统计详细信息。

返回：成功

autoSnapshotVolIds

列表 / 元素=字符串

所有自动快照的卷ID。

返回：成功

expiredButLockedSnapshotsIds

列表 / 元素=字符串

已过期但被锁定的快照的ID。

返回：成功

numOfAutoSnapshots

整数

自动快照的数量。

返回：成功

numOfExpiredButLockedSnapshots

整数

已过期但被锁定的快照数量。

返回：成功

numOfSrcVols

整数

源卷的数量。

返回：成功

srcVolIds

列表 / 元素=字符串

源卷的ID。

返回：成功

systemId

字符串

PowerFlex系统的唯一标识符。

返回：成功

timeOfLastAutoSnapshot

字符串

上次自动快照创建的时间。

返回：成功

timeOfLastAutoSnapshotCreationFailure

字符串

上次自动快照创建失败的时间。

返回：成功

作者

  • Trisha Datta (@trisha-dell)