Модуль dellemc.unity.user_quota — Управление квотами пользователей в системе хранения Unity

Примечание

Этот модуль входит в коллекцию dellemc.unity (версия 2.1.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install dellemc.unity. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.

Чтобы использовать его в плейбуке, укажите: dellemc.unity.user_quota.

Добавлено в dellemc.unity 1.2.0

Описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

Управление квотами пользователей в системе хранения Unity включает создание, получение, изменение и удаление квот пользователей, а также создание, изменение и удаление квот пользователей для дерева квот.

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

Устройство хранения Dell Unity версии 5.3 или более поздней.
Ansible-core версии 2.17 или более поздней.
Python 3.11, 3.12 или 3.13.
Python SDK Storops 1.2.12.

Параметры

Параметр	Комментарии
cap_unit строка	Единица измерения размера параметров soft_limit и hard_limit. Если параметр не указан, по умолчанию используется `GB`. Допустимые значения: `"MB"` `"GB"` `"TB"`
filesystem_id строка	Идентификатор файловой системы, для которой создаётся квота пользователя. Для создания квоты пользователя требуется указать либо filesystem_id, либо filesystem_name.
filesystem_name строка	Имя файловой системы, для которой создаётся квота пользователя. Для создания квоты пользователя требуется указать либо filesystem_name, либо filesystem_id.
hard_limit целое число	Жёсткое ограничение на общий доступный пользователю объём пространства. При превышении пользователь не сможет записывать данные. Значение `0` означает отсутствие ограничения. Одно из значений soft_limit и hard_limit может быть `0`, однако при создании или изменении квоты пользователя оба значения не могут быть `0`.
nas_server_id строка	Идентификатор NAS-сервера, на котором создана файловая система. Для создания квоты пользователя требуется указать либо 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 строка	Идентификатор дерева квот. Для создания, изменения или удаления квоты пользователя для дерева квот необходимо указать либо tree_quota_id, либо path дерева квот.
uid строка	ID пользователя, для которого задана квота.
unispherehost строка / обязательный	IP-адрес или FQDN сервера управления Unity.
user_name строка	Имя пользователя, для которого задана квота, если user_type равен `Windows` или `Unix`. Если user_type равен `Windows`, параметр user_name необходимо указать вместе с win_domain.
user_quota_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
  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
  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
  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
  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
  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
  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
  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
  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
  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
  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
  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
  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
  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 строка	Идентификатор файловой системы, для которой создана квота пользователя. Возвращается: при успешном выполнении
name строка	Имя файловой системы. Возвращается: при успешном выполнении
nas_server словарь	Сведения о NAS-сервере, на котором создана файловая система. Возвращается: при успешном выполнении
id строка	Идентификатор NAS-сервера. Возвращается: при успешном выполнении
name строка	Имя NAS-сервера. Возвращается: при успешном выполнении
gp_left целое число	Оставшийся льготный период после превышения мягкого ограничения квоты пользователя. Возвращается: при успешном выполнении
hard_limit целое число	Жёсткое ограничение на общий доступный пользователю объём пространства. При превышении пользователь не сможет записывать данные. Возвращается: при успешном выполнении
hard_ratio строка	Отношение размера жёсткого ограничения квоты пользователя к фактически использованному объёму хранилища. Возвращается: при успешном выполнении
id строка	Идентификатор квоты пользователя. Возвращается: при успешном выполнении
size_used целое число	Объём пространства файловой системы, занятый файлами пользователя. Возвращается: при успешном выполнении
soft_limit целое число	Мягкое ограничение на общий доступный пользователю объём пространства. При превышении пользователь получит уведомление; в течение указанного льготного периода он сможет продолжать использовать пространство, после чего такая возможность будет заблокирована. Возвращается: при успешном выполнении
soft_ratio строка	Отношение размера мягкого ограничения квоты пользователя к фактически использованному объёму хранилища. Возвращается: при успешном выполнении
state целое число	Состояние квоты пользователя. Возвращается: при успешном выполнении
tree_quota словарь	Сведения о дереве квот, для которого создана квота пользователя. Возвращается: при успешном выполнении
UnityTreeQuota словарь	Сведения о дереве квот, для которого создана квота пользователя. Возвращается: при успешном выполнении
id строка	Идентификатор дерева квот. Возвращается: при успешном выполнении
path строка	Путь к дереву квот. Возвращается: при успешном выполнении
uid целое число	Идентификатор пользователя. Возвращается: при успешном выполнении
unix_name строка	Имя пользователя Unix, соответствующее uid этой квоты пользователя. Возвращается: при успешном выполнении
windows_names строка	Имя пользователя Windows, соответствующее uid этой квоты. Возвращается: при успешном выполнении
windows_sids строка	SID пользователей Windows, соответствующие uid этой квоты Возвращается: при успешном выполнении

Авторы

Spandita Panigrahi (@panigs7)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/dellemc/unity/user_quota_module.html