community.general.online_user_info – Сбор информации об онлайн-пользователе.
Примечание
Этот плагин является частью коллекции community.general (версия 1.3.2).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в книге задач укажите: community.general.online_user_info.
Обзор
- Сбор информации о пользователе.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout целое число | Значение по умолчанию: 30 | Таймаут HTTP-запроса к Online API в секундах. псевдонимы: timeout |
| api_token строка / обязательный | Токен Online OAuth. псевдонимы: oauth_token | |
| api_url строка | Значение по умолчанию: "https://api.online.net" | URL Online API псевдонимы: base_url |
| validate_certs логическое значение |
| Проверка SSL-сертификатов Online 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 сложный тип | успешно | Ответ от Online 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/online_user_info_module.html