dellemc.unity.filesystem_snapshot 模块 – 管理 Unity 存储系统上的文件系统快照

注意

此模块是 dellemc.unity 集合（版本 2.0.0）的一部分。

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

要安装它，请使用：ansible-galaxy collection install dellemc.unity。您需要进一步的要求才能使用此模块，请参阅 要求 以了解详细信息。

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

dellemc.unity 1.1.0 中的新增功能

概要

• 在 Unity 存储系统上管理文件系统快照包括创建文件系统快照、获取文件系统快照、修改文件系统快照和删除文件系统快照。

要求

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

• Dell Unity 存储设备版本 5.1 或更高版本。

• Ansible-core 2.14 或更高版本。

• Python 3.9、3.10 或 3.11。

• Storops Python SDK 1.2.11。

参数

参数	注释
auto_delete 布尔值	此选项指定是否自动删除文件系统快照。 如果设置为 true，则文件系统快照将根据池自动删除策略过期。 如果设置为 false，则不会根据池自动删除策略自动删除文件系统快照。 如果指定了 expiry_time，则选项 auto_delete 不能设置为 true。 如果在创建期间未提及 auto_delete 或 expiry_time，则将创建文件系统快照，并保持 auto_delete 为 true。 一旦设置了 expiry_time，则无法将文件系统快照分配给自动删除策略。 选择 false true
description 字符串	可以使用此选项提供有关文件系统快照的附加信息。 可以通过传递空字符串来删除描述。
expiry_time 字符串	此选项用于指定文件系统快照过期的日期和时间。 时间以 UTC 时区提及。 格式为 “MM/DD/YYYY HH:MM”。年份必须为 4 位数字。
filesystem_id 字符串	创建快照的文件系统的 ID。 要创建文件系统快照，需要 filesystem_id 或 filesystem_name。 其他操作不需要。
filesystem_name 字符串	创建快照的文件系统的名称。 要创建文件系统快照，需要 filesystem_name 或 filesystem_id。 其他操作不需要。
fs_access_type 字符串	文件系统快照的访问类型。 仅在创建文件系统快照期间需要。 如果未给出，则快照的访问类型将为 Checkpoint。 选择 "Checkpoint" "Protocol"
nas_server_id 字符串	在其中创建文件系统的 NAS 服务器的 ID。 要创建文件系统快照，需要 filesystem_id 或 filesystem_name。 其他操作不需要。
nas_server_name 字符串	在其中创建文件系统的 NAS 服务器的名称。 要创建文件系统快照，需要 nas_server_name 或 nas_server_id。 其他操作不需要。
password 字符串 / 必需	Unity 管理服务器的密码。
port 整数	与 Unity 管理服务器进行通信的端口号。 默认值： 443
snapshot_id 字符串	在创建期间，snapshot_id 会自动生成。 对于所有其他操作，需要 snapshot_id 或 snapshot_name。
snapshot_name 字符串	文件系统快照的名称。 创建文件系统快照的强制参数。 对于所有其他操作，需要 snapshot_name 或 snapshot_id。
state 字符串 / 必需	状态选项用于提及文件系统快照的存在。 选择 "absent" "present"
unispherehost 字符串 / 必需	Unity 管理服务器的 IP 或 FQDN。
username 字符串 / 必需	Unity 管理服务器的用户名。
validate_certs 别名：verifycert 布尔值	布尔变量，用于指定是否验证 SSL 证书。 true - 表示应验证 SSL 证书。 false - 表示不应验证 SSL 证书。 选择 false true ←（默认）

注释

注意

• 如果文件系统快照具有 nfs 或 smb 共享，则无法删除。

• 不支持 check_mode。

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

示例

- name: Create Filesystem Snapshot
  dellemc.unity.filesystem_snapshot:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    snapshot_name: "ansible_test_FS_snap"
    filesystem_name: "ansible_test_FS"
    nas_server_name: "lglad069"
    description: "Created using playbook"
    auto_delete: true
    fs_access_type: "Protocol"
    state: "present"

- name: Create Filesystem Snapshot with expiry time
  dellemc.unity.filesystem_snapshot:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    snapshot_name: "ansible_test_FS_snap_1"
    filesystem_name: "ansible_test_FS_1"
    nas_server_name: "lglad069"
    description: "Created using playbook"
    expiry_time: "04/15/2021 2:30"
    fs_access_type: "Protocol"
    state: "present"

- name: Get Filesystem Snapshot Details using Name
  dellemc.unity.filesystem_snapshot:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    snapshot_name: "ansible_test_FS_snap"
    state: "present"

- name: Get Filesystem Snapshot Details using ID
  dellemc.unity.filesystem_snapshot:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    snapshot_id: "10008000403"
    state: "present"

- name: Update Filesystem Snapshot attributes
  dellemc.unity.filesystem_snapshot:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    snapshot_name: "ansible_test_FS_snap"
    description: "Description updated"
    auto_delete: false
    expiry_time: "04/15/2021 5:30"
    state: "present"

- name: Update Filesystem Snapshot attributes using ID
  dellemc.unity.filesystem_snapshot:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    snapshot_id: "10008000403"
    expiry_time: "04/18/2021 8:30"
    state: "present"

- name: Delete Filesystem Snapshot using Name
  dellemc.unity.filesystem_snapshot:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    snapshot_name: "ansible_test_FS_snap"
    state: "absent"

- name: Delete Filesystem Snapshot using ID
  dellemc.unity.filesystem_snapshot:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    snapshot_id: "10008000403"
    state: "absent"

返回值

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

键	描述
changed 布尔值	资源是否已更改。 返回: 总是 示例: true
filesystem_snapshot_details 字典	文件系统快照的详细信息。 返回: 当文件系统快照存在时 示例: {"access_type": "FilesystemSnapAccessTypeEnum.CHECKPOINT", "attached_wwn": null, "creation_time": "2022-10-21 04:42:53.951000+00:00", "creator_schedule": null, "creator_type": "SnapCreatorTypeEnum.USER_CUSTOM", "creator_user": {"id": "user_admin"}, "description": "使用 playbook 创建", "existed": true, "expiration_time": null, "filesystem_id": "fs_137", "filesystem_name": "test", "hash": 8739894572587, "host_access": null, "id": "171798721695", "io_limit_policy": null, "is_auto_delete": true, "is_modifiable": false, "is_modified": false, "is_read_only": true, "is_system_snap": false, "last_writable_time": null, "lun": null, "name": "test_FS_snap_1", "nas_server_id": "nas_1", "nas_server_name": "lglad072", "parent_snap": null, "size": 107374182400, "snap_group": null, "state": "SnapStateEnum.READY"}
access_type 字符串	文件系统快照的访问类型。 返回: 成功
attached_wwn 字符串	附加的 WWN 详细信息。 返回: 成功
creation_time 字符串	文件系统快照的创建时间。 返回: 成功
creator_schedule 字符串	文件系统快照的创建者计划。 返回: 成功
creator_type 字符串	文件系统快照的创建者类型。 返回: 成功
creator_user 字符串	文件系统快照的创建者用户。 返回: 成功
description 字符串	文件系统快照的描述。 返回: 成功
expiration_time 字符串	文件系统快照过期后的日期和时间。 返回: 成功
filesystem_id 字符串	快照存在的文件系统的 ID。 返回: 成功
filesystem_name 字符串	快照存在的文件系统的名称。 返回: 成功
id 字符串	文件系统快照实例的唯一标识符。 返回: 成功
is_auto_delete 布尔值	是否自动删除文件系统快照。 返回: 成功
name 字符串	文件系统快照的名称。 返回: 成功
nas_server_id 字符串	文件系统所在的 NAS 服务器的 ID。 返回: 成功
nas_server_name 字符串	文件系统所在的 NAS 服务器的名称。 返回: 成功
size 整数	文件系统快照的大小。 返回: 成功

作者

• Rajshree Khare (@kharer5)

集合链接

• 问题跟踪器
• 存储库（源代码）