#!/usr/bin/python # Copyright: (c) 2019, Hetzner Cloud GmbH # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) DOCUMENTATION = """ --- module: hcloud_volume_info short_description: Gather infos about your Hetzner Cloud Volumes. description: - Gather infos about your Hetzner Cloud Volumes. author: - Lukas Kaemmerling (@LKaemmerling) options: id: description: - The ID of the Volume you want to get. type: int name: description: - The name of the Volume you want to get. type: str label_selector: description: - The label selector for the Volume you want to get. type: str extends_documentation_fragment: - hetzner.hcloud.hcloud """ EXAMPLES = """ - name: Gather hcloud Volume infos hcloud_volume_info: register: output - name: Print the gathered infos debug: var: output.hcloud_volume_info """ RETURN = """ hcloud_volume_info: description: The Volume infos as list returned: always type: complex contains: id: description: Numeric identifier of the Volume returned: always type: int sample: 1937415 name: description: Name of the Volume returned: always type: str sample: my-volume size: description: Size of the Volume returned: always type: str sample: 10 linux_device: description: Path to the device that contains the Volume. returned: always type: str sample: /dev/disk/by-id/scsi-0HC_Volume_12345 version_added: "0.1.0" location: description: Name of the location where the Volume resides in returned: always type: str sample: fsn1 server: description: Name of the server where the Volume is attached to returned: always type: str sample: my-server delete_protection: description: True if the Volume is protected for deletion returned: always type: bool version_added: "0.1.0" labels: description: User-defined labels (key-value pairs) returned: always type: dict """ from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.common.text.converters import to_native from ansible_collections.hetzner.hcloud.plugins.module_utils.hcloud import Hcloud class AnsibleHcloudVolumeInfo(Hcloud): def __init__(self, module): Hcloud.__init__(self, module, "hcloud_volume_info") self.hcloud_volume_info = None def _prepare_result(self): tmp = [] for volume in self.hcloud_volume_info: if volume is not None: server_name = None if volume.server is not None: server_name = to_native(volume.server.name) tmp.append( { "id": to_native(volume.id), "name": to_native(volume.name), "size": volume.size, "location": to_native(volume.location.name), "labels": volume.labels, "server": server_name, "linux_device": to_native(volume.linux_device), "delete_protection": volume.protection["delete"], } ) return tmp def get_volumes(self): try: if self.module.params.get("id") is not None: self.hcloud_volume_info = [self.client.volumes.get_by_id(self.module.params.get("id"))] elif self.module.params.get("name") is not None: self.hcloud_volume_info = [self.client.volumes.get_by_name(self.module.params.get("name"))] elif self.module.params.get("label_selector") is not None: self.hcloud_volume_info = self.client.volumes.get_all( label_selector=self.module.params.get("label_selector") ) else: self.hcloud_volume_info = self.client.volumes.get_all() except Exception as e: self.module.fail_json(msg=e.message) @staticmethod def define_module(): return AnsibleModule( argument_spec=dict( id={"type": "int"}, name={"type": "str"}, label_selector={"type": "str"}, **Hcloud.base_module_arguments() ), supports_check_mode=True, ) def main(): module = AnsibleHcloudVolumeInfo.define_module() is_old_facts = module._name == "hcloud_volume_facts" if is_old_facts: module.deprecate( "The 'hcloud_volume_facts' module has been renamed to 'hcloud_volume_info', " "and the renamed one no longer returns ansible_facts", version="2.0.0", collection_name="hetzner.hcloud", ) hcloud = AnsibleHcloudVolumeInfo(module) hcloud.get_volumes() result = hcloud.get_result() if is_old_facts: ansible_info = {"hcloud_volume_facts": result["hcloud_volume_info"]} module.exit_json(ansible_facts=ansible_info) else: ansible_info = {"hcloud_volume_info": result["hcloud_volume_info"]} module.exit_json(**ansible_info) if __name__ == "__main__": main()