Virtual hosts

Managing RabbitMQ virtual hosts, including their permissions, limits, and state.

all() -> list[dict] async

List all virtual hosts in the cluster.

channels(vhost: str) -> list[dict] async

List all open channels within a specific virtual host.

connections(vhost: str) -> list[dict] async

List all active connections to a specific virtual host.

delete(vhost: str) -> dict async

Delete a specific virtual host.

delete_limit(vhost: str, limit: VHostLimitName) -> dict async

Remove a specific resource limit from a virtual host.

detail(vhost: str) -> dict async

Get details of a specific virtual host.

limits() -> list[dict] async

List resource limits for all virtual hosts.

permissions(vhost: str) -> list[dict] async

List all user permissions for a given virtual host.

set(vhost: str, value: dict) -> dict async

Create a virtual host or update its metadata.

Parameters:

Name	Type	Description	Default
value	dict	Dict with optional keys like 'description', 'tags', or 'tracing'.	required

set_limit(vhost: str, limit: VHostLimitName, value: int) -> dict async

Set a resource limit for a virtual host (e.g., max-queues, max-connections).

start(vhost: str, node: str) -> None async

Start a virtual host on a specific cluster node.

topic_permissions(vhost: str) -> list[dict] async

List all user topic permissions for a given virtual host.

vhost_limits(vhost: str) -> list[dict] async

List resource limits for a specific virtual host.