mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
1da5f7dc54
multiple scaleway modules: fixed markups in doc (#5766)
* multiple scaleway modules: fixed markups in doc
* Update plugins/modules/scaleway_ip.py
Co-authored-by: Felix Fontein <felix@fontein.de>
* Update plugins/modules/scaleway_volume.py
Co-authored-by: Felix Fontein <felix@fontein.de>
* Update plugins/modules/scaleway_private_network.py
Co-authored-by: Felix Fontein <felix@fontein.de>
* Update plugins/modules/scaleway_security_group.py
Co-authored-by: Felix Fontein <felix@fontein.de>
* Update plugins/modules/scaleway_security_group_rule.py
Co-authored-by: Felix Fontein <felix@fontein.de>
* Update plugins/modules/scaleway_sshkey.py
Co-authored-by: Felix Fontein <felix@fontein.de>
* further docs adjustments
Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit 317f79ff1f)
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
130 lines
3.8 KiB
Python
130 lines
3.8 KiB
Python
#!/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_image_info
|
|
short_description: Gather information about the Scaleway images available
|
|
description:
|
|
- Gather information about the Scaleway images available.
|
|
author:
|
|
- "Yanis Guenane (@Spredzy)"
|
|
- "Remy Leone (@remyleone)"
|
|
extends_documentation_fragment:
|
|
- community.general.scaleway
|
|
- community.general.attributes
|
|
- community.general.attributes.info_module
|
|
|
|
options:
|
|
region:
|
|
type: str
|
|
description:
|
|
- Scaleway compute zone.
|
|
required: true
|
|
choices:
|
|
- ams1
|
|
- EMEA-NL-EVS
|
|
- par1
|
|
- EMEA-FR-PAR1
|
|
- par2
|
|
- EMEA-FR-PAR2
|
|
- waw1
|
|
- EMEA-PL-WAW1
|
|
'''
|
|
|
|
EXAMPLES = r'''
|
|
- name: Gather Scaleway images information
|
|
community.general.scaleway_image_info:
|
|
region: par1
|
|
register: result
|
|
|
|
- ansible.builtin.debug:
|
|
msg: "{{ result.scaleway_image_info }}"
|
|
'''
|
|
|
|
RETURN = r'''
|
|
---
|
|
scaleway_image_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_image_info": [
|
|
{
|
|
"arch": "x86_64",
|
|
"creation_date": "2018-07-17T16:18:49.276456+00:00",
|
|
"default_bootscript": {
|
|
"architecture": "x86_64",
|
|
"bootcmdargs": "LINUX_COMMON scaleway boot=local nbd.max_part=16",
|
|
"default": false,
|
|
"dtb": "",
|
|
"id": "15fbd2f7-a0f9-412b-8502-6a44da8d98b8",
|
|
"initrd": "http://169.254.42.24/initrd/initrd-Linux-x86_64-v3.14.5.gz",
|
|
"kernel": "http://169.254.42.24/kernel/x86_64-mainline-lts-4.9-4.9.93-rev1/vmlinuz-4.9.93",
|
|
"organization": "11111111-1111-4111-8111-111111111111",
|
|
"public": true,
|
|
"title": "x86_64 mainline 4.9.93 rev1"
|
|
},
|
|
"extra_volumes": [],
|
|
"from_server": null,
|
|
"id": "00ae4a88-3252-4eda-9feb-5f6b56bf5ef0",
|
|
"modification_date": "2018-07-17T16:42:06.319315+00:00",
|
|
"name": "Debian Stretch",
|
|
"organization": "51b656e3-4865-41e8-adbc-0c45bdd780db",
|
|
"public": true,
|
|
"root_volume": {
|
|
"id": "da32dfbb-c5ff-476d-ae2d-c297dd09b7dd",
|
|
"name": "snapshot-2a7229dc-d431-4dc5-b66e-95db08b773af-2018-07-17_16:18",
|
|
"size": 25000000000,
|
|
"volume_type": "l_ssd"
|
|
},
|
|
"state": "available"
|
|
}
|
|
]
|
|
'''
|
|
|
|
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 ScalewayImageInfo(Scaleway):
|
|
|
|
def __init__(self, module):
|
|
super(ScalewayImageInfo, self).__init__(module)
|
|
self.name = 'images'
|
|
|
|
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_image_info=ScalewayImageInfo(module).get_resources()
|
|
)
|
|
except ScalewayException as exc:
|
|
module.fail_json(msg=exc.message)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|