Модуль community.general.online_user_info – Сбор информации об онлайн-пользователе

Примечание

Этот модуль входит в коллекцию community.general (версия 9.5.0).

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

Для установки используйте: ansible-galaxy collection install community.general.

Для использования в книге задач укажите: community.general.online_user_info.

Обзор
Параметры
Атрибуты
Примечания
Примеры
Возвращаемые значения

Обзор

Сбор информации о пользователе.

Параметры

Параметр	Комментарии
api_timeout aliases: timeout целое число	Таймаут HTTP-запроса к онлайн-API в секундах. По умолчанию: `30`
api_token aliases: oauth_token строка / обязательно	Токен онлайн-OAuth.
api_url aliases: base_url строка	URL онлайн-API. По умолчанию: `"https://api.online.net"`
validate_certs логический тип	Проверка SSL-сертификатов онлайн-API. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная Это действие не изменяет состояние.	Модуль может работать в режиме `check_mode` и возвращать прогноз изменения состояния без изменения целевого объекта.
diff_mode	Поддержка: нет Это действие не изменяет состояние.	В режиме сравнения модуль вернёт подробности о том, что изменилось (или, возможно, требует изменения в `check_mode`).

Примечания

Примечание

См. также документацию API по адресу https://console.online.net/en/api/.
Если api_token не задано в модуле, можно использовать следующие переменные среды в порядке убывания приоритета ONLINE_TOKEN, ONLINE_API_KEY, ONLINE_OAUTH_TOKEN, ONLINE_API_TOKEN.
Если нужно использовать другой api_url, можно установить переменную среды ONLINE_API_URL.

Примеры

- name: Gather Online user info
  community.general.online_user_info:
  register: result

- ansible.builtin.debug:
    msg: "{{ result.online_user_info }}"

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

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

Ключ	Описание
online_user_info словарь	Ответ от онлайн-API. Дополнительные сведения см. по адресу: https://console.online.net/en/api/. Возвращается: success Пример: `{"online_user_info": {"company": "foobar LLC", "email": "foobar@example.com", "first_name": "foo", "id": 42, "last_name": "bar", "login": "foobar"}}`

Авторы

Remy Leone (@remyleone)

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

© 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/community/general/online_user_info_module.html