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

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

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

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

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

Требования

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

python >= 3.9

Параметры

Параметр	Комментарии
connection_info dictionary / обязательный	Сведения, необходимые для подключения к системе хранения.
address string / обязательный	IP-адрес или имя хоста системы хранения.
api_token string	Токен для выполнения операций с заблокированными ресурсами.
password string	Пароль для аутентификации. Это обязательное поле.
username string	Имя пользователя для аутентификации. Это обязательное поле.
spec dictionary / обязательный	Параметры пользователя.
authentication string	Метод аутентификации пользователя. Обязателен при создании пользователя. Варианты: `"local"` ← (по умолчанию) `"external"`
group_names list / elements=string	Имя группы пользователей. Можно указать не более 8 имён групп. Необязательный параметр для задач «Создать учётную запись пользователя», «Добавить пользователя в группы по ID пользователя», «Добавить пользователя в группы по имени пользователя», «Удалить пользователя из групп по ID пользователя» и «Удалить пользователя из групп по имени».
id string	ID пользователя. Обязателен для задач «Изменить пароль пользователя по ID пользователя», «Добавить пользователя в группы по ID пользователя», «Удалить пользователя из групп по ID пользователя» и «Удалить пользователя по ID».
name string	Имя пользователя. Обязательно для задач «Создать учётную запись пользователя», «Изменить пароль пользователя по имени пользователя», «Добавить пользователя в группы по имени пользователя», «Удалить пользователя из групп по имени» и «Удалить пользователя по имени».
password string	Пароль пользователя. Обязателен для задач «Создать учётную запись пользователя», «Изменить пароль пользователя по ID пользователя» и «Изменить пароль пользователя по имени пользователя».
state string	Операция, выполняемая с пользователем. `add_user_group` — добавить пользователя в группы пользователей. `remove_user_group` — удалить пользователя из групп пользователей. Обязателен для задач «Добавить пользователя в группы по ID пользователя», «Добавить пользователя в группы по имени пользователя», «Удалить пользователя из групп по ID пользователя» и «Удалить пользователя из групп по имени». Варианты: `"add_user_group"` `"remove_user_group"`
state string	Требуемое состояние задачи для пользователя. Варианты: `"present"` ← (по умолчанию) `"absent"`

Атрибуты

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

Примечания

Примечание

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

Примеры

- name: Create a User
  hitachivantara.vspone_block.vsp.hv_user_group:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      name: "devUser"
      authentication: "local"
      password: "CHANGE_ME_SET_YOUR_PASSWORD"
      group_names: [
        "Audit Log Administrator (View Only) User Group",
        "Storage Administrator (View & Modify) User Group"]

- name: Change User Password by User Name
  hitachivantara.vspone_block.vsp.hv_user_group:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      name: "devUser"
      password: "CHANGE_ME_SET_YOUR_PASSWORD"

- name: Add Resource Groups to a User Group
  hitachivantara.vspone_block.vsp.hv_user_group:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      state: add_user_group
      id: "devUser"
      group_names: ["devGroup3_new_4"]

- name: Remove User from  User Groups by User ID
  hitachivantara.vspone_block.vsp.hv_user_group:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      state: remove_user_group
      id: "devUser"
      group_names: ["devGroup3_new_4"]

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

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

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

Ключ	Описание
users dictionary	Сведения о пользователе. Возвращается: всегда
authentication string	Метод аутентификации. Возвращается: при успехе Пример: `"local"`
id string	ID пользователя. Возвращается: при успехе Пример: `"devUser"`
is_account_status boolean	Статус учётной записи пользователя. Возвращается: при успехе Пример: `true`
is_built_in boolean	Указывает, является ли пользователь встроенным. Возвращается: при успехе Пример: `false`
name string	Имя пользователя. Возвращается: при успехе Пример: `"devUser"`
user_group_names list / elements=string	Названия групп пользователей. Возвращается: при успехе Пример: `["Audit Log Administrator (View Only) User Group", "Storage Administrator (View & Modify) User Group"]`

Авторы

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