Модуль hitachivantara.vspone_block.sds_block.hv_sds_block_user_group_facts — получение групп пользователей из системы хранения.
Примечание
Этот модуль входит в коллекцию 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_facts.
Добавлено в hitachivantara.vspone_block 4.4.0
Краткое описание
- Получение пользователей из системы хранения.
- Примеры см. по адресу https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/sdsb_user_group_facts.yml
Требования
Следующие требования должны быть выполнены на узле, который выполняет этот модуль.
- python >= 3.9
Параметры
Параметр | Комментарии |
|---|---|
connection_info dictionary / обязательный | Данные, необходимые для подключения к системе хранения. |
|
address string / обязательный |
IP-адрес или имя узла системы хранения. |
|
connection_type string |
Тип подключения к системе хранения. Варианты:
|
|
password string / обязательный |
Пароль для аутентификации. Обязательное поле. |
|
username string / обязательный |
Имя пользователя для аутентификации. Обязательное поле. |
spec dictionary | Спецификация для получения сведений о группах пользователей. |
|
id string |
Фильтрация групп пользователей по идентификатору (формат UUID). |
|
vps_id string |
Фильтрация групп пользователей по идентификатору VPS. |
|
vps_name string |
Фильтрация групп пользователей по имени VPS. |
Атрибуты
Атрибут | Поддержка | Описание |
|---|---|---|
check_mode | Поддержка: полная | Определяет, должен ли модуль выполняться в режиме проверки. |
Примеры
- name: Retrieve information about all user groups
hitachivantara.vspone_block.sds_block.hv_sds_block_user_group_facts:
connection_info:
address: sdsb.company.com
username: "admin"
password: "password"
- name: Retrieve information about user group by specifying id
hitachivantara.vspone_block.sds_block.hv_sds_block_user_group_facts:
connection_info:
address: sdsb.company.com
username: "admin_group"
password: "password"
spec:
id: "1"
Возвращаемые факты
Факты, возвращаемые этим модулем, добавляются в факты узла hostvars или обновляются в них; на них можно ссылаться по имени, как и на любые другие факты узла. Для их использования не требуется регистрировать их.
Ключ | Описание |
|---|---|
user_groups dictionary | Сведения о группах пользователей. Возвращается: success |
|
external_group_name string |
Имя группы во внешнем каталоге, если применимо. Возвращается: success Пример: |
|
is_built_in boolean |
Указывает, является ли группа пользователей встроенной системной группой. Возвращается: success Пример: |
|
member_users list / elements=string |
Список пользователей, входящих в группу. Возвращается: success Пример: |
|
role_names list / elements=string |
Список ролей, назначенных группе пользователей. Возвращается: success Пример: |
|
scope list / elements=string |
Список областей, в которых применимы роли группы. Возвращается: 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_facts_module.html