community.general.online_user_info – Gather information about Online user.

Note

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

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

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

Synopsis

  • Gather information 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 info
  community.general.online_user_info:
  register: result

- ansible.builtin.debug:
    msg: "{{ result.online_user_info }}"

Return Values

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

Key Returned Description
online_user_info
dictionary
success
Response from Online API.
For more details please refer to: https://console.online.net/en/api/.

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


Authors

  • Remy Leone (@remyleone)