mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-25 03:41:25 -07:00
6058cb736d
* Fixes #28016: rabbitmq_plugin for Windows * Disable documentation check for rabbitmq_plugin.ps1 * Renamed rabbitmq_plugin -> win_rabbitmq_plugin * Fixed the documentation after review * Fixed 'RETURN' section * Fixed docs for original module * Added dots to original module docs.
59 lines
1.4 KiB
Python
59 lines
1.4 KiB
Python
#!/usr/bin/python
|
|
# Copyright (c) 2017 Ansible Project
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
ANSIBLE_METADATA = {'metadata_version': '1.0',
|
|
'status': ['preview'],
|
|
'supported_by': 'community'}
|
|
|
|
|
|
DOCUMENTATION = r'''
|
|
---
|
|
module: win_rabbitmq_plugin
|
|
short_description: Manage RabbitMQ plugins
|
|
description:
|
|
- Manage RabbitMQ plugins.
|
|
version_added: "2.4"
|
|
author:
|
|
- Artem Zinenko (@ar7z1)
|
|
options:
|
|
names:
|
|
description:
|
|
- Comma-separated list of plugin names.
|
|
required: true
|
|
aliases: [name]
|
|
new_only:
|
|
description:
|
|
- Only enable missing plugins.
|
|
- Does not disable plugins that are not in the names list.
|
|
type: bool
|
|
default: "no"
|
|
state:
|
|
description:
|
|
- Specify if plugins are to be enabled or disabled.
|
|
default: enabled
|
|
choices: [enabled, disabled]
|
|
prefix:
|
|
description:
|
|
- Specify a custom install prefix to a Rabbit.
|
|
'''
|
|
|
|
EXAMPLES = r'''
|
|
- name: Enables the rabbitmq_management plugin
|
|
win_rabbitmq_plugin:
|
|
names: rabbitmq_management
|
|
state: enabled
|
|
'''
|
|
|
|
RETURN = r'''
|
|
enabled:
|
|
description: list of plugins enabled during task run
|
|
returned: always
|
|
type: list
|
|
sample: ["rabbitmq_management"]
|
|
disabled:
|
|
description: list of plugins disabled during task run
|
|
returned: always
|
|
type: list
|
|
sample: ["rabbitmq_management"]
|
|
'''
|