data
RabbitMQ CLI for AI Agents
Use the RabbitMQ CLI from KosmoKrator to call RabbitMQ tools headlessly, return JSON, inspect schemas, and automate workflows from coding agents, scripts, and CI.RabbitMQ CLI Setup
RabbitMQ can be configured headlessly with `kosmokrator integrations:configure rabbitmq`.
# Install KosmoKrator first if it is not available on PATH.
curl -fsSL https://raw.githubusercontent.com/OpenCompanyApp/kosmokrator/main/install.sh | bash
# Configure and verify this integration.
kosmokrator integrations:configure rabbitmq --set username="$RABBITMQ_USERNAME" --set password="$RABBITMQ_PASSWORD" --set hostname="$RABBITMQ_HOSTNAME" --enable --read allow --write ask --json
kosmokrator integrations:doctor rabbitmq --json
kosmokrator integrations:status --json Credentials
Authentication type: Username and password basic. Configure credentials once, then reuse the same stored profile from scripts, coding CLIs, Lua, and MCP.
| Key | Env var | Type | Required | Label |
|---|---|---|---|---|
username | RABBITMQ_USERNAME | Text string | yes | Username |
password | RABBITMQ_PASSWORD | Secret secret | yes | Password |
hostname | RABBITMQ_HOSTNAME | URL url | yes | Management URL |
Command Patterns
The generic command is stable across every integration. The provider shortcut is shorter for humans.
kosmo integrations:call rabbitmq.rabbitmq_get_overview '{}' --json kosmo integrations:rabbitmq rabbitmq_get_overview '{}' --json Discovery
These commands return structured output for coding agents that need to inspect capabilities before choosing a function.
kosmo integrations:docs rabbitmq --json
kosmo integrations:docs rabbitmq.rabbitmq_get_overview --json
kosmo integrations:schema rabbitmq.rabbitmq_get_overview --json
kosmo integrations:search "RabbitMQ" --json
kosmo integrations:list --json Automation Contexts
The same configured command surface works in these environments. The command does not change unless the host wrapper, credentials, or permissions change.
CLI Functions
Every function below can be called headlessly. Commands are highlighted, copyable, and scroll horizontally when payloads are long.
rabbitmq.rabbitmq_get_overview
Get RabbitMQ cluster overview — node info, RabbitMQ version, message rates, queue totals, and listener ports.
read - Parameters
- none
kosmo integrations:call rabbitmq.rabbitmq_get_overview '{}' --json kosmo integrations:rabbitmq rabbitmq_get_overview '{}' --json rabbitmq.rabbitmq_list_nodes
List RabbitMQ cluster nodes with runtime and resource metrics.
read - Parameters
- none
kosmo integrations:call rabbitmq.rabbitmq_list_nodes '{}' --json kosmo integrations:rabbitmq rabbitmq_list_nodes '{}' --json rabbitmq.rabbitmq_get_node
Get details for a RabbitMQ cluster node.
read - Parameters
- name
kosmo integrations:call rabbitmq.rabbitmq_get_node '{"name":"example_name"}' --json kosmo integrations:rabbitmq rabbitmq_get_node '{"name":"example_name"}' --json rabbitmq.rabbitmq_health_check
Run a RabbitMQ management health check such as alarms, local-alarms, virtual-hosts, port-listener, or protocol-listener.
read - Parameters
- check, params
kosmo integrations:call rabbitmq.rabbitmq_health_check '{"check":"example_check","params":"example_params"}' --json kosmo integrations:rabbitmq rabbitmq_health_check '{"check":"example_check","params":"example_params"}' --json rabbitmq.rabbitmq_aliveness_test
Run RabbitMQ aliveness test for a virtual host.
read - Parameters
- vhost
kosmo integrations:call rabbitmq.rabbitmq_aliveness_test '{"vhost":"example_vhost"}' --json kosmo integrations:rabbitmq rabbitmq_aliveness_test '{"vhost":"example_vhost"}' --json rabbitmq.rabbitmq_list_queues
List all RabbitMQ queues across all virtual hosts. Returns queue names, vhost, message counts, consumer counts, and state.
read - Parameters
- vhost, params
kosmo integrations:call rabbitmq.rabbitmq_list_queues '{"vhost":"example_vhost","params":"example_params"}' --json kosmo integrations:rabbitmq rabbitmq_list_queues '{"vhost":"example_vhost","params":"example_params"}' --json rabbitmq.rabbitmq_get_queue
Get detailed information about a specific RabbitMQ queue, including message counts, consumers, bindings, policy, and arguments.
read - Parameters
- vhost, name
kosmo integrations:call rabbitmq.rabbitmq_get_queue '{"vhost":"example_vhost","name":"example_name"}' --json kosmo integrations:rabbitmq rabbitmq_get_queue '{"vhost":"example_vhost","name":"example_name"}' --json rabbitmq.rabbitmq_declare_queue
Declare or update a RabbitMQ queue.
write - Parameters
- vhost, name, definition
kosmo integrations:call rabbitmq.rabbitmq_declare_queue '{"vhost":"example_vhost","name":"example_name","definition":"example_definition"}' --json kosmo integrations:rabbitmq rabbitmq_declare_queue '{"vhost":"example_vhost","name":"example_name","definition":"example_definition"}' --json rabbitmq.rabbitmq_delete_queue
Delete a RabbitMQ queue, optionally only if empty or unused.
write - Parameters
- vhost, name, if_empty, if_unused
kosmo integrations:call rabbitmq.rabbitmq_delete_queue '{"vhost":"example_vhost","name":"example_name","if_empty":true,"if_unused":true}' --json kosmo integrations:rabbitmq rabbitmq_delete_queue '{"vhost":"example_vhost","name":"example_name","if_empty":true,"if_unused":true}' --json rabbitmq.rabbitmq_purge_queue
Purge ready messages from a RabbitMQ queue.
write - Parameters
- vhost, name
kosmo integrations:call rabbitmq.rabbitmq_purge_queue '{"vhost":"example_vhost","name":"example_name"}' --json kosmo integrations:rabbitmq rabbitmq_purge_queue '{"vhost":"example_vhost","name":"example_name"}' --json rabbitmq.rabbitmq_get_queue_bindings
List RabbitMQ bindings for a specific queue.
read - Parameters
- vhost, name
kosmo integrations:call rabbitmq.rabbitmq_get_queue_bindings '{"vhost":"example_vhost","name":"example_name"}' --json kosmo integrations:rabbitmq rabbitmq_get_queue_bindings '{"vhost":"example_vhost","name":"example_name"}' --json rabbitmq.rabbitmq_get_messages
Get messages from a RabbitMQ queue using the management API. ackmode controls whether messages are requeued.
write - Parameters
- vhost, name, options
kosmo integrations:call rabbitmq.rabbitmq_get_messages '{"vhost":"example_vhost","name":"example_name","options":"example_options"}' --json kosmo integrations:rabbitmq rabbitmq_get_messages '{"vhost":"example_vhost","name":"example_name","options":"example_options"}' --json rabbitmq.rabbitmq_list_exchanges
List all RabbitMQ exchanges across all virtual hosts. Returns exchange names, types, vhost, and durability.
read - Parameters
- vhost, params
kosmo integrations:call rabbitmq.rabbitmq_list_exchanges '{"vhost":"example_vhost","params":"example_params"}' --json kosmo integrations:rabbitmq rabbitmq_list_exchanges '{"vhost":"example_vhost","params":"example_params"}' --json rabbitmq.rabbitmq_get_exchange
Get details for a RabbitMQ exchange.
read - Parameters
- vhost, name
kosmo integrations:call rabbitmq.rabbitmq_get_exchange '{"vhost":"example_vhost","name":"example_name"}' --json kosmo integrations:rabbitmq rabbitmq_get_exchange '{"vhost":"example_vhost","name":"example_name"}' --json rabbitmq.rabbitmq_declare_exchange
Declare or update a RabbitMQ exchange.
write - Parameters
- vhost, name, definition
kosmo integrations:call rabbitmq.rabbitmq_declare_exchange '{"vhost":"example_vhost","name":"example_name","definition":"example_definition"}' --json kosmo integrations:rabbitmq rabbitmq_declare_exchange '{"vhost":"example_vhost","name":"example_name","definition":"example_definition"}' --json rabbitmq.rabbitmq_delete_exchange
Delete a RabbitMQ exchange, optionally only if unused.
write - Parameters
- vhost, name, if_unused
kosmo integrations:call rabbitmq.rabbitmq_delete_exchange '{"vhost":"example_vhost","name":"example_name","if_unused":true}' --json kosmo integrations:rabbitmq rabbitmq_delete_exchange '{"vhost":"example_vhost","name":"example_name","if_unused":true}' --json rabbitmq.rabbitmq_publish_message
Publish a message to a RabbitMQ exchange through the management API.
write - Parameters
- vhost, exchange, message
kosmo integrations:call rabbitmq.rabbitmq_publish_message '{"vhost":"example_vhost","exchange":"example_exchange","message":"example_message"}' --json kosmo integrations:rabbitmq rabbitmq_publish_message '{"vhost":"example_vhost","exchange":"example_exchange","message":"example_message"}' --json rabbitmq.rabbitmq_list_exchange_source_bindings
List bindings where a RabbitMQ exchange is the source.
read - Parameters
- vhost, name
kosmo integrations:call rabbitmq.rabbitmq_list_exchange_source_bindings '{"vhost":"example_vhost","name":"example_name"}' --json kosmo integrations:rabbitmq rabbitmq_list_exchange_source_bindings '{"vhost":"example_vhost","name":"example_name"}' --json rabbitmq.rabbitmq_list_exchange_destination_bindings
List bindings where a RabbitMQ exchange is the destination.
read - Parameters
- vhost, name
kosmo integrations:call rabbitmq.rabbitmq_list_exchange_destination_bindings '{"vhost":"example_vhost","name":"example_name"}' --json kosmo integrations:rabbitmq rabbitmq_list_exchange_destination_bindings '{"vhost":"example_vhost","name":"example_name"}' --json rabbitmq.rabbitmq_list_bindings
List RabbitMQ bindings globally or for a virtual host.
read - Parameters
- vhost
kosmo integrations:call rabbitmq.rabbitmq_list_bindings '{"vhost":"example_vhost"}' --json kosmo integrations:rabbitmq rabbitmq_list_bindings '{"vhost":"example_vhost"}' --json rabbitmq.rabbitmq_create_binding
Create a RabbitMQ binding from an exchange to a queue or exchange.
write - Parameters
- vhost, source, destination_type, destination, routing_key, arguments
kosmo integrations:call rabbitmq.rabbitmq_create_binding '{"vhost":"example_vhost","source":"example_source","destination_type":"example_destination_type","destination":"example_destination","routing_key":"example_routing_key","arguments":"example_arguments"}' --json kosmo integrations:rabbitmq rabbitmq_create_binding '{"vhost":"example_vhost","source":"example_source","destination_type":"example_destination_type","destination":"example_destination","routing_key":"example_routing_key","arguments":"example_arguments"}' --json rabbitmq.rabbitmq_delete_binding
Delete a RabbitMQ binding by properties key.
write - Parameters
- vhost, source, destination_type, destination, properties_key
kosmo integrations:call rabbitmq.rabbitmq_delete_binding '{"vhost":"example_vhost","source":"example_source","destination_type":"example_destination_type","destination":"example_destination","properties_key":"example_properties_key"}' --json kosmo integrations:rabbitmq rabbitmq_delete_binding '{"vhost":"example_vhost","source":"example_source","destination_type":"example_destination_type","destination":"example_destination","properties_key":"example_properties_key"}' --json rabbitmq.rabbitmq_list_connections
List all active RabbitMQ AMQP connections. Returns client info, peer host/port, channels, and connection state.
read - Parameters
- none
kosmo integrations:call rabbitmq.rabbitmq_list_connections '{}' --json kosmo integrations:rabbitmq rabbitmq_list_connections '{}' --json rabbitmq.rabbitmq_get_connection
Get details for one RabbitMQ connection.
read - Parameters
- name
kosmo integrations:call rabbitmq.rabbitmq_get_connection '{"name":"example_name"}' --json kosmo integrations:rabbitmq rabbitmq_get_connection '{"name":"example_name"}' --json rabbitmq.rabbitmq_close_connection
Close a RabbitMQ connection by name.
write - Parameters
- name, reason
kosmo integrations:call rabbitmq.rabbitmq_close_connection '{"name":"example_name","reason":"example_reason"}' --json kosmo integrations:rabbitmq rabbitmq_close_connection '{"name":"example_name","reason":"example_reason"}' --json rabbitmq.rabbitmq_list_channels
List RabbitMQ channels.
read - Parameters
- none
kosmo integrations:call rabbitmq.rabbitmq_list_channels '{}' --json kosmo integrations:rabbitmq rabbitmq_list_channels '{}' --json rabbitmq.rabbitmq_get_channel
Get details for one RabbitMQ channel.
read - Parameters
- name
kosmo integrations:call rabbitmq.rabbitmq_get_channel '{"name":"example_name"}' --json kosmo integrations:rabbitmq rabbitmq_get_channel '{"name":"example_name"}' --json rabbitmq.rabbitmq_list_consumers
List RabbitMQ consumers globally or for a virtual host.
read - Parameters
- vhost
kosmo integrations:call rabbitmq.rabbitmq_list_consumers '{"vhost":"example_vhost"}' --json kosmo integrations:rabbitmq rabbitmq_list_consumers '{"vhost":"example_vhost"}' --json rabbitmq.rabbitmq_list_vhosts
List all RabbitMQ virtual hosts. Returns vhost names, tracing status, and message counts.
read - Parameters
- none
kosmo integrations:call rabbitmq.rabbitmq_list_vhosts '{}' --json kosmo integrations:rabbitmq rabbitmq_list_vhosts '{}' --json rabbitmq.rabbitmq_get_vhost
Get details for one RabbitMQ virtual host.
read - Parameters
- name
kosmo integrations:call rabbitmq.rabbitmq_get_vhost '{"name":"example_name"}' --json kosmo integrations:rabbitmq rabbitmq_get_vhost '{"name":"example_name"}' --json rabbitmq.rabbitmq_create_vhost
Create or update a RabbitMQ virtual host.
write - Parameters
- name, metadata
kosmo integrations:call rabbitmq.rabbitmq_create_vhost '{"name":"example_name","metadata":"example_metadata"}' --json kosmo integrations:rabbitmq rabbitmq_create_vhost '{"name":"example_name","metadata":"example_metadata"}' --json rabbitmq.rabbitmq_delete_vhost
Delete a RabbitMQ virtual host.
write - Parameters
- name
kosmo integrations:call rabbitmq.rabbitmq_delete_vhost '{"name":"example_name"}' --json kosmo integrations:rabbitmq rabbitmq_delete_vhost '{"name":"example_name"}' --json rabbitmq.rabbitmq_list_vhost_permissions
List RabbitMQ permissions for a virtual host.
read - Parameters
- vhost
kosmo integrations:call rabbitmq.rabbitmq_list_vhost_permissions '{"vhost":"example_vhost"}' --json kosmo integrations:rabbitmq rabbitmq_list_vhost_permissions '{"vhost":"example_vhost"}' --json rabbitmq.rabbitmq_list_users
List RabbitMQ users.
read - Parameters
- none
kosmo integrations:call rabbitmq.rabbitmq_list_users '{}' --json kosmo integrations:rabbitmq rabbitmq_list_users '{}' --json rabbitmq.rabbitmq_get_user
Get details for one RabbitMQ user.
read - Parameters
- name
kosmo integrations:call rabbitmq.rabbitmq_get_user '{"name":"example_name"}' --json kosmo integrations:rabbitmq rabbitmq_get_user '{"name":"example_name"}' --json rabbitmq.rabbitmq_list_permissions
List RabbitMQ permissions across all virtual hosts.
read - Parameters
- none
kosmo integrations:call rabbitmq.rabbitmq_list_permissions '{}' --json kosmo integrations:rabbitmq rabbitmq_list_permissions '{}' --json rabbitmq.rabbitmq_set_permissions
Set RabbitMQ configure, write, and read permissions for a user on a virtual host.
write - Parameters
- vhost, user, configure, write, read
kosmo integrations:call rabbitmq.rabbitmq_set_permissions '{"vhost":"example_vhost","user":"example_user","configure":"example_configure","write":"example_write","read":"example_read"}' --json kosmo integrations:rabbitmq rabbitmq_set_permissions '{"vhost":"example_vhost","user":"example_user","configure":"example_configure","write":"example_write","read":"example_read"}' --json rabbitmq.rabbitmq_delete_permissions
Delete RabbitMQ permissions for a user on a virtual host.
write - Parameters
- vhost, user
kosmo integrations:call rabbitmq.rabbitmq_delete_permissions '{"vhost":"example_vhost","user":"example_user"}' --json kosmo integrations:rabbitmq rabbitmq_delete_permissions '{"vhost":"example_vhost","user":"example_user"}' --json rabbitmq.rabbitmq_list_policies
List RabbitMQ policies globally or for a virtual host.
read - Parameters
- vhost
kosmo integrations:call rabbitmq.rabbitmq_list_policies '{"vhost":"example_vhost"}' --json kosmo integrations:rabbitmq rabbitmq_list_policies '{"vhost":"example_vhost"}' --json rabbitmq.rabbitmq_export_definitions
Export RabbitMQ broker definitions.
read - Parameters
- none
kosmo integrations:call rabbitmq.rabbitmq_export_definitions '{}' --json kosmo integrations:rabbitmq rabbitmq_export_definitions '{}' --json rabbitmq.rabbitmq_import_definitions
Import RabbitMQ broker definitions.
write - Parameters
- definitions
kosmo integrations:call rabbitmq.rabbitmq_import_definitions '{"definitions":"example_definitions"}' --json kosmo integrations:rabbitmq rabbitmq_import_definitions '{"definitions":"example_definitions"}' --json Function Schemas
Use these parameter tables when building CLI payloads without calling integrations:schema first.
rabbitmq.rabbitmq_get_overview 0 parameters
kosmo integrations:schema rabbitmq.rabbitmq_get_overview --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
rabbitmq.rabbitmq_list_nodes 0 parameters
kosmo integrations:schema rabbitmq.rabbitmq_list_nodes --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
rabbitmq.rabbitmq_get_node 1 parameters
kosmo integrations:schema rabbitmq.rabbitmq_get_node --json | Parameter | Type | Required | Description |
|---|---|---|---|
name | string | yes | RabbitMQ node name. |
rabbitmq.rabbitmq_health_check 2 parameters
kosmo integrations:schema rabbitmq.rabbitmq_health_check --json | Parameter | Type | Required | Description |
|---|---|---|---|
check | string | yes | Health check name. |
params | object | no | Optional query parameters such as port, protocol, or timeout. |
rabbitmq.rabbitmq_aliveness_test 1 parameters
kosmo integrations:schema rabbitmq.rabbitmq_aliveness_test --json | Parameter | Type | Required | Description |
|---|---|---|---|
vhost | string | no | Virtual host name. Defaults to /. |
rabbitmq.rabbitmq_list_queues 2 parameters
kosmo integrations:schema rabbitmq.rabbitmq_list_queues --json | Parameter | Type | Required | Description |
|---|---|---|---|
vhost | string | no | Optional virtual host name. |
params | object | no | Optional query parameters: page, page_size, name, use_regex, disable_stats, enable_queue_totals. |
rabbitmq.rabbitmq_get_queue 2 parameters
kosmo integrations:schema rabbitmq.rabbitmq_get_queue --json | Parameter | Type | Required | Description |
|---|---|---|---|
vhost | string | yes | The virtual host containing the queue (e.g., "/"). |
name | string | yes | The queue name. |
rabbitmq.rabbitmq_declare_queue 3 parameters
kosmo integrations:schema rabbitmq.rabbitmq_declare_queue --json | Parameter | Type | Required | Description |
|---|---|---|---|
vhost | string | yes | Virtual host name. |
name | string | yes | Queue name. |
definition | object | no | Queue definition: durable, auto_delete, arguments, node. |
rabbitmq.rabbitmq_delete_queue 4 parameters
kosmo integrations:schema rabbitmq.rabbitmq_delete_queue --json | Parameter | Type | Required | Description |
|---|---|---|---|
vhost | string | yes | Virtual host name. |
name | string | yes | Queue name. |
if_empty | boolean | no | Only delete when the queue is empty. |
if_unused | boolean | no | Only delete when the queue is unused. |
rabbitmq.rabbitmq_purge_queue 2 parameters
kosmo integrations:schema rabbitmq.rabbitmq_purge_queue --json | Parameter | Type | Required | Description |
|---|---|---|---|
vhost | string | yes | Virtual host name. |
name | string | yes | Queue name. |
rabbitmq.rabbitmq_get_queue_bindings 2 parameters
kosmo integrations:schema rabbitmq.rabbitmq_get_queue_bindings --json | Parameter | Type | Required | Description |
|---|---|---|---|
vhost | string | yes | Virtual host name. |
name | string | yes | Queue name. |
rabbitmq.rabbitmq_get_messages 3 parameters
kosmo integrations:schema rabbitmq.rabbitmq_get_messages --json | Parameter | Type | Required | Description |
|---|---|---|---|
vhost | string | yes | Virtual host name. |
name | string | yes | Queue name. |
options | object | no | Options: count, ackmode, encoding, truncate. Defaults to safe requeue mode. |
rabbitmq.rabbitmq_list_exchanges 2 parameters
kosmo integrations:schema rabbitmq.rabbitmq_list_exchanges --json | Parameter | Type | Required | Description |
|---|---|---|---|
vhost | string | no | Optional virtual host name. |
params | object | no | Optional query parameters. |
rabbitmq.rabbitmq_get_exchange 2 parameters
kosmo integrations:schema rabbitmq.rabbitmq_get_exchange --json | Parameter | Type | Required | Description |
|---|---|---|---|
vhost | string | yes | Virtual host name. |
name | string | yes | Exchange name. |
rabbitmq.rabbitmq_declare_exchange 3 parameters
kosmo integrations:schema rabbitmq.rabbitmq_declare_exchange --json | Parameter | Type | Required | Description |
|---|---|---|---|
vhost | string | yes | Virtual host name. |
name | string | yes | Exchange name. |
definition | object | yes | Exchange definition: type, durable, auto_delete, internal, arguments. |
rabbitmq.rabbitmq_delete_exchange 3 parameters
kosmo integrations:schema rabbitmq.rabbitmq_delete_exchange --json | Parameter | Type | Required | Description |
|---|---|---|---|
vhost | string | yes | Virtual host name. |
name | string | yes | Exchange name. |
if_unused | boolean | no | Only delete when the exchange is unused. |
rabbitmq.rabbitmq_publish_message 3 parameters
kosmo integrations:schema rabbitmq.rabbitmq_publish_message --json | Parameter | Type | Required | Description |
|---|---|---|---|
vhost | string | yes | Virtual host name. |
exchange | string | yes | Exchange name. Use empty string for default exchange. |
message | object | yes | Message payload: properties, routing_key, payload, payload_encoding. |
rabbitmq.rabbitmq_list_exchange_source_bindings 2 parameters
kosmo integrations:schema rabbitmq.rabbitmq_list_exchange_source_bindings --json | Parameter | Type | Required | Description |
|---|---|---|---|
vhost | string | yes | Virtual host name. |
name | string | yes | Exchange name. |
rabbitmq.rabbitmq_list_exchange_destination_bindings 2 parameters
kosmo integrations:schema rabbitmq.rabbitmq_list_exchange_destination_bindings --json | Parameter | Type | Required | Description |
|---|---|---|---|
vhost | string | yes | Virtual host name. |
name | string | yes | Exchange name. |
rabbitmq.rabbitmq_list_bindings 1 parameters
kosmo integrations:schema rabbitmq.rabbitmq_list_bindings --json | Parameter | Type | Required | Description |
|---|---|---|---|
vhost | string | no | Optional virtual host name. |
rabbitmq.rabbitmq_create_binding 6 parameters
kosmo integrations:schema rabbitmq.rabbitmq_create_binding --json | Parameter | Type | Required | Description |
|---|---|---|---|
vhost | string | yes | Virtual host name. |
source | string | yes | Source exchange name. |
destination_type | string | yes | Destination type: queue or exchange. |
destination | string | yes | Destination queue or exchange name. |
routing_key | string | no | Binding routing key. |
arguments | object | no | Binding arguments. |
rabbitmq.rabbitmq_delete_binding 5 parameters
kosmo integrations:schema rabbitmq.rabbitmq_delete_binding --json | Parameter | Type | Required | Description |
|---|---|---|---|
vhost | string | yes | Virtual host name. |
source | string | yes | Source exchange name. |
destination_type | string | yes | Destination type: queue or exchange. |
destination | string | yes | Destination queue or exchange name. |
properties_key | string | yes | Binding properties_key returned by RabbitMQ. |
rabbitmq.rabbitmq_list_connections 0 parameters
kosmo integrations:schema rabbitmq.rabbitmq_list_connections --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
rabbitmq.rabbitmq_get_connection 1 parameters
kosmo integrations:schema rabbitmq.rabbitmq_get_connection --json | Parameter | Type | Required | Description |
|---|---|---|---|
name | string | yes | Connection name from RabbitMQ. |
rabbitmq.rabbitmq_close_connection 2 parameters
kosmo integrations:schema rabbitmq.rabbitmq_close_connection --json | Parameter | Type | Required | Description |
|---|---|---|---|
name | string | yes | Connection name from RabbitMQ. |
reason | string | no | Optional close reason. |
rabbitmq.rabbitmq_list_channels 0 parameters
kosmo integrations:schema rabbitmq.rabbitmq_list_channels --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
rabbitmq.rabbitmq_get_channel 1 parameters
kosmo integrations:schema rabbitmq.rabbitmq_get_channel --json | Parameter | Type | Required | Description |
|---|---|---|---|
name | string | yes | Channel name from RabbitMQ. |
rabbitmq.rabbitmq_list_consumers 1 parameters
kosmo integrations:schema rabbitmq.rabbitmq_list_consumers --json | Parameter | Type | Required | Description |
|---|---|---|---|
vhost | string | no | Optional virtual host name. |
rabbitmq.rabbitmq_list_vhosts 0 parameters
kosmo integrations:schema rabbitmq.rabbitmq_list_vhosts --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
rabbitmq.rabbitmq_get_vhost 1 parameters
kosmo integrations:schema rabbitmq.rabbitmq_get_vhost --json | Parameter | Type | Required | Description |
|---|---|---|---|
name | string | yes | Virtual host name. |
rabbitmq.rabbitmq_create_vhost 2 parameters
kosmo integrations:schema rabbitmq.rabbitmq_create_vhost --json | Parameter | Type | Required | Description |
|---|---|---|---|
name | string | yes | Virtual host name. |
metadata | object | no | Optional metadata: description, tags, default_queue_type, protected_from_deletion, tracing. |
rabbitmq.rabbitmq_delete_vhost 1 parameters
kosmo integrations:schema rabbitmq.rabbitmq_delete_vhost --json | Parameter | Type | Required | Description |
|---|---|---|---|
name | string | yes | Virtual host name. |
rabbitmq.rabbitmq_list_vhost_permissions 1 parameters
kosmo integrations:schema rabbitmq.rabbitmq_list_vhost_permissions --json | Parameter | Type | Required | Description |
|---|---|---|---|
vhost | string | yes | Virtual host name. |
rabbitmq.rabbitmq_list_users 0 parameters
kosmo integrations:schema rabbitmq.rabbitmq_list_users --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
rabbitmq.rabbitmq_get_user 1 parameters
kosmo integrations:schema rabbitmq.rabbitmq_get_user --json | Parameter | Type | Required | Description |
|---|---|---|---|
name | string | yes | RabbitMQ username. |
rabbitmq.rabbitmq_list_permissions 0 parameters
kosmo integrations:schema rabbitmq.rabbitmq_list_permissions --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
rabbitmq.rabbitmq_set_permissions 5 parameters
kosmo integrations:schema rabbitmq.rabbitmq_set_permissions --json | Parameter | Type | Required | Description |
|---|---|---|---|
vhost | string | yes | Virtual host name. |
user | string | yes | RabbitMQ username. |
configure | string | yes | Configure regex. |
write | string | yes | Write regex. |
read | string | yes | Read regex. |
rabbitmq.rabbitmq_delete_permissions 2 parameters
kosmo integrations:schema rabbitmq.rabbitmq_delete_permissions --json | Parameter | Type | Required | Description |
|---|---|---|---|
vhost | string | yes | Virtual host name. |
user | string | yes | RabbitMQ username. |
rabbitmq.rabbitmq_list_policies 1 parameters
kosmo integrations:schema rabbitmq.rabbitmq_list_policies --json | Parameter | Type | Required | Description |
|---|---|---|---|
vhost | string | no | Optional virtual host name. |
rabbitmq.rabbitmq_export_definitions 0 parameters
kosmo integrations:schema rabbitmq.rabbitmq_export_definitions --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
rabbitmq.rabbitmq_import_definitions 1 parameters
kosmo integrations:schema rabbitmq.rabbitmq_import_definitions --json | Parameter | Type | Required | Description |
|---|---|---|---|
definitions | object | yes | RabbitMQ definitions document. |
Permissions
Headless calls still follow the integration read/write permission policy. Configure read/write defaults with
integrations:configure. Add --force only for trusted automation that should bypass that policy.