Unflatmap community.general (#5461)

* Move files. * Update imports and references. * Move wrongly placed files. * Reverse redirects, deprecate long → short name redirects. * Simplify contribution guidelines for new modules. * Rewrite BOTMETA. * Add changelog fragment. * Fix ignore.txt files.
2025-06-04 15:29:10 -07:00 · 2022-11-02 21:42:29 +01:00 · 2022-11-02 21:42:29 +01:00 · b531ecdc9b
commit b531ecdc9b
parent 2b0bebc8fc
1033 changed files with 4802 additions and 1989 deletions
--- a/plugins/modules/online_server_info.py
+++ b/plugins/modules/online_server_info.py
@ -0,0 +1,178 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+# Copyright (c) Ansible project
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+from __future__ import (absolute_import, division, print_function)
+
+__metaclass__ = type
+
+DOCUMENTATION = r'''
+---
+module: online_server_info
+short_description: Gather information about Online servers.
+description:
+  - Gather information about the servers.
+  - U(https://www.online.net/en/dedicated-server)
+author:
+  - "Remy Leone (@remyleone)"
+extends_documentation_fragment:
+- community.general.online
+
+'''
+
+EXAMPLES = r'''
+- 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 = r'''
+online_server_info:
+  description:
+    - Response from Online API.
+    - "For more details please refer to: U(https://console.online.net/en/api/)."
+  returned: success
+  type: list
+  elements: dict
+  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"
+        }
+    ]
+'''
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible_collections.community.general.plugins.module_utils.online import (
+    Online, OnlineException, online_argument_spec
+)
+
+
+class OnlineServerInfo(Online):
+
+    def __init__(self, module):
+        super(OnlineServerInfo, self).__init__(module)
+        self.name = 'api/v1/server'
+
+    def _get_server_detail(self, server_path):
+        try:
+            return self.get(path=server_path).json
+        except OnlineException as exc:
+            self.module.fail_json(msg="A problem occurred while fetching: %s (%s)" % (server_path, exc))
+
+    def all_detailed_servers(self):
+        servers_api_path = self.get_resources()
+
+        server_data = (
+            self._get_server_detail(server_api_path)
+            for server_api_path in servers_api_path
+        )
+
+        return [s for s in server_data if s is not None]
+
+
+def main():
+    module = AnsibleModule(
+        argument_spec=online_argument_spec(),
+        supports_check_mode=True,
+    )
+
+    try:
+        servers_info = OnlineServerInfo(module).all_detailed_servers()
+        module.exit_json(
+            online_server_info=servers_info
+        )
+    except OnlineException as exc:
+        module.fail_json(msg=exc.message)
+
+
+if __name__ == '__main__':
+    main()