mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
4fde0617c8
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>
105 lines
2.9 KiB
Python
105 lines
2.9 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_organization_info
|
|
short_description: Gather information about the Scaleway organizations available
|
|
description:
|
|
- Gather information about the Scaleway organizations available.
|
|
author:
|
|
- "Yanis Guenane (@Spredzy)"
|
|
- "Remy Leone (@remyleone)"
|
|
options:
|
|
api_url:
|
|
description:
|
|
- Scaleway API URL.
|
|
default: 'https://account.scaleway.com'
|
|
aliases: ['base_url']
|
|
extends_documentation_fragment:
|
|
- community.general.scaleway
|
|
|
|
'''
|
|
|
|
EXAMPLES = r'''
|
|
- name: Gather Scaleway organizations information
|
|
community.general.scaleway_organization_info:
|
|
register: result
|
|
|
|
- ansible.builtin.debug:
|
|
msg: "{{ result.scaleway_organization_info }}"
|
|
'''
|
|
|
|
RETURN = r'''
|
|
---
|
|
scaleway_organization_info:
|
|
description: Response from Scaleway API.
|
|
returned: success
|
|
type: complex
|
|
sample:
|
|
"scaleway_organization_info": [
|
|
{
|
|
"address_city_name": "Paris",
|
|
"address_country_code": "FR",
|
|
"address_line1": "42 Rue de l'univers",
|
|
"address_line2": null,
|
|
"address_postal_code": "75042",
|
|
"address_subdivision_code": "FR-75",
|
|
"creation_date": "2018-08-06T13:43:28.508575+00:00",
|
|
"currency": "EUR",
|
|
"customer_class": "individual",
|
|
"id": "3f709602-5e6c-4619-b80c-e8432ferewtr",
|
|
"locale": "fr_FR",
|
|
"modification_date": "2018-08-06T14:56:41.401685+00:00",
|
|
"name": "James Bond",
|
|
"support_id": "694324",
|
|
"support_level": "basic",
|
|
"support_pin": "9324",
|
|
"users": [],
|
|
"vat_number": null,
|
|
"warnings": []
|
|
}
|
|
]
|
|
'''
|
|
|
|
from ansible.module_utils.basic import AnsibleModule, env_fallback
|
|
from ansible_collections.community.general.plugins.module_utils.scaleway import (
|
|
Scaleway, ScalewayException, scaleway_argument_spec
|
|
)
|
|
|
|
|
|
class ScalewayOrganizationInfo(Scaleway):
|
|
|
|
def __init__(self, module):
|
|
super(ScalewayOrganizationInfo, self).__init__(module)
|
|
self.name = 'organizations'
|
|
|
|
|
|
def main():
|
|
argument_spec = scaleway_argument_spec()
|
|
argument_spec.update(dict(
|
|
api_url=dict(fallback=(env_fallback, ['SCW_API_URL']), default='https://account.scaleway.com', aliases=['base_url']),
|
|
))
|
|
|
|
module = AnsibleModule(
|
|
argument_spec=argument_spec,
|
|
supports_check_mode=True,
|
|
)
|
|
|
|
try:
|
|
module.exit_json(
|
|
scaleway_organization_info=ScalewayOrganizationInfo(module).get_resources()
|
|
)
|
|
except ScalewayException as exc:
|
|
module.fail_json(msg=exc.message)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|