mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-24 19:31:26 -07:00
[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>
This commit is contained in:
parent
cea6eeef37
commit
a99f72fc36
43 changed files with 1290 additions and 1429 deletions
|
@ -8,12 +8,11 @@
|
|||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
DOCUMENTATION = r"""
|
||||
module: jenkins_job
|
||||
short_description: Manage jenkins jobs
|
||||
description:
|
||||
- Manage Jenkins jobs by using Jenkins REST API.
|
||||
- Manage Jenkins jobs by using Jenkins REST API.
|
||||
requirements:
|
||||
- "python-jenkins >= 0.4.12"
|
||||
author: "Sergio Millan Rodriguez (@sermilrod)"
|
||||
|
@ -28,7 +27,7 @@ options:
|
|||
config:
|
||||
type: str
|
||||
description:
|
||||
- config in XML format.
|
||||
- Config in XML format.
|
||||
- Required if job does not yet exist.
|
||||
- Mutually exclusive with O(enabled).
|
||||
- Considered if O(state=present).
|
||||
|
@ -71,20 +70,19 @@ options:
|
|||
user:
|
||||
type: str
|
||||
description:
|
||||
- User to authenticate with the Jenkins server.
|
||||
- User to authenticate with the Jenkins server.
|
||||
required: false
|
||||
validate_certs:
|
||||
type: bool
|
||||
default: true
|
||||
description:
|
||||
- If set to V(false), the SSL certificates will not be validated.
|
||||
This should only set to V(false) used on personally controlled sites
|
||||
using self-signed certificates as it avoids verifying the source site.
|
||||
- If set to V(false), the SSL certificates will not be validated. This should only set to V(false) used on personally
|
||||
controlled sites using self-signed certificates as it avoids verifying the source site.
|
||||
- The C(python-jenkins) library only handles this by using the environment variable E(PYTHONHTTPSVERIFY).
|
||||
version_added: 2.3.0
|
||||
'''
|
||||
"""
|
||||
|
||||
EXAMPLES = '''
|
||||
EXAMPLES = r"""
|
||||
- name: Create a jenkins job using basic authentication
|
||||
community.general.jenkins_job:
|
||||
config: "{{ lookup('file', 'templates/test.xml') }}"
|
||||
|
@ -132,10 +130,9 @@ EXAMPLES = '''
|
|||
enabled: false
|
||||
url: http://localhost:8080
|
||||
user: admin
|
||||
'''
|
||||
"""
|
||||
|
||||
RETURN = '''
|
||||
---
|
||||
RETURN = r"""
|
||||
name:
|
||||
description: Name of the jenkins job.
|
||||
returned: success
|
||||
|
@ -161,7 +158,7 @@ url:
|
|||
returned: success
|
||||
type: str
|
||||
sample: https://jenkins.mydomain.com
|
||||
'''
|
||||
"""
|
||||
|
||||
import os
|
||||
import traceback
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue