#!/usr/bin/python # -*- coding: utf-8 -*- # # Copyright (c) 2018, Yanis Guenane <yanis+ansible@guenane.org> # 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: scaleway_snapshot_info short_description: Gather information about the Scaleway snapshots available. description: - Gather information about the Scaleway snapshot available. author: - "Yanis Guenane (@Spredzy)" - "Remy Leone (@remyleone)" extends_documentation_fragment: - community.general.scaleway options: region: type: str description: - Scaleway region to use (for example C(par1)). required: true choices: - ams1 - EMEA-NL-EVS - par1 - EMEA-FR-PAR1 - par2 - EMEA-FR-PAR2 - waw1 - EMEA-PL-WAW1 ''' EXAMPLES = r''' - name: Gather Scaleway snapshots information community.general.scaleway_snapshot_info: region: par1 register: result - ansible.builtin.debug: msg: "{{ result.scaleway_snapshot_info }}" ''' RETURN = r''' --- scaleway_snapshot_info: description: - Response from Scaleway API. - "For more details please refer to: U(https://developers.scaleway.com/en/products/instance/api/)." returned: success type: list elements: dict sample: "scaleway_snapshot_info": [ { "base_volume": { "id": "68386fae-4f55-4fbf-aabb-953036a85872", "name": "snapshot-87fc282d-f252-4262-adad-86979d9074cf-2018-04-26_12:42" }, "creation_date": "2018-08-14T22:34:35.299461+00:00", "id": "b61b4b03-a2e9-4da5-b5ea-e462ac0662d2", "modification_date": "2018-08-14T22:34:54.520560+00:00", "name": "snapshot-87fc282d-f252-4262-adad-86979d9074cf-2018-04-26_12:42 snapshot", "organization": "3f709602-5e6c-4619-b80c-e841c89734af", "size": 25000000000, "state": "available", "volume_type": "l_ssd" } ] ''' from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils.scaleway import ( Scaleway, ScalewayException, scaleway_argument_spec, SCALEWAY_LOCATION ) class ScalewaySnapshotInfo(Scaleway): def __init__(self, module): super(ScalewaySnapshotInfo, self).__init__(module) self.name = 'snapshots' region = module.params["region"] self.module.params['api_url'] = SCALEWAY_LOCATION[region]["api_endpoint"] def main(): argument_spec = scaleway_argument_spec() argument_spec.update(dict( region=dict(required=True, choices=list(SCALEWAY_LOCATION.keys())), )) module = AnsibleModule( argument_spec=argument_spec, supports_check_mode=True, ) try: module.exit_json( scaleway_snapshot_info=ScalewaySnapshotInfo(module).get_resources() ) except ScalewayException as exc: module.fail_json(msg=exc.message) if __name__ == '__main__': main()