Fixup the rabbitmq YAML documentation so we can generate docs for it.

This commit is contained in:
Michael DeHaan 2013-03-01 19:46:00 -05:00
parent 08161d1e4d
commit bbcd91b520

View file

@ -24,7 +24,7 @@ module: rabbitmq_parameter
short_description: Adds or removes parameters to RabbitMQ short_description: Adds or removes parameters to RabbitMQ
description: description:
- Manage dynamic, cluster-wide parameters for RabbitMQ - Manage dynamic, cluster-wide parameters for RabbitMQ
version_added: 1.1 version_added: '1.1'
author: Chris Hoffman author: Chris Hoffman
options: options:
component: component:
@ -52,12 +52,14 @@ options:
- Specify if user is to be added or removed - Specify if user is to be added or removed
required: false required: false
default: present default: present
choices: [present, absent] choices: [ 'present', 'absent']
examples:
- code: rabbitmq_parameter: component=federation name=local-username value='"guest"' state=present
description: Add the federation parameter local_username to value of guest
''' '''
EXAMPLES = """
# Set the federation parameter 'local_username' to a value of 'guest' (in quotes)
rabbitmq_parameter: component=federation name=local-username value='"guest"' state=present
"""
class RabbitMqParameter(object): class RabbitMqParameter(object):
def __init__(self, module, component, name, value, vhost): def __init__(self, module, component, name, value, vhost):
self.module = module self.module = module