Модуль dellemc.openmanage.ome_user_info — получение сведений обо всех учетных записях или об определенной учетной записи в OpenManage Enterprise

Примечание

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

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

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

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

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

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

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

Этот модуль получает список и основные сведения обо всех учетных записях или сведения об определенной учетной записи в OpenManage Enterprise.

Требования

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

python >= 3.9.6

Параметры

Параметр	Комментарии
account_id integer	Уникальный идентификатор учетной записи.
ca_path path добавлено в dellemc.openmanage 5.0.0	Файл Privacy Enhanced Mail (PEM), содержащий сертификат CA для проверки.
hostname string / обязательный	IP-адрес или имя хоста OpenManage Enterprise либо OpenManage Enterprise Modular.
password string	Пароль OpenManage Enterprise или OpenManage Enterprise Modular. Если пароль не указан, используется переменная среды `OME_PASSWORD`. Пример: export OME_PASSWORD=password
port integer	HTTPS-порт OpenManage Enterprise или OpenManage Enterprise Modular. По умолчанию: `443`
system_query_options dictionary	Параметры фильтрации выходных данных.
filter string	Фильтрация записей по поддерживаемым значениям.
timeout integer добавлено в dellemc.openmanage 5.0.0	Тайм-аут уровня сокета в секундах. По умолчанию: `30`
username string	Имя пользователя OpenManage Enterprise или OpenManage Enterprise Modular. Если имя пользователя не указано, используется переменная среды `OME_USERNAME`. Пример: export OME_USERNAME=username
validate_certs boolean добавлено в dellemc.openmanage 5.0.0	Если `false`, SSL-сертификаты не проверяются. Указывайте `false` только на сайтах под личным управлением, где используются самоподписанные сертификаты. В версиях коллекции до `5.0.0` значение validate_certs по умолчанию — `false`. Варианты: `false` `true` ← (по умолчанию)
x_auth_token string добавлено в 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: Retrieve basic details of all accounts
  dellemc.openmanage.ome_user_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"

- name: Retrieve details of a specific account identified by its account ID
  dellemc.openmanage.ome_user_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    account_id: 1

- name: Get filtered user info based on user name
  dellemc.openmanage.ome_user_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    system_query_options:
      filter: "UserName eq 'test'"

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

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

Ключ	Описание
msg string	Общий статус получения сведений о пользователе. Возвращается: при ошибке Пример: `"Unable to retrieve the account details."`
user_info dictionary	Сведения о пользователе. Возвращается: при успешном выполнении Пример: `{"192.168.0.1": {"Description": "user name description", "DirectoryServiceId": 0, "Enabled": true, "Id": "1814", "IsBuiltin": true, "Locked": false, "Name": "user_name", "Password": null, "RoleId": "10", "UserName": "user_name", "UserTypeId": 1}}`

Авторы

Jagadeesh N V (@jagadeeshnv)

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

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