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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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 целое число	Уникальный идентификатор учетной записи.
ca_path путь добавлено в dellemc.openmanage 5.0.0	Файл с сертификатом CA (PEM), используемый для валидации.
hostname строка / обязательно	IP-адрес или имя хоста OpenManage Enterprise или OpenManage Enterprise Modular.
password строка	Пароль OpenManage Enterprise или OpenManage Enterprise Modular. Если пароль не указан, используется переменная среды `OME_PASSWORD`. Пример: export OME_PASSWORD=password
port целое число	Порт HTTPS OpenManage Enterprise или OpenManage Enterprise Modular. По умолчанию: `443`
system_query_options словарь	Параметры для фильтрации вывода.
filter строка	Фильтр записей для поддерживаемых значений.
timeout целое число добавлено в dellemc.openmanage 5.0.0	Таймаут уровня сокета в секундах. По умолчанию: `30`
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: 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 строка	Общий статус получения данных пользователя. Возвращается: при ошибке Пример: `"Unable to retrieve the account details."`
user_info словарь	Подробности о пользователе. Возвращается: при успехе Пример: `{"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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/dellemc/openmanage/ome_user_info_module.html