mirror of
https://github.com/ansible-collections/hetzner.hcloud
synced 2024-09-20 06:22:11 +00:00
4bb02b9cd2
##### SUMMARY Since we only support python >=3.8, the `to_native` python2/3 compatibility function is not needed anymore. We only keep it for printing a traceback free exception message. Where a type conversion is needed, we use the built-in `str()` function.
205 lines
6.7 KiB
Python
205 lines
6.7 KiB
Python
#!/usr/bin/python
|
|
|
|
# Copyright: (c) 2022, Patrice Le Guyader
|
|
# heavily inspired by the work of @LKaemmerling
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
|
|
from __future__ import annotations
|
|
|
|
DOCUMENTATION = """
|
|
---
|
|
module: iso_info
|
|
|
|
short_description: Gather infos about the Hetzner Cloud ISO list.
|
|
|
|
description:
|
|
- Gather infos about the Hetzner Cloud ISO list.
|
|
|
|
author:
|
|
- Patrice Le Guyader (@patlegu)
|
|
- Lukas Kaemmerling (@LKaemmerling)
|
|
|
|
options:
|
|
id:
|
|
description:
|
|
- The ID of the ISO image you want to get.
|
|
- The module will fail if the provided ID is invalid.
|
|
type: int
|
|
name:
|
|
description:
|
|
- The name of the ISO you want to get.
|
|
type: str
|
|
architecture:
|
|
description:
|
|
- Filter ISOs with compatible architecture.
|
|
type: str
|
|
choices: [x86, arm]
|
|
include_architecture_wildcard:
|
|
description:
|
|
- Include ISOs with wildcard architecture (architecture is null).
|
|
- Works only if architecture filter is specified.
|
|
type: bool
|
|
|
|
extends_documentation_fragment:
|
|
- hetzner.hcloud.hcloud
|
|
"""
|
|
|
|
EXAMPLES = """
|
|
- name: Gather hcloud ISO type infos
|
|
hetzner.hcloud.iso_info:
|
|
register: output
|
|
|
|
- name: Print the gathered infos
|
|
debug:
|
|
var: output.hcloud_iso_info
|
|
"""
|
|
|
|
RETURN = """
|
|
hcloud_iso_info:
|
|
description: The ISO type infos as list
|
|
returned: always
|
|
type: complex
|
|
contains:
|
|
id:
|
|
description: ID of the ISO
|
|
returned: always
|
|
type: int
|
|
sample: 22110
|
|
name:
|
|
description: Unique identifier of the ISO. Only set for public ISOs
|
|
returned: always
|
|
type: str
|
|
sample: debian-12.0.0-amd64-netinst.iso
|
|
description:
|
|
description: Description of the ISO
|
|
returned: always
|
|
type: str
|
|
sample: Debian 12.0 (amd64/netinstall)
|
|
architecture:
|
|
description: >
|
|
Type of cpu architecture this ISO is compatible with.
|
|
None indicates no restriction on the architecture (wildcard).
|
|
returned: when supported
|
|
type: str
|
|
sample: x86
|
|
type:
|
|
description: Type of the ISO, can be one of `public`, `private`.
|
|
returned: always
|
|
type: str
|
|
sample: public
|
|
deprecated:
|
|
description: >
|
|
ISO 8601 timestamp of deprecation, None if ISO is still available.
|
|
After the deprecation time it will no longer be possible to attach the
|
|
ISO to servers. This field is deprecated. Use `deprecation` instead.
|
|
returned: always
|
|
type: str
|
|
sample: "2024-12-01T00:00:00+00:00"
|
|
deprecation:
|
|
description: >
|
|
Describes if, when & how the resources was deprecated. If this field is
|
|
set to None the resource is not deprecated. If it has a value, it is
|
|
considered deprecated.
|
|
returned: if the resource is deprecated
|
|
type: dict
|
|
contains:
|
|
announced:
|
|
description: Date of when the deprecation was announced.
|
|
returned: always
|
|
type: str
|
|
sample: "2021-11-01T00:00:00+00:00"
|
|
unavailable_after:
|
|
description: >
|
|
After the time in this field, the resource will not be available
|
|
from the general listing endpoint of the resource type, and it can
|
|
not be used in new resources. For example, if this is an image,
|
|
you can not create new servers with this image after the mentioned
|
|
date.
|
|
returned: always
|
|
type: str
|
|
sample: "2021-12-01T00:00:00+00:00"
|
|
"""
|
|
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
|
|
from ..module_utils.hcloud import AnsibleHCloud
|
|
from ..module_utils.vendor.hcloud import HCloudException
|
|
from ..module_utils.vendor.hcloud.isos import BoundIso
|
|
|
|
|
|
class AnsibleHCloudIsoInfo(AnsibleHCloud):
|
|
represent = "hcloud_iso_info"
|
|
|
|
hcloud_iso_info: list[BoundIso] | None = None
|
|
|
|
def _prepare_result(self):
|
|
tmp = []
|
|
|
|
for iso_info in self.hcloud_iso_info:
|
|
if iso_info is None:
|
|
continue
|
|
|
|
tmp.append(
|
|
{
|
|
"id": str(iso_info.id),
|
|
"name": iso_info.name,
|
|
"description": iso_info.description,
|
|
"type": iso_info.type,
|
|
"architecture": iso_info.architecture,
|
|
"deprecated": (
|
|
iso_info.deprecation.unavailable_after.isoformat() if iso_info.deprecation is not None else None
|
|
),
|
|
"deprecation": (
|
|
{
|
|
"announced": iso_info.deprecation.announced.isoformat(),
|
|
"unavailable_after": iso_info.deprecation.unavailable_after.isoformat(),
|
|
}
|
|
if iso_info.deprecation is not None
|
|
else None
|
|
),
|
|
}
|
|
)
|
|
|
|
return tmp
|
|
|
|
def get_iso_infos(self):
|
|
try:
|
|
if self.module.params.get("id") is not None:
|
|
self.hcloud_iso_info = [self.client.isos.get_by_id(self.module.params.get("id"))]
|
|
elif self.module.params.get("name") is not None:
|
|
self.hcloud_iso_info = [self.client.isos.get_by_name(self.module.params.get("name"))]
|
|
else:
|
|
self.hcloud_iso_info = self.client.isos.get_all(
|
|
architecture=self.module.params.get("architecture"),
|
|
include_wildcard_architecture=self.module.params.get("include_wildcard_architecture"),
|
|
)
|
|
|
|
except HCloudException as exception:
|
|
self.fail_json_hcloud(exception)
|
|
|
|
@classmethod
|
|
def define_module(cls):
|
|
return AnsibleModule(
|
|
argument_spec=dict(
|
|
id={"type": "int"},
|
|
name={"type": "str"},
|
|
architecture={"type": "str", "choices": ["x86", "arm"]},
|
|
include_architecture_wildcard={"type": "bool"},
|
|
**super().base_module_arguments(),
|
|
),
|
|
supports_check_mode=True,
|
|
)
|
|
|
|
|
|
def main():
|
|
module = AnsibleHCloudIsoInfo.define_module()
|
|
hcloud = AnsibleHCloudIsoInfo(module)
|
|
hcloud.get_iso_infos()
|
|
result = hcloud.get_result()
|
|
ansible_info = {"hcloud_iso_info": result["hcloud_iso_info"]}
|
|
module.exit_json(**ansible_info)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main()
|