community.general.online_user_facts – Сбор фактов об онлайн-пользователе.
Примечание
Этот плагин входит в состав коллекции community.general (версия 1.3.2).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в плейбуке укажите: community.general.online_user_facts.
УСТЕРЕГШИЙСЯ
- Удалено в
-
версии 3.0.0
- Почему
-
Заменён на модуль
_info. - Альтернатива
-
Используйте 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/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 сложный тип | успех | Ответ от Online 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–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_facts_module.html