[PR #9373/d96e5604 backport][stable-10] [onev ... ovh]*.py: normalize docs (#9381)

[onev ... ovh]*.py: normalize docs (#9373)

* [onev ... ovh]*.py: normalize docs

* Apply suggestions from code review

Co-authored-by: Felix Fontein <felix@fontein.de>

---------

Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit d96e56048f)

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
patchback[bot] 2024-12-25 22:56:20 +01:00 committed by GitHub
parent 60ba39da58
commit e38f9e5cfc
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
25 changed files with 956 additions and 1021 deletions

View file

@ -9,88 +9,79 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = '''
---
DOCUMENTATION = r"""
module: ovh_ip_failover
short_description: Manage OVH IP failover address
description:
- Manage OVH (French European hosting provider) IP Failover Address. For now, this module can only be used to move
an ip failover (or failover block) between services
- Manage OVH (French European hosting provider) IP Failover Address. For now, this module can only be used to move an IP failover (or failover
block) between services.
author: "Pascal HERAUD (@pascalheraud)"
notes:
- Uses the python OVH Api U(https://github.com/ovh/python-ovh).
You have to create an application (a key and secret) with a consumer
key as described into U(https://docs.ovh.com/gb/en/customer/first-steps-with-ovh-api/)
- Uses the python OVH API U(https://github.com/ovh/python-ovh). You have to create an application (a key and secret) with a consumer key as
described into U(https://docs.ovh.com/gb/en/customer/first-steps-with-ovh-api/).
requirements:
- ovh >= 0.4.8
- ovh >= 0.4.8
extends_documentation_fragment:
- community.general.attributes
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
check_mode:
support: full
diff_mode:
support: none
options:
name:
required: true
description:
- The IP address to manage (can be a single IP like 1.1.1.1
or a block like 1.1.1.1/28 )
type: str
service:
required: true
description:
- The name of the OVH service this IP address should be routed
type: str
endpoint:
required: true
description:
- The endpoint to use ( for instance ovh-eu)
type: str
wait_completion:
required: false
default: true
type: bool
description:
- If true, the module will wait for the IP address to be moved.
If false, exit without waiting. The taskId will be returned
in module output
wait_task_completion:
required: false
default: 0
description:
- If not 0, the module will wait for this task id to be
completed. Use wait_task_completion if you want to wait for
completion of a previously executed task with
wait_completion=false. You can execute this module repeatedly on
a list of failover IPs using wait_completion=false (see examples)
type: int
application_key:
required: true
description:
- The applicationKey to use
type: str
application_secret:
required: true
description:
- The application secret to use
type: str
consumer_key:
required: true
description:
- The consumer key to use
type: str
timeout:
required: false
default: 120
description:
- The timeout in seconds used to wait for a task to be
completed. Default is 120 seconds.
type: int
name:
required: true
description:
- The IP address to manage (can be a single IP like V(1.1.1.1) or a block like V(1.1.1.1/28)).
type: str
service:
required: true
description:
- The name of the OVH service this IP address should be routed.
type: str
endpoint:
required: true
description:
- The endpoint to use (for instance V(ovh-eu)).
type: str
wait_completion:
required: false
default: true
type: bool
description:
- If true, the module will wait for the IP address to be moved. If false, exit without waiting. The taskId will be returned in module output.
wait_task_completion:
required: false
default: 0
description:
- If not 0, the module will wait for this task id to be completed. Use O(wait_task_completion) if you want to wait for completion of a previously
executed task with O(wait_completion=false). You can execute this module repeatedly on a list of failover IPs using O(wait_completion=false)
(see examples).
type: int
application_key:
required: true
description:
- The applicationKey to use.
type: str
application_secret:
required: true
description:
- The application secret to use.
type: str
consumer_key:
required: true
description:
- The consumer key to use.
type: str
timeout:
required: false
default: 120
description:
- The timeout in seconds used to wait for a task to be completed. Default is 120 seconds.
type: int
"""
'''
EXAMPLES = '''
EXAMPLES = r"""
# Route an IP address 1.1.1.1 to the service ns666.ovh.net
- community.general.ovh_ip_failover:
name: 1.1.1.1
@ -116,10 +107,10 @@ EXAMPLES = '''
application_key: yourkey
application_secret: yoursecret
consumer_key: yourconsumerkey
'''
"""
RETURN = '''
'''
RETURN = r"""
"""
import time