dellemc.unity.user_quota 模块 – 管理 Unity 存储系统上的用户配额

注意

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

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

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

要在 playbook 中使用它，请指定：dellemc.unity.user_quota。

dellemc.unity 1.2.0 中的新增功能

概要

  • 管理 Unity 存储系统上的用户配额包括创建用户配额、获取用户配额、修改用户配额、删除用户配额、为配额树创建用户配额、修改配额树的用户配额和删除配额树的用户配额。

要求

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

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

  • Ansible-core 2.14 或更高版本。

  • Python 3.9、3.10 或 3.11。

  • Storops Python SDK 1.2.11。

参数

参数

注释

cap_unit

字符串

soft_limit 和 hard_limit 大小的单位。

如果未指定，则默认为 GB。

选择

  • "MB"

  • "GB"

  • "TB"

filesystem_id

字符串

创建用户配额的文件系统的 ID。

对于创建用户配额，需要 filesystem_id 或 filesystem_name。

filesystem_name

字符串

创建用户配额的文件系统的名称。

对于创建用户配额，需要 filesystem_name 或 filesystem_id。

hard_limit

整数

用户可用的总空间的硬性限制。如果超出，用户无法写入数据。

值 0 表示无限制。

soft_limit 和 hard_limit 的其中一个值可以是 0，但是，在创建或修改用户配额期间，两者不能都为 0。

nas_server_id

字符串

创建文件系统的 NAS 服务器的 ID。

对于创建用户配额，需要 filesystem_id 或 filesystem_name。

nas_server_name

字符串

创建文件系统的 NAS 服务器的名称。

对于创建用户配额，需要 nas_server_name 或 nas_server_id。

password

字符串 / 必需

Unity 管理服务器的密码。

path

字符串

配额树的路径。

创建/修改/删除配额树的用户配额需要 tree_quota_id 或 path 到配额树。

路径必须以正斜杠 '/' 开头。

port

整数

与 Unity 管理服务器通信的端口号。

默认值： 443

soft_limit

整数

用户可用的总空间的软性限制。如果超出，将向用户发送通知，告知宽限期，超过此宽限期后，用户将无法使用空间。

值 0 表示无限制。

在创建或修改用户配额期间，soft_limit 和 hard_limit 都不能为 0。

state

字符串 / 必需

state 选项用于提及用户配额的存在。

选择

  • "absent"

  • "present"

tree_quota_id

字符串

配额树的 ID。

创建/修改/删除配额树的用户配额需要 tree_quota_id 或 path 到配额树。

uid

字符串

用户配额的用户 ID。

unispherehost

字符串 / 必需

Unity 管理服务器的 IP 或 FQDN。

user_name

字符串

当 user_type 为 Windows 或 Unix 时，用户配额的用户名。

当 user_type 为 Windows 时，必须指定选项 user_name 和 win_domain。

user_quota_id

字符串

创建用户配额后生成的用户配额 ID。

user_type

字符串

创建用户配额的用户的类型。

创建或修改用户配额时必须使用。

选择

  • "Unix"

  • "Windows"

username

字符串 / 必需

Unity 管理服务器的用户名。

validate_certs

别名：verifycert

布尔值

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

true - 表示应该验证 SSL 证书。

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

选择

  • false

  • true ← (默认)

win_domain

字符串

Windows 用户类型的完整或简短域名。

当 user_type 为 Windows 时是必需的。

注释

注意

  • 不支持 check_mode。

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

示例

- name: Get user quota details by user quota id
  dellemc.unity.user_quota:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    user_quota_id: "userquota_171798700679_0_123"
    state: "present"

- name: Get user quota details by user quota uid/user name
  dellemc.unity.user_quota:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    filesystem_name: "fs_2171"
    nas_server_id: "nas_21"
    user_name: "test"
    state: "present"

- name: Create user quota for a filesystem with filesystem id
  dellemc.unity.user_quota:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    filesystem_id: "fs_2171"
    hard_limit: 6
    cap_unit: "TB"
    soft_limit: 5
    uid: "111"
    state: "present"

- name: Create user quota for a filesystem with filesystem name
  dellemc.unity.user_quota:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    filesystem_name: "Test_filesystem"
    nas_server_name: "lglad068"
    hard_limit: 6
    cap_unit: "TB"
    soft_limit: 5
    uid: "111"
    state: "present"

- name: Modify user quota limit usage by user quota id
  dellemc.unity.user_quota:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    user_quota_id: "userquota_171798700679_0_123"
    hard_limit: 10
    cap_unit: "TB"
    soft_limit: 8
    state: "present"

- name: Modify user quota by filesystem id and user quota uid/user_name
  dellemc.unity.user_quota:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    filesystem_id: "fs_2171"
    user_type: "Windows"
    win_domain: "prod"
    user_name: "sample"
    hard_limit: 12
    cap_unit: "TB"
    soft_limit: 10
    state: "present"

- name: Delete user quota
  dellemc.unity.user_quota:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    filesystem_id: "fs_2171"
    win_domain: "prod"
    user_name: "sample"
    state: "absent"

- name: Create user quota of a quota tree
  dellemc.unity.user_quota:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    tree_quota_id: "treequota_171798700679_4"
    user_type: "Windows"
    win_domain: "prod"
    user_name: "sample"
    soft_limit: 9
    cap_unit: "TB"
    state: "present"

- name: Create user quota of a quota tree by quota tree path
  dellemc.unity.user_quota:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    filesystem_id: "fs_2171"
    path: "/sample"
    user_type: "Unix"
    user_name: "test"
    hard_limit: 2
    cap_unit: "TB"
    state: "present"

- name: Modify user quota of a quota tree
  dellemc.unity.user_quota:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    tree_quota_id: "treequota_171798700679_4"
    user_type: "Windows"
    win_domain: "prod"
    user_name: "sample"
    soft_limit: 10
    cap_unit: "TB"
    state: "present"

- name: Modify user quota of a quota tree by quota tree path
  dellemc.unity.user_quota:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    filesystem_id: "fs_2171"
    path: "/sample"
    user_type: "Windows"
    win_domain: "prod"
    user_name: "sample"
    hard_limit: 12
    cap_unit: "TB"
    state: "present"

- name: Delete user quota of a quota tree by quota tree path
  dellemc.unity.user_quota:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    filesystem_id: "fs_2171"
    path: "/sample"
    win_domain: "prod"
    user_name: "sample"
    state: "absent"

- name: Delete user quota of a quota tree by quota tree id
  dellemc.unity.user_quota:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    tree_quota_id: "treequota_171798700679_4"
    win_domain: "prod"
    user_name: "sample"
    state: "absent"

返回值

通用返回值在此处有文档记录：此处，以下是此模块特有的字段

键

描述

changed

布尔值

资源是否已更改。

返回: 总是

示例: true

get_user_quota_details

字典

用户配额的详细信息。

返回: 当用户配额存在时

示例: {"existed": true, "filesystem": {"UnityFileSystem": {"hash": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER", "id": "fs_120", "name": "nfs-multiprotocol", "nas_server": {"id": "nas_1", "name": "lglad072"}}}, "gp_left": null, "hard_limit": "10.0 GB", "hard_ratio": null, "hash": 8752448438089, "id": "userquota_171798694698_0_60000", "size_used": 0, "soft_limit": "10.0 GB", "soft_ratio": null, "state": 0, "tree_quota": null, "uid": 60000, "unix_name": null, "windows_names": null, "windows_sids": null}

filesystem

字典

创建用户配额的文件系统详细信息。

返回: 成功

UnityFileSystem

字典

创建用户配额的文件系统详细信息。

返回: 成功

id

字符串

创建用户配额的文件系统的 ID。

返回: 成功

name

字符串

文件系统的名称。

返回: 成功

nas_server

字典

创建文件系统的 Nasserver 详细信息。

返回: 成功

id

字符串

nasserver 的 ID。

返回: 成功

name

字符串

nasserver 的名称。

返回: 成功

gp_left

整数

超出用户配额的软限制后剩余的宽限期。

返回: 成功

hard_limit

整数

用户可用的总空间的硬性限制。如果超出，用户无法写入数据。

返回: 成功

hard_ratio

字符串

硬配额比是用户配额的硬限制大小与实际消耗的存储量之间的比率。

返回: 成功

id

字符串

用户配额 ID。

返回: 成功

size_used

整数

用户文件在文件系统中已用空间的大小。

返回: 成功

soft_limit

整数

用户对可用总空间的软限制。如果超过，将向用户发送通知，通知中会提及宽限期，超过宽限期后用户将无法使用空间。

返回: 成功

soft_ratio

字符串

软配额比是用户配额的软限制大小与实际消耗的存储量之间的比率。

返回: 成功

state

整数

用户配额的状态。

返回: 成功

tree_quota

字典

创建用户配额的配额树详细信息。

返回: 成功

UnityTreeQuota

字典

创建用户配额的配额树详细信息。

返回: 成功

id

字符串

配额树的 ID。

返回: 成功

path

字符串

配额树的路径。

返回: 成功

uid

整数

用户的用户 ID。

返回: 成功

unix_name

字符串

此用户配额 uid 的 Unix 用户名。

返回: 成功

windows_names

字符串

映射到此配额 uid 的 Windows 用户名。

返回: 成功

windows_sids

字符串

映射到此配额 uid 的 Windows SID。

返回: 成功

作者

  • Spandita Panigrahi (@panigs7)