community.general.online_server_info module – Gather information about Online servers

Note

This module is part of the community.general collection (version 9.4.0).

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

Parameters

Parameter

Comments

api_timeout

aliases: timeout

integer

HTTP timeout to Online API in seconds.

Default: 30

api_token

aliases: oauth_token

string / required

Online OAuth token.

api_url

aliases: base_url

string

Online API URL.

Default: "https://api.online.net"

validate_certs

boolean

Validate SSL certs of the Online API.

Choices:

  • false

  • true ← (default)

Attributes

Attribute

Support

Description

check_mode

Support: full

This action does not modify state.

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: N/A

This action does not modify state.

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

Notes

Note

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

online_server_info

list / elements=dictionary

Response from Online API.

For more details please refer to: https://console.online.net/en/api/.

Returned: success

Sample: {"online_server_info": [{"abuse": "abuse@example.com", "anti_ddos": false, "bmc": {"session_key": null}, "boot_mode": "normal", "contacts": {"owner": "foobar", "tech": "foobar"}, "disks": [{"$ref": "/api/v1/server/hardware/disk/68452"}, {"$ref": "/api/v1/server/hardware/disk/68453"}], "drive_arrays": [{"disks": [{"$ref": "/api/v1/server/hardware/disk/68452"}, {"$ref": "/api/v1/server/hardware/disk/68453"}], "raid_controller": {"$ref": "/api/v1/server/hardware/raidController/9910"}, "raid_level": "RAID1"}], "hardware_watch": true, "hostname": "sd-42", "id": 42, "ip": [{"address": "195.154.172.149", "mac": "28:92:4a:33:5e:c6", "reverse": "195-154-172-149.rev.poneytelecom.eu.", "switch_port_state": "up", "type": "public"}, {"address": "10.90.53.212", "mac": "28:92:4a:33:5e:c7", "reverse": null, "switch_port_state": "up", "type": "private"}], "last_reboot": "2018-08-23T08:32:03.000Z", "location": {"block": "A", "datacenter": "DC3", "position": 19, "rack": "A23", "room": "4 4-4"}, "network": {"ip": ["195.154.172.149"], "ipfo": [], "private": ["10.90.53.212"]}, "offer": "Pro-1-S-SATA", "os": {"name": "FreeBSD", "version": "11.1-RELEASE"}, "power": "ON", "proactive_monitoring": false, "raid_controllers": [{"$ref": "/api/v1/server/hardware/raidController/9910"}], "support": "Basic service level"}]}

Authors

  • Remy Leone (@remyleone)