On this page
rabbitmq_plugin - Manage RabbitMQ plugins
Synopsis
- Manage RabbitMQ plugins.
 
Parameters
| Parameter | Choices/Defaults | Comments | 
|---|---|---|
| names  
        required
         | 
      
        
        Comma-separated list of plugin names.
        
       aliases: name  | 
     |
| new_only  
        bool
         | 
      
       
  | 
      
        
        Only enable missing plugins.
        
       
        Does not disable plugins that are not in the names list.
         | 
     
| prefix  
        (added in 1.3)
         | 
      
        
        Specify a custom install prefix to a Rabbit.
         | 
     |
| state | 
       
  | 
      
        
        Specify if plugins are to be enabled or disabled.
         | 
     
Examples
- name: Enables the rabbitmq_management plugin
  rabbitmq_plugin:
    names: rabbitmq_management
    state: enabled
  Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | 
|---|---|---|
| disabled  
        list
         | 
      always | 
        
        list of plugins disabled during task run
         Sample:
        
       
        ['rabbitmq_management']
         | 
     
| enabled  
        list
         | 
      always | 
        
        list of plugins enabled during task run
         Sample:
        
       
        ['rabbitmq_management']
         | 
     
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Maintenance
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Author
- Chris Hoffman (@chrishoffman)
 
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
 https://docs.ansible.com/ansible/2.6/modules/rabbitmq_plugin_module.html