W3cubDocs

/Ansible 2.11

community.general.online_user_facts – Gather facts about Online user.

Note

This plugin is part of the community.general collection (version 2.0.1).

To install it use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.online_user_facts.

DEPRECATED

Removed in

version 3.0.0

Why

Deprecated in favour of _info module.

Alternative

Use community.general.online_user_info instead.

Synopsis

  • Gather facts about the user.

Parameters

Parameter Choices/Defaults Comments
api_timeout
integer
Default:
30
HTTP timeout to Online API in seconds.

aliases: timeout
api_token
string / required
Online OAuth token.

aliases: oauth_token
api_url
string
Default:
"https://api.online.net"
Online API URL

aliases: base_url
validate_certs
boolean
    Choices:
  • no
  • yes ←
Validate SSL certs of the Online API.

Notes

Note

  • Also see the API documentation on https://console.online.net/en/api/
  • If api_token is not set within the module, the following environment variables can be used in decreasing order of precedence ONLINE_TOKEN, ONLINE_API_KEY, ONLINE_OAUTH_TOKEN, ONLINE_API_TOKEN
  • If one wants to use a different api_url one can also set the ONLINE_API_URL environment variable.

Examples

- name: Gather Online user facts
  community.general.online_user_facts:

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
online_user_facts
complex
success
Response from Online API

Sample:
{'online_user_facts': {'company': 'foobar LLC', 'email': '[email protected]', 'first_name': 'foo', 'id': 42, 'last_name': 'bar', 'login': 'foobar'}}


Status

  • This module will be removed in version 3.0.0. [deprecated]
  • For more information see DEPRECATED.

Authors

  • 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