a-c-m
/
community.general
mirror of https://github.com/ansible-collections/community.general.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

rabbitmq_binding: Update documentation (#40062) 

This fix updates rabbitmq_binding documentation

* change 'exchange' to 'binding'
* Some minor doc fixes

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
pull/4420/head
Abhijeet Kasurde 2018-05-15 13:22:55 +05:30 committed by ansibot
parent 453358af3b
commit 553cf4cdfc
1 changed files with 47 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
lib/ansible/modules/messaging/rabbitmq_binding.py
View File

@ -1,16 +1,18 @@
#!/usr/bin/python #!/usr/bin/python
# -*- coding: utf-8 -*- # -*- coding: utf-8 -*-
# (c) 2015, Manuel Sousa <manuel.sousa@gmail.com> # Copyright (c) 2015, Manuel Sousa <manuel.sousa@gmail.com>
#
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
from __future__ import absolute_import, division, print_function from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
ANSIBLE_METADATA = {'metadata_version': '1.1', ANSIBLE_METADATA = {
'metadata_version': '1.1',
'status': ['preview'], 'status': ['preview'],
'supported_by': 'community'} 'supported_by': 'community'
}
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
@ -20,68 +22,58 @@ version_added: "2.0"
short_description: This module manages rabbitMQ bindings short_description: This module manages rabbitMQ bindings
description: description:
- This module uses rabbitMQ Rest API to create/delete bindings - This module uses rabbitMQ REST APIs to create / delete bindings.
requirements: [ "requests >= 1.0.0" ] requirements: [ "requests >= 1.0.0" ]
options: options:
state: state:
description: description:
- Whether the exchange should be present or absent - Whether the bindings should be present or absent.
- Only present implemented atm - Only present implemented at the momemt.
choices: [ "present", "absent" ] choices: [ "present", "absent" ]
required: false
default: present default: present
name: name:
description: description:
- source exchange to create binding on - source exchange to create binding on.
required: true required: true
aliases: [ "src", "source" ] aliases: [ "src", "source" ]
login_user: login_user:
description: description:
- rabbitMQ user for connection - rabbitMQ user for the connection.
required: false
default: guest default: guest
login_password: login_password:
description: description:
- rabbitMQ password for connection - rabbitMQ password for the connection.
required: false
default: false default: false
login_host: login_host:
description: description:
- rabbitMQ host for connection - rabbitMQ host for the connection.
required: false
default: localhost default: localhost
login_port: login_port:
description: description:
- rabbitMQ management api port - rabbitMQ management API port.
required: false
default: 15672 default: 15672
vhost: vhost:
description: description:
- rabbitMQ virtual host - rabbitMQ virtual host.
- default vhost is /
required: false
default: "/" default: "/"
destination: destination:
description: description:
- destination exchange or queue for the binding - destination exchange or queue for the binding.
required: true required: true
aliases: [ "dst", "dest" ] aliases: [ "dst", "dest" ]
destination_type: destination_type:
description: description:
- Either queue or exchange - Either queue or exchange.
required: true required: true
choices: [ "queue", "exchange" ] choices: [ "queue", "exchange" ]
aliases: [ "type", "dest_type" ] aliases: [ "type", "dest_type" ]
routing_key: routing_key:
description: description:
- routing key for the binding - routing key for the binding.
- default is #
required: false
default: "#" default: "#"
arguments: arguments:
description: description:
- extra arguments for exchange. If defined this argument is a key/value dictionary - extra arguments for exchange. If defined this argument is a key/value dictionary.
required: false
default: {} default: {}
''' '''