Модуль hitachivantara.vspone_block.vsp.hv_user_group_facts — извлекает сведения о группах пользователей из блочных систем хранения VSP.
Примечание
Этот модуль входит в коллекцию hitachivantara.vspone_block (версия 4.8.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install hitachivantara.vspone_block. Для использования этого модуля могут потребоваться дополнительные компоненты. Подробнее см. в разделе Требования.
Чтобы использовать его в плейбуке, укажите: hitachivantara.vspone_block.vsp.hv_user_group_facts.
Добавлено в hitachivantara.vspone_block 3.3.0
Краткое описание
- Этот модуль извлекает сведения о группах пользователей из блочных систем хранения VSP.
- Примеры см. по адресу https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/user_group_facts.yml
Требования
На узле, где выполняется этот модуль, должны быть установлены следующие компоненты.
- python >= 3.9
Параметры
Параметр | Комментарии |
|---|---|
connection_info dictionary / required | Сведения, необходимые для установления соединения с системой хранения. |
|
address string / required |
IP-адрес или имя хоста системы хранения. |
|
api_token string |
Токен для выполнения операций с заблокированными ресурсами. |
|
password string |
Пароль для аутентификации. Это обязательное поле. |
|
username string |
Имя пользователя для аутентификации. Это обязательное поле. |
spec dictionary | Спецификация для сбора сведений о группах пользователей. |
|
id string |
Идентификатор конкретной группы пользователей, сведения о которой нужно получить. Обязателен для задачи Get User Group by ID. |
|
name string |
Имя конкретной группы пользователей, сведения о которой нужно получить. Обязательно для задачи Get User Group by name. |
Атрибуты
Атрибут | Поддержка | Описание |
|---|---|---|
check_mode | Поддержка: full | Определяет, должен ли модуль выполняться в режиме проверки. |
Примечания
Примечание
- Тип подключения
gatewayудалён начиная с версии 3.4.0. Если вам нужен этот тип подключения, используйте более раннюю версию.
Примеры
- name: Get all user groups for direct connection type
hitachivantara.vspone_block.vsp.hv_user_group_facts:
connection_info:
address: storage1.company.com
username: "admin"
password: "secret"
- name: Get user group by name for direct connection type
hitachivantara.vspone_block.vsp.hv_user_group_facts:
connection_info:
address: storage1.company.com
username: "admin"
password: "secret"
spec:
name: "my_user_group"
Возвращаемые факты
Факты, возвращаемые этим модулем, добавляются в факты узла hostvars или обновляют их; на них можно ссылаться по имени, как и на любые другие факты узла. Для их использования не требуется регистрация.
Ключ | Описание |
|---|---|
user_groups list / elements=dictionary | Сведения о группах пользователей. Возвращается: при успешном выполнении |
|
has_all_resource_group boolean |
Указывает, включает ли группа пользователей все группы ресурсов. Возвращается: при успешном выполнении Пример: |
|
id string |
Идентификатор группы пользователей. Возвращается: при успешном выполнении Пример: |
|
is_built_in boolean |
Указывает, является ли группа пользователей встроенной. Возвращается: при успешном выполнении Пример: |
|
name string |
Имя группы пользователей. Возвращается: при успешном выполнении Пример: |
|
resource_group_ids list / elements=integer |
Идентификаторы групп ресурсов. Возвращается: при успешном выполнении Пример: |
|
role_names list / elements=string |
Названия ролей. Возвращается: при успешном выполнении Пример: |
|
users list / elements=string |
Список пользователей, входящих в эту группу пользователей. Возвращается: при успешном выполнении Пример: |
Ссылки на коллекцию
© 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/vsp.hv_user_group_facts_module.html