New in version 2.8.
Parameter | Choices/Defaults | Comments |
---|---|---|
api_timeout
integer
|
Default: 30
|
HTTP timeout to Online API in seconds.
aliases: timeout |
api_token
string
|
Online OAuth token.
aliases: oauth_token |
|
api_url
string
|
Default: "https://api.online.net"
|
Online API URL
aliases: base_url |
validate_certs
boolean
|
|
Validate SSL certs of the Online API.
|
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.
- name: Gather Online server facts
online_server_facts:
api_token: '0d1627e8-bbf0-44c5-a46f-5c4d3aef033f'
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
online_server_facts
complex
|
success |
Response from Online API
|
|
online_server_facts
-
|
|
This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]
Remy Leone (@sieben)
Hint
If you notice any issues in this documentation you can edit this document to improve it.