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

Примечание

Этот модуль входит в коллекцию dellemc.unity (версия 2.0.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 Storage версии 5.1 или более поздней.
Ansible-core версии 2.14 или более поздней.
Python 3.9, 3.10 или 3.11.
Storops Python SDK 1.2.11.

Параметры

Параметр	Комментарии
cap_unit string	Единица размера soft_limit и hard_limit. По умолчанию `GB` если не указано. Варианты: `"MB"` `"GB"` `"TB"`
filesystem_id string	Идентификатор файловой системы, для которой создается квота пользователя. Для создания квоты пользователя необходим либо filesystem_id, либо filesystem_name.
filesystem_name string	Имя файловой системы, для которой создается квота пользователя. Для создания квоты пользователя необходим либо filesystem_name, либо filesystem_id.
hard_limit integer	Жесткое ограничение для пользователя на общее доступное пространство. При превышении пользователь не может записывать данные. Значение `0` означает отсутствие ограничения. Одно из значений soft_limit и hard_limit может быть `0`, однако оба не могут быть `0` при создании или изменении квоты пользователя.
nas_server_id string	Идентификатор NAS-сервера, в котором создана файловая система. Для создания квоты пользователя необходим либо filesystem_id, либо filesystem_name.
nas_server_name string	Имя NAS-сервера, в котором создана файловая система. Для создания квоты пользователя необходим либо nas_server_name, либо nas_server_id.
password string / required	Пароль сервера управления Unity.
path string	Путь к дереву квот. Для создания/изменения/удаления квоты пользователя для дерева квот необходим либо tree_quota_id, либо path к дереву квот. Путь должен начинаться с косой черты ‘/’.
port integer	Номер порта, через который происходит связь с сервером управления Unity. По умолчанию: `443`
soft_limit integer	Мягкое ограничение для пользователя на общее доступное пространство. При превышении пользователю будет отправлено уведомление за указанный льготный период, после которого пользователь не сможет использовать пространство. Значение `0` означает отсутствие ограничения. Оба значения soft_limit и hard_limit не могут быть `0` при создании или изменении квоты пользователя.
state string / required	Параметр state используется для указания существования квоты пользователя. Варианты: `"absent"` `"present"`
tree_quota_id string	Идентификатор дерева квот. Для создания/изменения/удаления квоты пользователя для дерева квот необходим либо tree_quota_id, либо path к дереву квот.
uid string	Идентификатор пользователя квоты.
unispherehost string / required	IP-адрес или FQDN сервера управления Unity.
user_name string	Имя пользователя квоты, когда user_type равен `Windows` или `Unix`. Параметр user_name должен быть указан вместе с win_domain, когда user_type равен `Windows`.
user_quota_id string	Идентификатор квоты пользователя, созданный после создания квоты пользователя.
user_type string	Тип пользователя, создающего квоту пользователя. Обязательно при создании или изменении квоты пользователя. Варианты: `"Unix"` `"Windows"`
username string / required	Имя пользователя сервера управления Unity.
validate_certs aliases: verifycert boolean	Булева переменная для указания необходимости проверки сертификата SSL. `true` - Указывает, что сертификат SSL должен быть проверен. `false` - Указывает, что сертификат SSL не должен быть проверен. Варианты: `false` `true` ← (default)
win_domain string	Полностью определенное или короткое имя домена для типа пользователя 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 boolean	Изменилось ли ресурс. Возвращается: всегда Пример: `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 строка	Идентификатор дерева квот. Возвращается: успешно

END_OF_DOCUMENT_MARKER

путь строка	Путь к дереву квот. Возвращаемое значение: успех
uid целое число	Идентификатор пользователя. Возвращаемое значение: успех
unix_name строка	Имя пользователя Unix для uid этой квоты пользователя. Возвращаемое значение: успех
windows_names строка	Имя пользователя Windows, сопоставленное с uid этой квоты. Возвращаемое значение: успех
windows_sids строка	SID пользователей Windows, сопоставленные с uid этой квоты. Возвращаемое значение: успех

Авторы

Spandita Panigrahi (@panigs7)

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

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