summaryrefslogtreecommitdiff
path: root/deps/rabbitmq_federation_management/README.md
blob: 182da17c5a6acc06990eb41c5b33e3a6530159c8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
# RabbitMQ Federation Management Plugin

This plugin adds information on federation link status to the management
plugin.


## Installation

In recent releases, this [plugin](https://www.rabbitmq.com/plugins.html) ships with RabbitMQ.
[Enable](https://www.rabbitmq.com/plugins.html#basics) it with

``` shell
rabbitmq-plugins enable rabbitmq_management rabbitmq_federation_management
```

If you have a heterogenous cluster (where the nodes have different
plugins installed), this should be installed on the same nodes as the
management plugin.


## Use over HTTP API

The HTTP API endpoints allow for retrieval of federation links:

    # lists all links
    GET /api/federation-links
    # lists links in a vhost
    GET /api/federation-links/{vhost}


## Building From Source

To [build the plugin](https://www.rabbitmq.com/plugin-development.html), use

    make dist

and see under the `./plugins` directory.


## Copyright and License

(c) 2007-2020 VMware, Inc. or its affiliates.

See `LICENSE` for license information.