LavinMQ Command Line Interface
lavinmqctl is the command-line tool for managing a running LavinMQ server. It communicates with the server via the HTTP management API.
Connection
By default, lavinmqctl connects to http://127.0.0.1:15672. Override with:
lavinmqctl --uri http://host:port ...
Or set the LAVINMQCTL_HOST environment variable.
When no connection flag is given, lavinmqctl talks to the server over its local control socket (default /tmp/lavinmqctl.sock). If the server was started with a custom --control-unix-path, point lavinmqctl at it with --control-unix-path or the LAVINMQCTL_CONTROL_UNIX_PATH environment variable.
Authentication uses --user and --password flags (default: guest/guest).
Commands
User Management
| Command | Description |
|---|---|
add_user <username> <password> |
Create a new user |
delete_user <username> |
Delete a user |
change_password <username> <password> |
Change user password |
list_users |
List all users and their tags |
set_user_tags <username> <tags> |
Set user tags |
set_permissions <user> <configure> <write> <read> |
Set vhost permissions |
hash_password <password> |
Hash a password |
Vhost Management
| Command | Description |
|---|---|
list_vhosts |
List all vhosts |
add_vhost <vhost> |
Create a vhost |
delete_vhost <vhost> |
Delete a vhost |
set_vhost_limits <json> |
Set vhost limits (max-connections, max-queues) |
Queue Management
| Command | Description |
|---|---|
list_queues |
List all queues |
create_queue <name> |
Create a queue (supports --durable, --auto-delete, --expires, --max-length, --message-ttl, --delivery-limit, --reject-on-overflow, --dead-letter-exchange, --dead-letter-routing-key, --stream-queue) |
delete_queue <queue> |
Delete a queue |
purge_queue <queue> |
Purge all messages from a queue |
pause_queue <queue> |
Pause all consumers on a queue |
resume_queue <queue> |
Resume consumers on a queue |
restart_queue <queue> |
Restart a closed queue |
Exchange Management
| Command | Description |
|---|---|
list_exchanges |
List all exchanges |
create_exchange <type> <name> |
Create an exchange (supports --auto-delete, --durable, --internal, --delayed, --alternate-exchange, --persist-messages, --persist-ms) |
delete_exchange <name> |
Delete an exchange |
Connection Management
| Command | Description |
|---|---|
list_connections |
List all AMQP connections |
close_connection <pid> <reason> |
Close a specific connection |
close_all_connections <reason> |
Close all connections |
Policy Management
| Command | Description |
|---|---|
list_policies |
List all policies |
set_policy <name> <pattern> <definition> |
Create/update a policy (supports --priority, --apply-to) |
clear_policy <name> |
Delete a policy |
Shovel and Federation
| Command | Description |
|---|---|
list_shovels |
List all shovels |
add_shovel <name> |
Create a shovel (supports --src-uri, --dest-uri, --src-queue, --src-exchange, --src-exchange-key, --dest-exchange, --dest-exchange-key, --dest-queue, --src-prefetch-count, --ack-mode, --src-delete-after, --reconnect-delay) |
delete_shovel <name> |
Delete a shovel |
list_federations |
List federation upstreams |
add_federation <name> |
Create a federation upstream (supports --uri, --expires, --message-ttl, --max-hops, --prefetch-count, --reconnect-delay, --ack-mode, --queue, --exchange) |
delete_federation <name> |
Delete a federation upstream |
Definitions
| Command | Description |
|---|---|
export_definitions |
Export all definitions as JSON |
import_definitions <file> |
Import definitions from a JSON file |
Server Control
| Command | Description |
|---|---|
status |
Display server status |
cluster_status |
Display cluster status |
stop_app |
Stop the AMQP broker |
start_app |
Start the AMQP broker |
definitions |
Generate definitions JSON from a data directory (offline, does not use API) |
Global Options
| Flag | Description |
|---|---|
-U, --uri=URI |
Management API URI |
--hostname=HOST |
Management API hostname |
-P, --port=PORT |
Management API port |
--scheme=SCHEME |
URI scheme (http/https) |
--control-unix-path=PATH |
Control socket to use when not connecting via --uri/--hostname (default /tmp/lavinmqctl.sock, env LAVINMQCTL_CONTROL_UNIX_PATH) |
-p, --vhost=VHOST |
Target vhost (default: /) |
--user=USER |
API username |
--password=PASS |
API password |
-s, --silent |
Suppress informational messages and table formatting |
-q, --quiet |
Suppress output |
-f, --format=FORMAT |
Output format (text or json) |
--host=URL |
Deprecated, use --uri or --hostname |
-h, --help |
Show help and exit |
-v, --version |
Print version and exit |
--build-info |
Print build information and exit |
Ready to take the next steps?
Managed LavinMQ instance via CloudAMQP
LavinMQ has been built with performance and ease of use in mind - we've benchmarked a throughput of about 1,000,000 messages/sec . You can try LavinMQ without any installation hassle by creating a free instance on CloudAMQP. Signing up is a breeze.
Get started with CloudAMQP ->
Help and feedback
We welcome your feedback and are eager to address any questions you may have about this piece or using LavinMQ. Join our Slack channel to connect with us directly. You can also find LavinMQ on GitHub.