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

Примечание

Этот плагин входит в коллекцию community.general (версия 2.0.1).

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

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

Описание
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

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

Параметры

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

Примечания

Примечание

См. также документацию API по адресу https://console.online.net/ru/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. Пример: {'online_user_info': {'company': 'foobar LLC', 'email': 'foobar@example.com', 'first_name': 'foo', 'id': 42, 'last_name': 'bar', 'login': 'foobar'}}

Авторы

Remy Leone (@sieben)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/online_user_info_module.html