online_user_facts – Gather facts about Online user¶
New in version 2.7.
DEPRECATED¶
- Removed in Ansible
version: 2.13
- Why
Deprecated in favour of
_info
module.- Alternative
Use online_user_info instead.
Synopsis¶
Gather facts about the user.
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 facts
online_user_facts:
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Status¶
This module will be removed in version 2.13. [deprecated]
For more information see DEPRECATED.