community.general.online_user_facts – Сбор фактов об онлайн-пользователе.
Примечание
Этот плагин является частью коллекции community.general (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в плейбуке укажите: community.general.online_user_facts.
УСТАНОВЛЕНО
- Удалено в
-
версии 3.0.0
- Почему
-
Заменено модулем
_info. - Альтернатива
-
Используйте 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/en/api/
- Если
api_tokenне задан в модуле, можно использовать следующие переменные окружения в порядке убывания приоритетаONLINE_TOKEN,ONLINE_API_KEY,ONLINE_OAUTH_TOKEN,ONLINE_API_TOKEN - Если требуется использовать другой
api_url, можно также установить переменную окруженияONLINE_API_URL.
Примеры
- name: Gather Online user facts community.general.online_user_facts:
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращённое значение | Описание |
|---|---|---|
| online_user_facts сложный | успех | Ответ от онлайн-API Пример: {'online_user_facts': {'company': 'foobar LLC', 'email': 'foobar@example.com', 'first_name': 'foo', 'id': 42, 'last_name': 'bar', 'login': 'foobar'}} |
Статус
- Этот модуль будет удален в версии 3.0.0. [устаревший]
- Для получения дополнительной информации см. УСТАНОВЛЕНО.
Авторы
- 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_facts_module.html