ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-04-24 11:21:25 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

[PR #5766/317f79ff backport][stable-6] multiple scaleway modules: fixed markups in doc (#5827)

Browse source 
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>
This commit is contained in:
patchback[bot] 2023-01-12 21:56:31 +01:00 • committed by GitHub
parent 559c914e36
commit 1da5f7dc54
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
12 changed files with 55 additions and 60 deletions
Download patch file Download diff file Expand all files Collapse all files

27
plugins/modules/scaleway_volume.py
View file

@ -18,8 +18,7 @@ module: scaleway_volume
short_description: Scaleway volumes management module
author: Henryk Konsek (@hekonsek)
description:
- This module manages volumes on Scaleway account
U(https://developer.scaleway.com)
- "This module manages volumes on Scaleway account U(https://developer.scaleway.com)."
extends_documentation_fragment:
- community.general.scaleway
@ -28,7 +27,7 @@ options:
state:
type: str
description:
- Indicate desired state of the volume.
- Indicate desired state of the volume.
default: present
choices:
- present
@ -36,7 +35,7 @@ options:
region:
type: str
description:
- Scaleway region to use (for example par1).
- Scaleway region to use (for example par1).
required: true
choices:
- ams1
@ -50,25 +49,25 @@ options:
name:
type: str
description:
- Name used to identify the volume.
- Name used to identify the volume.
required: true
project:
type: str
description:
- Scaleway project ID to which volume belongs.
- Scaleway project ID to which volume belongs.
version_added: 4.3.0
organization:
type: str
description:
- ScaleWay organization ID to which volume belongs.
- ScaleWay organization ID to which volume belongs.
size:
type: int
description:
- Size of the volume in bytes.
- Size of the volume in bytes.
volume_type:
type: str
description:
- Type of the volume (for example 'l_ssd').
- Type of the volume (for example 'l_ssd').
'''
EXAMPLES = '''
@ -91,8 +90,8 @@ EXAMPLES = '''
RETURN = '''
data:
description: This is only present when C(state=present)
returned: when C(state=present)
description: This is only present when I(state=present).
returned: when I(state=present)
type: dict
sample: {
"volume": {
@ -100,9 +99,9 @@ data:
"id": "c675f420-cfeb-48ff-ba2a-9d2a4dbe3fcd",
"name": "volume-0-3",
"project": "000a115d-2852-4b0a-9ce8-47f1134ba95a",
"server": null,
"size": 10000000000,
"volume_type": "l_ssd"
"server": null,
"size": 10000000000,
"volume_type": "l_ssd"
}
}
'''