Skip to content

Parameters

Managing vhost-scoped and global RabbitMQ parameters (e.g., federation, shovels).

all() -> list[dict] async

List all vhost-scoped parameters.

by_component(component: str) -> list[dict] async

List all vhost-scoped parameters for a specific component.

component_by_vhost(component: str, vhost: str) -> list[dict] async

List parameters for a specific component within a virtual host.

delete(component: str, vhost: str, parameter: str) -> dict async

Delete a vhost-scoped parameter.

delete_global_parameter(parameter: str) -> dict async

Delete a global parameter.

detail(component: str, vhost: str, parameter: str) -> dict async

Get details of an individual vhost-scoped parameter.

global_parameter_detail(parameter: str) -> dict async

Get details of an individual global parameter.

global_parameters() -> list[dict] async

List all global parameters.

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

Create or update a vhost-scoped parameter.

Parameters:

Name Type Description Default
value dict

The configuration value for the parameter.

required

set_global_parameter(parameter: str, value: dict) -> dict async

Create or update a global parameter.

Parameters:

Name Type Description Default
value dict

The configuration value for the global parameter.

required