Модуль dellemc.openmanage.ome_user — создание, изменение или удаление пользователя в OpenManage Enterprise

Примечание

Этот модуль входит в коллекцию dellemc.openmanage (версия 10.0.2).

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install dellemc.openmanage. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: dellemc.openmanage.ome_user.

Добавлено в dellemc.openmanage 2.0.0

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

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

Этот модуль создает, изменяет или удаляет пользователя в OpenManage Enterprise.

Требования

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

python >= 3.9.6

Параметры

Параметр	Комментарии
attributes словарь	Данные полезной нагрузки для операций с пользователями. Для `present` могут быть указаны следующие атрибуты. UserTypeId, DirectoryServiceId, Description, Name, Password, UserName, RoleId, Locked, Enabled. OME выдаст ошибку, если для операции не указан обязательный параметр. Дополнительные сведения см. в справочном руководстве по API OpenManage Enterprise. По умолчанию: `{}`
ca_path путь добавлено в dellemc.openmanage 5.0.0	Файл Privacy Enhanced Mail (PEM), содержащий сертификат ЦС для проверки.
hostname строка / обязательный	IP-адрес или имя хоста OpenManage Enterprise либо OpenManage Enterprise Modular.
name строка	Уникальное имя пользователя, которого необходимо удалить. Для операции `absent` обязательно указать либо user_id, либо name.
password строка	Пароль OpenManage Enterprise или OpenManage Enterprise Modular. Если пароль не указан, используется переменная среды `OME_PASSWORD`. Пример: export OME_PASSWORD=password
port целое число	HTTPS-порт OpenManage Enterprise или OpenManage Enterprise Modular. По умолчанию: `443`
state строка	`present` создает пользователя, если указанный в attributes параметр UserName не существует. `present` изменяет пользователя, если указанный в attributes параметр UserName существует. `absent` удаляет существующего пользователя. Варианты: `"present"` ← (по умолчанию) `"absent"`
timeout целое число добавлено в dellemc.openmanage 5.0.0	Тайм-аут на уровне сокета в секундах. По умолчанию: `30`
user_id целое число	Уникальный идентификатор пользователя, которого необходимо удалить. Для операции `absent` обязательно указать либо user_id, либо name.
username строка	Имя пользователя OpenManage Enterprise или OpenManage Enterprise Modular. Если имя пользователя не указано, используется переменная среды `OME_USERNAME`. Пример: export OME_USERNAME=username
validate_certs логическое значение добавлено в dellemc.openmanage 5.0.0	Если `false`, SSL-сертификаты не проверяются. Настраивайте `false` только на площадках, находящихся под вашим контролем, где используются самозаверяющие сертификаты. В версиях коллекции до `5.0.0` параметр validate_certs по умолчанию имеет значение `false`. Варианты: `false` `true` ← (по умолчанию)
x_auth_token строка добавлено в dellemc.openmanage 9.3.0	Токен аутентификации. Если x_auth_token не указан, используется переменная среды `OME_X_AUTH_TOKEN`. Пример: export OME_X_AUTH_TOKEN=x_auth_token

Примечания

Примечание

Запускайте этот модуль в системе, имеющей прямой доступ к Dell OpenManage Enterprise.
Этот модуль не поддерживает check_mode.

Примеры

---
- name: Create user with required parameters
  dellemc.openmanage.ome_user:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    attributes:
      UserName: "user1"
      Password: "UserPassword"
      RoleId: "10"
      Enabled: true

- name: Create user with all parameters
  dellemc.openmanage.ome_user:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    attributes:
      UserName: "user2"
      Description: "user2 description"
      Password: "UserPassword"
      RoleId: "10"
      Enabled: true
      DirectoryServiceId: 0
      UserTypeId: 1
      Locked: false
      Name: "user2"

- name: Modify existing user
  dellemc.openmanage.ome_user:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    state: "present"
    attributes:
      UserName: "user3"
      RoleId: "10"
      Enabled: true
      Description: "Modify user Description"

- name: Delete existing user using id
  dellemc.openmanage.ome_user:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    state: "absent"
    user_id: 1234

- name: Delete existing user using name
  dellemc.openmanage.ome_user:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    state: "absent"
    name: "name"

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

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

Ключ	Описание
msg строка	Общий статус операции с пользователем. Возвращается: всегда Пример: `"Successfully created a User"`
user_status словарь	Сведения об операции с пользователем, если state имеет значение `present`. Возвращается: если state имеет значение `present`. Пример: `{"Description": "Test user creation", "DirectoryServiceId": 0, "Enabled": true, "Id": "61546", "IsBuiltin": false, "Locked": false, "Name": "test", "Password": null, "PlainTextPassword": null, "RoleId": "10", "UserName": "test", "UserTypeId": 1}`

Ключ

Описание

msg

строка

Общий статус операции с пользователем.

Возвращается: всегда

Пример: "Successfully created a User"

user_status

словарь

Сведения об операции с пользователем, если state имеет значение present.

Возвращается: если state имеет значение present.

Пример: {"Description": "Test user creation", "DirectoryServiceId": 0, "Enabled": true, "Id": "61546", "IsBuiltin": false, "Locked": false, "Name": "test", "Password": null, "PlainTextPassword": null, "RoleId": "10", "UserName": "test", "UserTypeId": 1}

Авторы

Sajna Shetty(@Sajna-Shetty)

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

© 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/dellemc/openmanage/ome_user_module.html