Модуль hitachivantara.vspone_block.sds_block.hv_sds_block_user_group — создание и обновление групп пользователей в системе хранения.
Примечание
Этот модуль входит в коллекцию hitachivantara.vspone_block (версия 4.8.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install hitachivantara.vspone_block. Для работы с этим модулем могут потребоваться дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: hitachivantara.vspone_block.sds_block.hv_sds_block_user_group.
Добавлено в hitachivantara.vspone_block 4.5.0
Краткое описание
- Создание и обновление групп пользователей в системе хранения.
- Примеры см. по адресу https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/sdsb_user_groups.yml
Требования
На узле, который выполняет этот модуль, должны быть установлены следующие компоненты.
- python >= 3.9
Параметры
Параметр | Комментарии |
|---|---|
connection_info dictionary / обязательный | Сведения, необходимые для установления соединения с системой хранения. |
|
address string / обязательный |
IP-адрес или имя хоста системы хранения. |
|
connection_type string |
Тип подключения к системе хранения. Варианты:
|
|
password string / обязательный |
Пароль для аутентификации. Это обязательное поле. |
|
username string / обязательный |
Имя пользователя для аутентификации. Это обязательное поле. |
spec dictionary | Спецификация задачи для группы пользователей. |
|
external_group_name string |
Имя группы, зарегистрированной на внешнем сервере авторизации, если он подключен. |
|
id string |
Идентификатор группы пользователей. |
|
role_names list / элементы=string |
Роль группы пользователей. Необходимо указать как минимум одну роль. Это обязательное поле для создания группы пользователей. |
|
scope list / элементы=string |
Массив идентификаторов виртуальных частных хранилищ (VPS), к которым группа пользователей может получить доступ. |
|
vps_id string |
Идентификатор виртуального частного хранилища (VPS), которому принадлежит группа пользователей. |
|
vps_name string |
Имя виртуального частного хранилища (VPS), которому принадлежит группа пользователей. |
state string | Уровень задачи для группы пользователей. Варианты:
|
Атрибуты
Атрибут | Поддержка | Описание |
|---|---|---|
check_mode | Поддержка: полная | Определяет, должен ли модуль выполняться в режиме проверки. |
Примеры
- name: Create a new user group
hitachivantara.vspone_block.sds_block.hv_sds_block_user_group:
connection_info:
address: sdsb.company.com
username: "admin"
password: "password"
state: present
spec:
id: "vps_admin_4"
role_names:
- "Security"
- "Storage"
- "Monitor"
vps_id: "system"
scope:
- "system"
- "3ffcf3c6-5696-477e-bd0c-6a8d6ab4a0af"
- name: Update an existing user group
hitachivantara.vspone_block.sds_block.hv_sds_block_user_group:
connection_info:
address: sdsb.company.com
username: "admin"
password: "password"
state: present
spec:
id: "admin-vps02"
role_names:
- "Security"
- "Storage"
- "Monitor"
scope:
- "system"
- "2a843522-a819-47ab-a208-69d190809604"
- "ae0f247c-dc56-491c-9cb9-4b2b6d33b345"
- name: Delete a user group
hitachivantara.vspone_block.sds_block.hv_sds_block_user_group:
connection_info:
address: sdsb.company.com
username: "admin"
password: "password"
state: absent
spec:
id: "admin-vps02"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
user_groups dictionary | Сведения о конкретной группе пользователей, настроенной в системе. Возвращается: success |
|
external_group_name string |
Имя группы во внешнем каталоге (LDAP/AD), связанной с этой группой пользователей; для локальных групп значение пустое. Возвращается: success Пример: |
|
is_built_in boolean |
Указывает, является ли группа встроенной (определенной системой) или созданной пользователем. Возвращается: success Пример: |
|
member_users list / элементы=string |
Список пользователей, входящих в эту группу пользователей. Возвращается: success Пример: |
|
role_names list / элементы=string |
Список ролей, назначенных группе пользователей. Возвращается: success Пример: |
|
scope list / элементы=string |
Области действия, в которых применяются роли (например, «system» или идентификаторы VPS). Возвращается: success Пример: |
|
user_group_id string |
Уникальный идентификатор группы пользователей. Возвращается: success Пример: |
|
user_group_object_id string |
Идентификатор объекта, представляющего группу пользователей в системе управления. Возвращается: success Пример: |
|
vps_id string |
Идентификатор VPS или системного контекста, связанного с группой пользователей. Возвращается: success Пример: |
Ссылки на коллекцию
© 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/hitachivantara/vspone_block/sds_block.hv_sds_block_user_group_module.html