community.general/lib/ansible/utils/module_docs_fragments/rabbitmq.py
Jorge Rodriguez (A.K.A. Tiriel) e7ddff1928 Rabbitmq: Enable communication to management API over HTTPS (#18437)
* Enable communication to management API over HTTPS.
* Specify version added tags to new parameters
* Set proper parameter type.
* Corrected version_added numbers.
* Extracted commons to ansible utils.
* Fix PEP8 error
* Fix documentation extension syntax.

Fixes #22953
2018-10-10 09:55:08 +05:30

57 lines
1.5 KiB
Python

# Copyright: (c) 2016, Jorge Rodriguez <jorge.rodriguez@tiriel.eu>
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
class ModuleDocFragment(object):
# Parameters for RabbitMQ modules
DOCUMENTATION = '''
options:
login_user:
description:
- rabbitMQ user for connection.
required: false
default: guest
login_password:
description:
- rabbitMQ password for connection.
required: false
default: false
login_host:
description:
- rabbitMQ host for connection.
required: false
default: localhost
login_port:
description:
- rabbitMQ management API port.
required: false
default: 15672
login_protocol:
description:
- rabbitMQ management API protocol.
choices: [ http , https ]
required: false
default: http
version_added: "2.3"
cacert:
description:
- CA certificate to verify SSL connection to management API.
required: false
version_added: "2.3"
cert:
description:
- Client certificate to send on SSL connections to management API.
required: false
version_added: "2.3"
key:
description:
- Private key matching the client certificate.
required: false
version_added: "2.3"
vhost:
description:
- rabbitMQ virtual host.
required: false
default: "/"
'''