community.general.online_server_info module – Gather information about Online servers
Note
This module is part of the community.general collection (version 9.5.0).
You might already have this collection installed if you are using the ansible
package.
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_server_info
.
Synopsis
Gather information about the servers.
Parameters
Parameter |
Comments |
---|---|
HTTP timeout to Online API in seconds. Default: |
|
Online OAuth token. |
|
Online API URL. Default: |
|
Validate SSL certs of the Online API. Choices:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full This action does not modify state. |
Can run in |
|
Support: N/A This action does not modify state. |
Will return details on what has changed (or possibly needs changing in |
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 server information
community.general.online_server_info:
api_token: '0d1627e8-bbf0-44c5-a46f-5c4d3aef033f'
register: result
- ansible.builtin.debug:
msg: "{{ result.online_server_info }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Response from Online API. For more details please refer to: https://console.online.net/en/api/. Returned: success Sample: |