Модуль hitachivantara.vspone_block.vsp.hv_user_group — управление группами пользователей в блочных системах хранения данных 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.

Добавлено в hitachivantara.vspone_block 3.3.0

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

Краткое описание

Этот модуль позволяет создавать и удалять группы пользователей в блочных системах хранения данных VSP.
Он также позволяет добавлять группы ресурсов в группу пользователей и удалять их из неё.
Модуль поддерживает типы подключений direct.
Примеры см. по адресу https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/user_group.yml

Требования

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

python >= 3.9

Параметры

Параметр	Комментарии
connection_info dictionary / обязательный	Информация, необходимая для установления подключения к системе хранения данных.
address string / обязательный	IP-адрес или имя узла системы хранения данных.
api_token string	Токен для выполнения операций с заблокированными ресурсами.
password string	Пароль для аутентификации. Это обязательное поле.
username string	Имя пользователя для аутентификации. Это обязательное поле.
spec dictionary / обязательный	Параметры группы пользователей.
id string	Идентификатор группы пользователей. Обязателен для задач «Изменить имя группы пользователей», «Добавить группы ресурсов в группу пользователей», «Удалить группы ресурсов из группы пользователей», «Удалить группу пользователей по идентификатору», «Добавить роли в группу пользователей» и «Удалить роли из группы пользователей».
name string	Имя группы пользователей. Обязательно для задач «Создать группу пользователей», «Изменить имя группы пользователей» и «Удалить группу пользователей по имени».
resource_group_ids list / elements=integer	Список идентификаторов групп ресурсов, которые нужно добавить в группу пользователей или удалить из неё. Следующие шесть имён ролей предоставляют доступ ко всем группам ресурсов, поэтому это поле игнорируется, если указать любое из этих имён в поле role_names. AUDIT_LOG_ADMIN_VIEW_N_MODIFY AUDIT_LOG_ADMIN_VIEW_ONLY SECURITY_ADMIN_VIEW_N_MODIFY SECURITY_ADMIN_VIEW_ONLY SUPPORT_PERSONNEL USER_MAINTENANCE Необязательно для задач «Создать группу пользователей», «Добавить группы ресурсов в группу пользователей» и «Удалить группы ресурсов из группы пользователей».
role_names list / elements=string	Имя роли. Укажите одно или несколько имён ролей из приведённого ниже списка. AUDIT_LOG_ADMIN_VIEW_N_MODIFY AUDIT_LOG_ADMIN_VIEW_ONLY SECURITY_ADMIN_VIEW_N_MODIFY SECURITY_ADMIN_VIEW_ONLY STORAGE_ADMIN_INIT_CONFIG STORAGE_ADMIN_LOCAL_COPY STORAGE_ADMIN_PERF_MGMT STORAGE_ADMIN_PROVISION STORAGE_ADMIN_REMOTE_COPY STORAGE_ADMIN_SYS_RESOURCE_MGMT STORAGE_ADMIN_VIEW_ONLY SUPPORT_PERSONNEL USER_MAINTENANCE Необязательно для задач «Создать группу пользователей», «Добавить роли в группу пользователей» и «Удалить роли из группы пользователей».
state string	Операция, выполняемая над группами ресурсов в группе пользователей. `add_resource_group` — добавить группы ресурсов в группу пользователей. `remove_resource_group` — удалить группы ресурсов из группы пользователей. `add_role` — добавить роли в группу пользователей. `remove_role` — удалить роли из группы пользователей. Обязательно для задач «Добавить группы ресурсов в группу пользователей», «Удалить группы ресурсов из группы пользователей», «Добавить роли в группу пользователей» и «Удалить роли из группы пользователей». Варианты: `"add_resource_group"` `"remove_resource_group"` `"add_role"` `"remove_role"`
state string	Требуемое состояние задачи для группы пользователей. Варианты: `"present"` ← (по умолчанию) `"absent"`

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: нет	Определяет, следует ли запускать модуль в режиме проверки.

Примечания

Примечание

Тип подключения gateway удалён начиная с версии 3.4.0. Если требуется этот тип подключения, используйте более раннюю версию.

Примеры

- name: Create a User Group for direct connection type
  hitachivantara.vspone_block.vsp.hv_user_group:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      name: "devGroup"
      role_names: ["STORAGE_ADMIN_PERF_MGMT", "STORAGE_ADMIN_PROVISION"]
      resource_group_ids: [8, 9]

- name: Change User Group Name for direct connection type
  hitachivantara.vspone_block.vsp.hv_user_group:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      id: "devGroup3_new_3"
      name: "devGroup3_new_4"

- name: Add Resource Groups to a User Group for direct connection type
  hitachivantara.vspone_block.vsp.hv_user_group:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      state: add_resource_group
      id: "devGroup3"
      resource_group_ids: [1, 2]

- name: Remove Resource Groups from a User Group for direct connection type
  hitachivantara.vspone_block.vsp.hv_user_group:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      state: remove_resource_group
      id: "devGroup3"
      resource_group_ids: [1, 2]

- name: Delete a User Group by ID for direct connection type
  hitachivantara.vspone_block.vsp.hv_user_group:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    state: absent
    spec:
      id: "devGroup3"

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:

Ключ	Описание
user_groups dictionary	Информация о группе пользователей. Возвращается: всегда
has_all_resource_group boolean	Указывает, имеет ли группа пользователей доступ ко всем группам ресурсов. Возвращается: при успешном выполнении Пример: `false`
id string	Идентификатор группы пользователей. Возвращается: при успешном выполнении Пример: `"devGroup8"`
is_built_in boolean	Указывает, является ли группа пользователей встроенной. Возвращается: при успешном выполнении Пример: `false`
name string	Имя группы пользователей. Возвращается: при успешном выполнении Пример: `"devGroup8"`
resource_group_ids list / elements=integer	Список идентификаторов групп ресурсов. Возвращается: при успешном выполнении Пример: `[0, 8, 9, 1023]`
role_names list / elements=string	Список имён ролей. Возвращается: при успешном выполнении Пример: `["Storage Administrator (Performance Management)", "Storage Administrator (Provisioning)"]`

Авторы

Hitachi Vantara LTD (@hitachi-vantara)

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

© 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_module.html