online_user_facts - Gather facts about Online user.¶
New in version 2.7.
Parameters¶
Parameter | Choices/Defaults | Comments |
---|---|---|
api_timeout |
Default: 30
|
HTTP timeout to Online API in seconds.
aliases: timeout |
api_token |
Online OAuth token.
aliases: oauth_token |
|
api_url |
Default: https://api.online.net/api/v1
|
Online API URL
aliases: base_url |
validate_certs
bool |
|
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 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.
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
online_user_facts
complex
|
success |
Response from Online API
|
|
online_user_facts
|
|
Status¶
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Maintenance¶
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Author¶
- Remy Leone (@sieben)
Hint
If you notice any issues in this documentation you can edit this document to improve it.