community.general.online_user_info – Gather information about Online user.¶
Note
This plugin is part of the community.general collection (version 2.5.1).
To install it use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.online_user_info
.
Parameters¶
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 precedenceONLINE_TOKEN
,ONLINE_API_KEY
,ONLINE_OAUTH_TOKEN
,ONLINE_API_TOKEN
If one wants to use a different
api_url
one can also set theONLINE_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
complex
|
success |
Response from Online API
Sample:
{'online_user_info': {'company': 'foobar LLC', 'email': '[email protected]', 'first_name': 'foo', 'id': 42, 'last_name': 'bar', 'login': 'foobar'}}
|
Authors¶
Remy Leone (@sieben)