summaryrefslogtreecommitdiff
path: root/lib/ansible/utils/module_docs_fragments
diff options
context:
space:
mode:
authorJorge Rodriguez (A.K.A. Tiriel) <jorge.rodriguez@tiriel.eu>2018-10-10 06:25:08 +0200
committerAbhijeet Kasurde <akasurde@redhat.com>2018-10-10 09:55:08 +0530
commite7ddff19281937c97b90ced90f595e6cbbedcd78 (patch)
treea7188eccac05bf8e302afad612e35acd6a22456c /lib/ansible/utils/module_docs_fragments
parent5e67981dd2d8c909841088e00bb2fd95be2324d0 (diff)
downloadansible-e7ddff19281937c97b90ced90f595e6cbbedcd78.tar.gz
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
Diffstat (limited to 'lib/ansible/utils/module_docs_fragments')
-rw-r--r--lib/ansible/utils/module_docs_fragments/rabbitmq.py57
1 files changed, 57 insertions, 0 deletions
diff --git a/lib/ansible/utils/module_docs_fragments/rabbitmq.py b/lib/ansible/utils/module_docs_fragments/rabbitmq.py
new file mode 100644
index 0000000000..87c52346d6
--- /dev/null
+++ b/lib/ansible/utils/module_docs_fragments/rabbitmq.py
@@ -0,0 +1,57 @@
+# 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: "/"
+'''