online_user_info – Сбор информации о пользователе онлайн
Новое в версии 2.9.
Описание
- Сбор информации о пользователе.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| 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
online_user_info:
register: result
- 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'}} |
Статус
- Для данного модуля не гарантируется обратная совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Remy Leone (@sieben)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/online_user_info_module.html