Модуль hitachivantara.vspone_block.sds_block.hv_sds_block_user — создание и обновление пользователей в системе хранения данных

Примечание

Этот модуль входит в коллекцию 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.

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

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

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

Создание и обновление пользователей в системе хранения данных.
Примеры см. по адресу https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/sdsb_users.yml

Требования

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

python >= 3.9

Параметры

Параметр	Комментарии
connection_info dictionary / обязательный	Информация, необходимая для установления соединения с системой хранения данных.
address string / обязательный	IP-адрес или имя хоста системы хранения данных.
connection_type string	Тип соединения с системой хранения данных. Варианты: `"direct"` ← (по умолчанию)
password string / обязательный	Пароль для аутентификации. Это обязательное поле.
username string / обязательный	Имя пользователя для аутентификации. Это обязательное поле.
spec dictionary	Параметры задачи для пользователя.
authentication string	Метод аутентификации пользователя. Обязателен для задачи создания пользователя. Варианты: `"local"` ← (по умолчанию) `"external"`
current_password string	Текущий пароль пользователя. Обязателен для задачи обновления пароля пользователя.
id псевдонимы: user_id string	Идентификатор пользователя. Это псевдоним user_id. Обязателен для задач создания пользователя и обновления пароля пользователя.
is_enabled boolean	Включает или отключает пользователя. Варианты: `false` `true` ← (по умолчанию)
is_enabled_console_login boolean	Определяет, может ли пользователь входить в консоль. Обязателен для задачи создания пользователя. Варианты: `false` `true` ← (по умолчанию)
new_password string	Новый пароль пользователя. Обязателен для задачи обновления пароля пользователя.
password string	Пароль пользователя. Обязателен для задачи создания пользователя.
user_group_ids list / элементы=string	Список идентификаторов групп пользователей, в которые входит пользователь. Обязателен для задачи создания пользователя.
state string	Уровень задачи для пользователя. Варианты: `"present"` ← (по умолчанию) `"update"` `"absent"` `"add_user_group"` `"remove_user_group"`

Атрибуты

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

Примеры

- name: Create a new user
  hitachivantara.vspone_block.sds_block.hv_sds_block_user:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    state: present
    spec:
      user_id: "new_user"
      password: "CHANGE_ME_SET_YOUR_PASSWORD"
      user_group_ids:
        - "admin_group"
      authentication: "local"
      is_enabled_console_login: true

- name: Update an existing user password
  hitachivantara.vspone_block.sds_block.hv_sds_block_user:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    state: update
    spec:
      user_id: "existing_user"
      current_password: "CHANGE_ME_SET_YOUR_PASSWORD"
      new_password: "CHANGE_ME_SET_YOUR_NEW_PASSWORD"

- name: Update user settings
  hitachivantara.vspone_block.sds_block.hv_sds_block_user:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "CHANGE_ME_SET_YOUR_PASSWORD"
    state: present
    spec:
      id: "radey-vps02-admin-5"
      password: "CHANGE_ME_SET_YOUR_NEW_PASSWORD"
      is_enabled: false

- name: Delete a user
  hitachivantara.vspone_block.sds_block.hv_sds_block_user:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "CHANGE_ME_SET_YOUR_PASSWORD"
    state: absent
    spec:
      id: "radey-vps02-admin-4"

- name: Add user to user groups
  hitachivantara.vspone_block.sds_block.hv_sds_block_user:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "CHANGE_ME_SET_YOUR_PASSWORD"
    state: add_user_group
    spec:
      id: "radey-admin"
      user_group_ids: ["admin_4", "admin_1"]

- name: Remove user to user groups
  hitachivantara.vspone_block.sds_block.hv_sds_block_user:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "CHANGE_ME_SET_YOUR_PASSWORD"
    state: remove_user_group
    spec:
      id: "radey-admin"
      user_group_ids: ["admin_4", "admin_1"]

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

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

Ключ	Описание
users dictionary	Сведения о пользователе, полученные или обработанные модулем. Возвращается: всегда
authentication string	Тип аутентификации пользователя. Возвращается: при успешном выполнении Пример: `"local"`
is_built_in boolean	Указывает, является ли пользователь встроенной учетной записью системы. Возвращается: при успешном выполнении Пример: `false`
is_enabled boolean	Указывает, включена ли учетная запись пользователя. Возвращается: при успешном выполнении Пример: `true`
is_enabled_console_login boolean	Указывает, разрешен ли пользователю вход в консоль. Возвращается: при успешном выполнении Пример: `true`
password_expiration_time string	Время истечения срока действия пароля пользователя в формате ISO 8601. Возвращается: при успешном выполнении Пример: `"2025-11-27T10:35:36Z"`
privileges list / элементы=dictionary	Список привилегий, назначенных пользователю. Возвращается: при успешном выполнении
role_names list / элементы=string	Список имен ролей, назначенных для этой привилегии. Возвращается: при успешном выполнении Пример: `["Security", "Monitor"]`
scope string	Область действия привилегии. Возвращается: при успешном выполнении Пример: `"system"`
role_names list / элементы=string	Роли, назначенные пользователю. Возвращается: при успешном выполнении Пример: `["Security", "Monitor"]`
user_groups list / элементы=dictionary	Группы пользователей, в которые входит пользователь. Возвращается: при успешном выполнении
user_group_id string	Идентификатор группы пользователей. Возвращается: при успешном выполнении Пример: `"SecurityAdministrators"`
user_group_object_id string	Идентификатор объекта группы пользователей. Возвращается: при успешном выполнении Пример: `"SecurityAdministrators"`
user_id string	Уникальный идентификатор пользователя. Возвращается: при успешном выполнении Пример: `"testqw"`
user_object_id string	Идентификатор объекта пользователя. Возвращается: при успешном выполнении Пример: `"testqw"`
vps_id string	Идентификатор VPS или системы, к которой относится пользователь. Возвращается: при успешном выполнении Пример: `"(system)"`

Авторы

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/sds_block.hv_sds_block_user_module.html