RabbitMQ Transport Scripting

In order to provision or de-provision the resources required by an endpoint, the rabbitmq-transport command line (CLI) tool can be used.

The tool can be obtained from NuGet and installed using the following command:

dotnet tool install -g NServiceBus.Transport.RabbitMQ.CommandLine

Once installed, the rabbitmq-transport command line tool will be available for use.

rabbitmq-transport <command> [options]

Available commands

• delays create
• delays migrate
• delays verify
• endpoint create
• queue migrate-to-quorum
• queue validate-delivery-limit

delays create

Use this command to create v2 delay infrastructure queues and exchanges:

rabbitmq-transport delays create [options]

Options

--connectionString | -c : Force this command to use the specified connection string
--connectionStringEnv : Specifies the environment variable where the connection string can be found. --connectionString, if specified, will take precedence over this option
--managementApiUrl : Overrides the value inferred from the connection string
--managementApiUserName : Overrides the value inferred from the connection string. If provided, the --managementApiPassword option must also be provided or this option will be ignored.
--managementApiPassword : Overrides the value inferred from the connection string. If provided, the --managementApiUserName option must also be provided or this option will be ignored
--certPath: The path to the client certificate file for connecting to the broker
--certPassphrase: The passphrase for the client certificate file specified by the certPath option
--disableCertValidation: Disable remote certificate validation when connecting to the broker
--useExternalAuth: Use the external authorization option when connecting to the broker

delays migrate

Use this command to migrate in-flight delayed messages from the v1 delay infrastructure to the v2 delay infrastructure:

rabbitmq-transport delays migrate [options]

Options

--connectionString | -c : Force this command to use the specified connection string
--connectionStringEnv : Specifies the environment variable where the connection string can be found. --connectionString, if specified, will take precedence over this option
--managementApiUrl : Overrides the value inferred from the connection string
--managementApiUserName : Overrides the value inferred from the connection string. If provided, the --managementApiPassword option must also be provided or this option will be ignored.
--managementApiPassword : Overrides the value inferred from the connection string. If provided, the --managementApiUserName option must also be provided or this option will be ignored
--certPath: The path to the client certificate file for connecting to the broker
--certPassphrase: The passphrase for the client certificate file specified by the certPath option
--disableCertValidation: Disable remote certificate validation when connecting to the broker
--useExternalAuth: Use the external authorization option when connecting to the broker
--routingTopology | -r : The routing topology to use

delays verify

Use this command to verify broker requirements for using the v2 delay infrastructure:

rabbitmq-transport delays verify [options]

Options

--connectionString | -c : Force this command to use the specified connection string
--connectionStringEnv : Specifies the environment variable where the connection string can be found. --connectionString, if specified, will take precedence over this option
--managementApiUrl : Overrides the value inferred from the connection string
--managementApiUserName : Overrides the value inferred from the connection string. If provided, the --managementApiPassword option must also be provided or this option will be ignored
--managementApiPassword : Overrides the value inferred from the connection string. If provided, the --managementApiUserName option must also be provided or this option will be ignored
--disableCertValidation: Disable remote certificate validation when connecting to the broker

endpoint create

Use this command to create queues and exchanges for an endpoint:

rabbitmq-transport endpoint create <endpointName> [options]

Arguments

endpointName : The name of the endpoint to create

Options

--connectionString | -c : Force this command to use the specified connection string
--connectionStringEnv : Specifies the environment variable where the connection string can be found. --connectionString, if specified, will take precedence over this option
--managementApiUrl : Overrides the value inferred from the connection string
--managementApiUserName : Overrides the value inferred from the connection string. If provided, the --managementApiPassword option must also be provided or this option will be ignored
--managementApiPassword : Overrides the value inferred from the connection string. If provided, the --managementApiUserName option must also be provided or this option will be ignored
--certPath: Set the path to the client certificate file for connecting to the broker
--certPassphrase: The passphrase for client certificate file for when using a client certificate
--disableCertValidation: Disable remote certificate validation when connecting to the broker
--useExternalAuth: Use the external authorization option when connecting to the broker
--routingTopology | -r : Specifies which routing topology to use
--useDurableEntities | -d : Specifies if entities should be created as durable
--queueType | -t : Specifies queue type will be used for queue creation
--errorQueueName: Also create an error queue with the specified name
--auditQueueName: Also create an audit queue with the specified name
--instanceDiscriminators: An optional list of instance discriminators to use when the endpoint needs uniquely addressable instances

queue migrate-to-quorum

Use this command to migrate an existing classic queue to a quorum queue.

rabbitmq-transport queue migrate-to-quorum <queueName> [options]

Arguments

queueName : The name of the classic queue to migrate to a quorum queue

Options

--connectionString | -c : Force this command to use the specified connection string
--connectionStringEnv : Specifies the environment variable where the connection string can be found. --connectionString, if specified, will take precedence over this option
--managementApiUrl : Overrides the value inferred from the connection string
--managementApiUserName : Overrides the value inferred from the connection string. If provided, the --managementApiPassword option must also be provided or this option will be ignored
--managementApiPassword : Overrides the value inferred from the connection string. If provided, the --managementApiUserName option must also be provided or this option will be ignored
--certPath: Set the path to the client certificate file for connecting to the broker
--certPassphrase: The passphrase for client certificate file for when using a client certificate
--disableCertValidation: The passphrase for client certificate file for when using a client certificate
--useExternalAuth: Use the external authorization option when connecting to the broker

queue validate-delivery-limit

Use this command to validate that a queue is correctly configured to have an unlimited delivery limit, and attempt to create a policy if it is not.

rabbitmq-transport queue validate-delivery-limit <queueName> [options]

Arguments

queueName : The name of the queue to validate

Options

--connectionString | -c : Force this command to use the specified connection string
--connectionStringEnv : Specifies the environment variable where the connection string can be found. --connectionString, if specified, will take precedence over this option
--managementApiUrl : Overrides the value inferred from the connection string
--managementApiUserName : Overrides the value inferred from the connection string. If provided, the --managementApiPassword option must also be provided or this option will be ignored
--managementApiPassword : Overrides the value inferred from the connection string. If provided, the --managementApiUserName option must also be provided or this option will be ignored
--disableCertValidation: The passphrase for client certificate file for when using a client certificate