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

[PR #9392/a99f72fc backport][stable-10] [ip ... j]*.py: normalize docs (#9404)

Browse source 
[ip ... j]*.py: normalize docs (#9392)

* [ip ... j]*.py: normalize docs

* Update plugins/modules/ip_netns.py

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

---------

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

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
patchback[bot] 2024-12-26 14:01:34 +01:00 • committed by GitHub
parent 29e9afcbf4
commit 03f3b74934
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
43 changed files with 1290 additions and 1429 deletions
Download patch file Download diff file Expand all files Collapse all files

34
plugins/modules/jenkins_node.py
View file

@ -8,8 +8,7 @@
from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = '''
---
DOCUMENTATION = r"""
module: jenkins_node
short_description: Manage Jenkins nodes
version_added: 10.0.0
@ -25,8 +24,7 @@ attributes:
check_mode:
support: partial
details:
- Check mode is unable to show configuration changes for a node that is not yet
present.
- Check mode is unable to show configuration changes for a node that is not yet present.
diff_mode:
support: none
options:
@ -50,8 +48,8 @@ options:
type: str
state:
description:
- Specifies whether the Jenkins node should be V(present) (created), V(absent)
(deleted), V(enabled) (online) or V(disabled) (offline).
- Specifies whether the Jenkins node should be V(present) (created), V(absent) (deleted), V(enabled) (online) or V(disabled)
(offline).
default: present
choices: ['enabled', 'disabled', 'present', 'absent']
type: str
@ -66,18 +64,15 @@ options:
elements: str
offline_message:
description:
- Specifies the offline reason message to be set when configuring the Jenkins node
state.
- If O(offline_message) is given and requested O(state) is not V(disabled), an
error will be raised.
- Internally O(offline_message) is set via the V(toggleOffline) API, so updating
the message when the node is already offline (current state V(disabled)) is not
possible. In this case, a warning will be issued.
- Specifies the offline reason message to be set when configuring the Jenkins node state.
- If O(offline_message) is given and requested O(state) is not V(disabled), an error will be raised.
- Internally O(offline_message) is set using the V(toggleOffline) API, so updating the message when the node is already
offline (current state V(disabled)) is not possible. In this case, a warning will be issued.
type: str
version_added: 10.0.0
'''
"""
EXAMPLES = '''
EXAMPLES = r"""
- name: Create a Jenkins node using token authentication
community.general.jenkins_node:
url: http://localhost:8080
@ -105,12 +100,11 @@ EXAMPLES = '''
community.general.jenkins_node:
name: my-node
state: disabled
offline_message: >
offline_message: >-
This node is offline for some reason.
'''
"""
RETURN = '''
---
RETURN = r"""
url:
description: URL used to connect to the Jenkins server.
returned: success
@ -151,7 +145,7 @@ configured:
description: Whether or not the Jenkins node was configured by the task.
returned: success
type: bool
'''
"""
import sys
import traceback