home | help
LAVINMQCTL(1)			  User Commands 		   LAVINMQCTL(1)

NAME
     lavinmqctl - control utility for lavinmq server

SYNOPSIS
     lavinmqctl [arguments] entity

DESCRIPTION
     Global options

     -p vhost, --vhost=vhost
	    Specify vhost

     -H URI, --host=URI
	    Specify URI (Deprecated, use --uri or --hostname)

     -U URI, --uri=URI
	    Specify URI

     --hostname=hostname
	    Specify hostname

     --user=user
	    Specify user

     --password=password
	    Specify password

     -P port, --port=port
	    Specify port (15672)

     --scheme=scheme
	    Specify scheme (http)

     --control-unix-path=PATH
	    Path to the LavinMQ control socket (default: /var/run/lavinmq/lavin-
	    mqctl.sock)

     -n node, --node=node
	    Specify node

     -q, --quiet
	    suppress informational messages

     -s, --silent
	    suppress informational messages and table formatting

     -f format, --format=format
	    Format output (text, json)

     -v, --version
	    Show version

     --build-info
	    Show build information

     -h, --help
	    Show this help

     User Management

     add_user
	    Creates a new user

     delete_user
	    Delete a user

     list_users
	    List user names and tags

     change_password
	    Change the user password

     set_user_tags
	    Sets user tags

     set_permissions
	    Set permissions for a user

     hash_password
	    Hash a password

     Virtual Hosts

     add_vhost
	    Creates a virtual host

     delete_vhost
	    Deletes a virtual host

     list_vhosts
	    Lists virtual hosts

     set_vhost_limits
	    Set VHost limits (max-connections, max-queues)

     Queues

     list_queues
	    Lists queues and their properties

     purge_queue
	    Purges a queue (removes all messages in it)

     pause_queue
	    Pause all consumers on a queue

     resume_queue
	    Resume all consumers on a queue

     restart_queue
	    Restarts a closed queue

     delete_queue
	    Delete queue

     create_queue
	    Create queue

     Exchanges

     list_exchanges
	    Lists exchanges

     delete_exchange
	    Delete exchange

     create_exchange
	    Create exchange

     Policies

     list_policies
	    Lists all policies in a virtual host

     clear_policy
	    Clears (removes) a policy

     set_policy
	    Sets or updates a policy

     Connections

     list_connections
	    Lists AMQP 0.9.1 connections for the node

     close_connection
	    Instructs the broker to close a connection by pid

     close_all_connections
	    Instructs  the  broker  to	close  all connections for the specified
	    vhost or entire node

     Definitions

     export_definitions
	    Exports definitions in JSON

     import_definitions
	    Import definitions in JSON

     definitions
	    Generate definitions json from a data directory

     Shovels

     list_shovels
	    Lists shovels

     delete_shovel
	    Delete a shovel

     add_shovel
	    Create a shovel

     Federation

     list_federations
	    Lists federation upstreams

     delete_federation
	    Delete a federation upstream

     add_federation
	    Create a federation upstream

     Server

     stop_app
	    Stop the AMQP broker

     start_app
	    Starts the AMQP broker

     gc_collect
	    Trigger a garbage collection cycle and print GC stats

     status
	    Display server status

     cluster_status
	    Display cluster status

lavinmqctl 2.9.1		   August 2026			   LAVINMQCTL(1)

home | help