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

Note

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

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

Comments

api_timeout

aliases: timeout

integer

HTTP timeout to Online API in seconds.

Default: 30

api_token

aliases: oauth_token

string / required

Online OAuth token.

api_url

aliases: base_url

string

Online API URL

Default: “https://api.online.net”

validate_certs

boolean

Validate SSL certs of the Online API.

Choices:

  • no

  • yes ← (default)

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

Description

online_user_info

dictionary

Response from Online API.

For more details please refer to: https://console.online.net/en/api/.

Returned: success

Sample: {“online_user_info”: {“company”: “foobar LLC”, “email”: “foobar@example.com”, “first_name”: “foo”, “id”: 42, “last_name”: “bar”, “login”: “foobar”}}

Authors

  • Remy Leone (@remyleone)