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

Note

This module is part of the community.general collection (version 6.6.9).

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:

  • false

  • true ← (default)

Attributes

Attribute

Support

Description

check_mode

Support: full

This action does not modify state.

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: N/A

This action does not modify state.

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

Notes

Note

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)