@dishantlangayan/sc-plugin-broker
v0.11.0
Published
Commands to interact with Solace Event Broker.
Maintainers
Readme
@dishantlangayan/sc-plugin-broker
Commands to interact with Solace Event Broker.
[!NOTE] This plugin is packaged with the Solace Cloud CLI but can be use independently when working with self-managed Software Event Brokers.
Usage
$ npm install -g @dishantlangayan/sc-plugin-broker
$ sc COMMAND
running command...
$ sc (--version)
@dishantlangayan/sc-plugin-broker/0.11.0 linux-x64 node-v24.19.0
$ sc --help [COMMAND]
USAGE
$ sc COMMAND
...Resources
This is not an officially supported Solace product.
For more information try these resources:
- Solace Cloud CLI Docs
- Ask the Solace Community
- The Solace Developer Portal website at: https://solace.dev
Testing
## Run all tests
npm test
## Run specific test file
npm test -- test/commands/broker/queue/create.test.tsWriting Tests
We use test helpers to eliminate duplication and standardize testing patterns. See the Test Helpers Guide for detailed documentation.
Contributing
Contributions are encouraged! Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
Authors
See the list of contributors who participated in this project.
License
See the LICENSE file for details.
Commands
sc broker acl-profile client-connect-exceptions createsc broker acl-profile client-connect-exceptions deletesc broker acl-profile client-connect-exceptions listsc broker acl-profile createsc broker acl-profile deletesc broker acl-profile displaysc broker acl-profile listsc broker acl-profile publish-topic-exceptions createsc broker acl-profile publish-topic-exceptions deletesc broker acl-profile publish-topic-exceptions listsc broker acl-profile subscribe-share-name-exceptions createsc broker acl-profile subscribe-share-name-exceptions deletesc broker acl-profile subscribe-share-name-exceptions listsc broker acl-profile subscribe-topic-exceptions createsc broker acl-profile subscribe-topic-exceptions deletesc broker acl-profile subscribe-topic-exceptions listsc broker acl-profile updatesc broker client-profile createsc broker client-profile deletesc broker client-profile displaysc broker client-profile listsc broker client-profile updatesc broker client-username createsc broker client-username deletesc broker client-username displaysc broker client-username listsc broker client-username updatesc broker login basicsc broker login cloudsc broker login listsc broker logoutsc broker msg-vpn createsc broker msg-vpn deletesc broker msg-vpn displaysc broker msg-vpn listsc broker msg-vpn updatesc broker queue-template createsc broker queue-template deletesc broker queue-template displaysc broker queue-template listsc broker queue-template updatesc broker queue createsc broker queue deletesc broker queue displaysc broker queue listsc broker queue subscriptions createsc broker queue subscriptions deletesc broker queue update
sc broker acl-profile client-connect-exceptions create
Create a client connect exception for an ACL Profile on a Solace Event Broker.
USAGE
$ sc broker acl-profile client-connect-exceptions create -a <value> -n <value> [--json] [--log-level debug|warn|error|info|trace] [--broker-id <value>
| -b <value>] [-v <value>]
FLAGS
-a, --address=<value> (required) The IP address/netmask of the client connect exception in CIDR form (e.g.,
192.168.1.0/24).
-b, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-n, --name=<value> (required) The name of the ACL Profile.
-v, --msg-vpn-name=<value> The name of the Message VPN.
--broker-id=<value> Stored broker identifier. If not provided, uses the default broker.
GLOBAL FLAGS
--json Format output as json.
--log-level=<option> [default: info] Specify level for logging.
<options: debug|warn|error|info|trace>
DESCRIPTION
Create a client connect exception for an ACL Profile on a Solace Event Broker.
Adds an exception to the ACL Profile that allows or disallows clients connecting from specific IP addresses. The
exception is expressed as an IP address/netmask in CIDR form.
EXAMPLES
$ sc broker acl-profile client-connect-exceptions create --name=myProfile --address=192.168.1.0/24See code: src/commands/broker/acl-profile/client-connect-exceptions/create.ts
sc broker acl-profile client-connect-exceptions delete
Delete a client connect exception from an ACL Profile on a Solace Event Broker.
USAGE
$ sc broker acl-profile client-connect-exceptions delete -a <value> -n <value> [--json] [--log-level debug|warn|error|info|trace] [--broker-id <value>
| -b <value>] [-v <value>] [--no-prompt]
FLAGS
-a, --address=<value> (required) The IP address/netmask of the client connect exception to delete in CIDR form.
-b, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-n, --name=<value> (required) The name of the ACL Profile.
-v, --msg-vpn-name=<value> The name of the Message VPN.
--broker-id=<value> Stored broker identifier. If not provided, uses the default broker.
--no-prompt Skip confirmation prompt and proceed with deletion.
GLOBAL FLAGS
--json Format output as json.
--log-level=<option> [default: info] Specify level for logging.
<options: debug|warn|error|info|trace>
DESCRIPTION
Delete a client connect exception from an ACL Profile on a Solace Event Broker.
Removes the specified client connect exception from the ACL Profile. This is a destructive operation.
By default, a confirmation prompt is shown before deletion. Use --no-prompt to skip confirmation.
EXAMPLES
$ sc broker acl-profile client-connect-exceptions delete --name=myProfile --address=192.168.1.0/24
$ sc broker acl-profile client-connect-exceptions delete --name=myProfile --address=10.0.0.0/8 --no-promptSee code: src/commands/broker/acl-profile/client-connect-exceptions/delete.ts
sc broker acl-profile client-connect-exceptions list
List client connect exceptions for an ACL Profile from a Solace Event Broker.
USAGE
$ sc broker acl-profile client-connect-exceptions list -n <value> [--json] [--log-level debug|warn|error|info|trace] [--broker-id <value> | -b
<value>] [-v <value>]
FLAGS
-b, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-n, --name=<value> (required) The name of the ACL Profile.
-v, --msg-vpn-name=<value> The name of the Message VPN.
--broker-id=<value> Stored broker identifier. If not provided, uses the default broker.
GLOBAL FLAGS
--json Format output as json.
--log-level=<option> [default: info] Specify level for logging.
<options: debug|warn|error|info|trace>
DESCRIPTION
List client connect exceptions for an ACL Profile from a Solace Event Broker.
Retrieves and displays all client connect exceptions configured for the specified ACL Profile using the SEMP Monitor
API.
EXAMPLES
$ sc broker acl-profile client-connect-exceptions list --name=myProfileSee code: src/commands/broker/acl-profile/client-connect-exceptions/list.ts
sc broker acl-profile create
Create an ACL Profile on a Solace Event Broker.
USAGE
$ sc broker acl-profile create -n <value> [--json] [--log-level debug|warn|error|info|trace] [--broker-id <value> | -b
<value>] [-v <value>] [--client-connect-default-action allow|disallow] [--publish-topic-default-action
allow|disallow] [--subscribe-share-name-default-action allow|disallow] [--subscribe-topic-default-action
allow|disallow]
FLAGS
-b, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-n, --name=<value> (required) The name of the ACL Profile to create.
-v, --msg-vpn-name=<value> The name of the Message VPN.
--broker-id=<value> Stored broker identifier. If not provided, uses the default
broker.
--client-connect-default-action=<option> The default action to take when a client using the ACL Profile
connects.
<options: allow|disallow>
--publish-topic-default-action=<option> The default action to take when a client using the ACL Profile
publishes to a topic.
<options: allow|disallow>
--subscribe-share-name-default-action=<option> The default action to take when a client using the ACL Profile
subscribes to a share-name subscription.
<options: allow|disallow>
--subscribe-topic-default-action=<option> The default action to take when a client using the ACL Profile
subscribes to a topic.
<options: allow|disallow>
GLOBAL FLAGS
--json Format output as json.
--log-level=<option> [default: info] Specify level for logging.
<options: debug|warn|error|info|trace>
DESCRIPTION
Create an ACL Profile on a Solace Event Broker.
Access control list (ACL) profiles control which clients can connect to a message Message VPN and which topics
connected clients are allowed to publish and subscribe to.
Each of these access controls require a defined default action (allow or disallow connection, allow or disallow
publishing to topics, allow or disallow subscribing to topics, and allow or disallow subscribing to share names).
Default action is disallow for each.
EXAMPLES
$ sc broker acl-profile create --name=myProfile
$ sc broker acl-profile create --name=myProfile --client-connect-default-action=allow --publish-topic-default-action=disallow --subscribe-topic-default-action=allowSee code: src/commands/broker/acl-profile/create.ts
sc broker acl-profile delete
Delete an ACL Profile from a Solace Event Broker.
USAGE
$ sc broker acl-profile delete -n <value> [--json] [--log-level debug|warn|error|info|trace] [--broker-id <value> | -b
<value>] [-v <value>] [--no-prompt]
FLAGS
-b, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-n, --name=<value> (required) The name of the ACL Profile to delete.
-v, --msg-vpn-name=<value> The name of the Message VPN.
--broker-id=<value> Stored broker identifier. If not provided, uses the default broker.
--no-prompt Skip confirmation prompt and proceed with deletion.
GLOBAL FLAGS
--json Format output as json.
--log-level=<option> [default: info] Specify level for logging.
<options: debug|warn|error|info|trace>
DESCRIPTION
Delete an ACL Profile from a Solace Event Broker.
This is a destructive operation that removes the ACL Profile. Any clients or client usernames using this profile
should be updated to use a different profile before deletion.
By default, a confirmation prompt is shown before deletion. Use --no-prompt to skip confirmation.
EXAMPLES
$ sc broker acl-profile delete --name=myProfile
$ sc broker acl-profile delete --name=myProfile --no-promptSee code: src/commands/broker/acl-profile/delete.ts
sc broker acl-profile display
Display ACL Profile information from a Solace Event Broker.
USAGE
$ sc broker acl-profile display -n <value> [--json] [--log-level debug|warn|error|info|trace] [--broker-id <value> | -b
<value>] [-v <value>]
FLAGS
-b, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-n, --name=<value> (required) The name of the ACL Profile to display.
-v, --msg-vpn-name=<value> The name of the Message VPN.
--broker-id=<value> Stored broker identifier. If not provided, uses the default broker.
GLOBAL FLAGS
--json Format output as json.
--log-level=<option> [default: info] Specify level for logging.
<options: debug|warn|error|info|trace>
DESCRIPTION
Display ACL Profile information from a Solace Event Broker.
Retrieves and displays detailed information about an ACL Profile using the SEMP Monitor API, including configuration
and default actions.
EXAMPLES
$ sc broker acl-profile display --name=myProfileSee code: src/commands/broker/acl-profile/display.ts
sc broker acl-profile list
List ACL Profiles from a Solace Event Broker.
USAGE
$ sc broker acl-profile list [--json] [--log-level debug|warn|error|info|trace] [--broker-id <value> | -b <value>] [-v
<value>] [-a] [-c <value>] [-n <value>] [-s <value>]
FLAGS
-a, --all Display all ACL profiles (auto-pagination).
-b, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-c, --count=<value> [default: 10] Number of ACL profiles to display per page.
-n, --name=<value> Filter ACL profiles by name. Supports * wildcard.
-s, --select=<value> Comma-separated list of attributes to display (max 10).
-v, --msg-vpn-name=<value> The name of the Message VPN.
--broker-id=<value> Stored broker identifier. If not provided, uses the default broker.
GLOBAL FLAGS
--json Format output as json.
--log-level=<option> [default: info] Specify level for logging.
<options: debug|warn|error|info|trace>
DESCRIPTION
List ACL Profiles from a Solace Event Broker.
Retrieves and displays ACL Profiles from the specified Message VPN using the SEMP Monitor API.
Supports filtering by name (with wildcards), custom attribute selection, and pagination.
EXAMPLES
$ sc broker acl-profile list
$ sc broker acl-profile list --count=20
$ sc broker acl-profile list --name="client*"
$ sc broker acl-profile list --select=aclProfileName,clientConnectDefaultAction,publishTopicDefaultAction
$ sc broker acl-profile list --allSee code: src/commands/broker/acl-profile/list.ts
sc broker acl-profile publish-topic-exceptions create
Create a publish topic exception for an ACL Profile on a Solace Event Broker.
USAGE
$ sc broker acl-profile publish-topic-exceptions create -n <value> -x smf|mqtt -t <value> [--json] [--log-level debug|warn|error|info|trace]
[--broker-id <value> | -b <value>] [-v <value>]
FLAGS
-b, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-n, --name=<value> (required) The name of the ACL Profile.
-t, --topic=<value> (required) The topic for the exception. May include wildcards.
-v, --msg-vpn-name=<value> The name of the Message VPN.
-x, --syntax=<option> (required) The syntax of the topic.
<options: smf|mqtt>
--broker-id=<value> Stored broker identifier. If not provided, uses the default broker.
GLOBAL FLAGS
--json Format output as json.
--log-level=<option> [default: info] Specify level for logging.
<options: debug|warn|error|info|trace>
DESCRIPTION
Create a publish topic exception for an ACL Profile on a Solace Event Broker.
Adds an exception to the ACL Profile for clients publishing to specific topics. The exception is expressed as a topic
with optional wildcards and must specify the syntax type (smf or mqtt).
EXAMPLES
$ sc broker acl-profile publish-topic-exceptions create --name=myProfile --topic="orders/*/created" --syntax=smf
$ sc broker acl-profile publish-topic-exceptions create --name=myProfile --topic="devices/+/telemetry" --syntax=mqttSee code: src/commands/broker/acl-profile/publish-topic-exceptions/create.ts
sc broker acl-profile publish-topic-exceptions delete
Delete a publish topic exception from an ACL Profile on a Solace Event Broker.
USAGE
$ sc broker acl-profile publish-topic-exceptions delete -n <value> -x smf|mqtt -t <value> [--json] [--log-level debug|warn|error|info|trace]
[--broker-id <value> | -b <value>] [-v <value>] [--no-prompt]
FLAGS
-b, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-n, --name=<value> (required) The name of the ACL Profile.
-t, --topic=<value> (required) The topic of the exception to delete.
-v, --msg-vpn-name=<value> The name of the Message VPN.
-x, --syntax=<option> (required) The syntax of the topic.
<options: smf|mqtt>
--broker-id=<value> Stored broker identifier. If not provided, uses the default broker.
--no-prompt Skip confirmation prompt and proceed with deletion.
GLOBAL FLAGS
--json Format output as json.
--log-level=<option> [default: info] Specify level for logging.
<options: debug|warn|error|info|trace>
DESCRIPTION
Delete a publish topic exception from an ACL Profile on a Solace Event Broker.
Removes the specified publish topic exception from the ACL Profile. This is a destructive operation.
By default, a confirmation prompt is shown before deletion. Use --no-prompt to skip confirmation.
EXAMPLES
$ sc broker acl-profile publish-topic-exceptions delete --name=myProfile --topic="orders/*/created" --syntax=smf
$ sc broker acl-profile publish-topic-exceptions delete --name=myProfile --topic="devices/+/telemetry" --syntax=mqtt --no-promptSee code: src/commands/broker/acl-profile/publish-topic-exceptions/delete.ts
sc broker acl-profile publish-topic-exceptions list
List publish topic exceptions for an ACL Profile from a Solace Event Broker.
USAGE
$ sc broker acl-profile publish-topic-exceptions list -n <value> [--json] [--log-level debug|warn|error|info|trace] [--broker-id <value> | -b
<value>] [-v <value>]
FLAGS
-b, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-n, --name=<value> (required) The name of the ACL Profile.
-v, --msg-vpn-name=<value> The name of the Message VPN.
--broker-id=<value> Stored broker identifier. If not provided, uses the default broker.
GLOBAL FLAGS
--json Format output as json.
--log-level=<option> [default: info] Specify level for logging.
<options: debug|warn|error|info|trace>
DESCRIPTION
List publish topic exceptions for an ACL Profile from a Solace Event Broker.
Retrieves and displays all publish topic exceptions configured for the specified ACL Profile using the SEMP Monitor
API.
EXAMPLES
$ sc broker acl-profile publish-topic-exceptions list --name=myProfileSee code: src/commands/broker/acl-profile/publish-topic-exceptions/list.ts
sc broker acl-profile subscribe-share-name-exceptions create
Create a subscribe share name exception for an ACL Profile on a Solace Event Broker.
USAGE
$ sc broker acl-profile subscribe-share-name-exceptions create -n <value> -x smf|mqtt -t <value> [--json] [--log-level debug|warn|error|info|trace]
[--broker-id <value> | -b <value>] [-v <value>]
FLAGS
-b, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-n, --name=<value> (required) The name of the ACL Profile.
-t, --topic=<value> (required) The share name for the exception. May include wildcards.
-v, --msg-vpn-name=<value> The name of the Message VPN.
-x, --syntax=<option> (required) The syntax of the share name.
<options: smf|mqtt>
--broker-id=<value> Stored broker identifier. If not provided, uses the default broker.
GLOBAL FLAGS
--json Format output as json.
--log-level=<option> [default: info] Specify level for logging.
<options: debug|warn|error|info|trace>
DESCRIPTION
Create a subscribe share name exception for an ACL Profile on a Solace Event Broker.
Adds an exception to the ACL Profile for clients subscribing to specific shared subscriptions. The exception is
expressed as a share name with optional wildcards and must specify the syntax type (smf or mqtt).
EXAMPLES
$ sc broker acl-profile subscribe-share-name-exceptions create --name=myProfile --topic="orders/*" --syntax=smf
$ sc broker acl-profile subscribe-share-name-exceptions create --name=myProfile --topic="devices/+" --syntax=mqttSee code: src/commands/broker/acl-profile/subscribe-share-name-exceptions/create.ts
sc broker acl-profile subscribe-share-name-exceptions delete
Delete a subscribe share name exception from an ACL Profile on a Solace Event Broker.
USAGE
$ sc broker acl-profile subscribe-share-name-exceptions delete -n <value> -x smf|mqtt -t <value> [--json] [--log-level debug|warn|error|info|trace]
[--broker-id <value> | -b <value>] [-v <value>] [--no-prompt]
FLAGS
-b, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-n, --name=<value> (required) The name of the ACL Profile.
-t, --topic=<value> (required) The share name of the exception to delete.
-v, --msg-vpn-name=<value> The name of the Message VPN.
-x, --syntax=<option> (required) The syntax of the share name.
<options: smf|mqtt>
--broker-id=<value> Stored broker identifier. If not provided, uses the default broker.
--no-prompt Skip confirmation prompt and proceed with deletion.
GLOBAL FLAGS
--json Format output as json.
--log-level=<option> [default: info] Specify level for logging.
<options: debug|warn|error|info|trace>
DESCRIPTION
Delete a subscribe share name exception from an ACL Profile on a Solace Event Broker.
Removes the specified subscribe share name exception from the ACL Profile. This is a destructive operation.
By default, a confirmation prompt is shown before deletion. Use --no-prompt to skip confirmation.
EXAMPLES
$ sc broker acl-profile subscribe-share-name-exceptions delete --name=myProfile --topic="orders/*" --syntax=smf
$ sc broker acl-profile subscribe-share-name-exceptions delete --name=myProfile --topic="devices/+" --syntax=mqtt --no-promptSee code: src/commands/broker/acl-profile/subscribe-share-name-exceptions/delete.ts
sc broker acl-profile subscribe-share-name-exceptions list
List subscribe share name exceptions for an ACL Profile from a Solace Event Broker.
USAGE
$ sc broker acl-profile subscribe-share-name-exceptions list -n <value> [--json] [--log-level debug|warn|error|info|trace] [--broker-id <value> | -b
<value>] [-v <value>]
FLAGS
-b, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-n, --name=<value> (required) The name of the ACL Profile.
-v, --msg-vpn-name=<value> The name of the Message VPN.
--broker-id=<value> Stored broker identifier. If not provided, uses the default broker.
GLOBAL FLAGS
--json Format output as json.
--log-level=<option> [default: info] Specify level for logging.
<options: debug|warn|error|info|trace>
DESCRIPTION
List subscribe share name exceptions for an ACL Profile from a Solace Event Broker.
Retrieves and displays all subscribe share name exceptions configured for the specified ACL Profile using the SEMP
Monitor API.
EXAMPLES
$ sc broker acl-profile subscribe-share-name-exceptions list --name=myProfileSee code: src/commands/broker/acl-profile/subscribe-share-name-exceptions/list.ts
sc broker acl-profile subscribe-topic-exceptions create
Create a subscribe topic exception for an ACL Profile on a Solace Event Broker.
USAGE
$ sc broker acl-profile subscribe-topic-exceptions create -n <value> -x smf|mqtt -t <value> [--json] [--log-level debug|warn|error|info|trace]
[--broker-id <value> | -b <value>] [-v <value>]
FLAGS
-b, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-n, --name=<value> (required) The name of the ACL Profile.
-t, --topic=<value> (required) The topic for the exception. May include wildcards.
-v, --msg-vpn-name=<value> The name of the Message VPN.
-x, --syntax=<option> (required) The syntax of the topic.
<options: smf|mqtt>
--broker-id=<value> Stored broker identifier. If not provided, uses the default broker.
GLOBAL FLAGS
--json Format output as json.
--log-level=<option> [default: info] Specify level for logging.
<options: debug|warn|error|info|trace>
DESCRIPTION
Create a subscribe topic exception for an ACL Profile on a Solace Event Broker.
Adds an exception to the ACL Profile for clients subscribing to specific topics. The exception is expressed as a topic
with optional wildcards and must specify the syntax type (smf or mqtt). The creation is synchronized to HA mates and
replication sites via config-sync.
EXAMPLES
$ sc broker acl-profile subscribe-topic-exceptions create --name=myProfile --topic="orders/*/created" --syntax=smf
$ sc broker acl-profile subscribe-topic-exceptions create --name=myProfile --topic="devices/+/telemetry" --syntax=mqttSee code: src/commands/broker/acl-profile/subscribe-topic-exceptions/create.ts
sc broker acl-profile subscribe-topic-exceptions delete
Delete a subscribe topic exception from an ACL Profile on a Solace Event Broker.
USAGE
$ sc broker acl-profile subscribe-topic-exceptions delete -n <value> -x smf|mqtt -t <value> [--json] [--log-level debug|warn|error|info|trace]
[--broker-id <value> | -b <value>] [-v <value>] [--no-prompt]
FLAGS
-b, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-n, --name=<value> (required) The name of the ACL Profile.
-t, --topic=<value> (required) The topic of the exception to delete.
-v, --msg-vpn-name=<value> The name of the Message VPN.
-x, --syntax=<option> (required) The syntax of the topic.
<options: smf|mqtt>
--broker-id=<value> Stored broker identifier. If not provided, uses the default broker.
--no-prompt Skip confirmation prompt and proceed with deletion.
GLOBAL FLAGS
--json Format output as json.
--log-level=<option> [default: info] Specify level for logging.
<options: debug|warn|error|info|trace>
DESCRIPTION
Delete a subscribe topic exception from an ACL Profile on a Solace Event Broker.
Removes the specified subscribe topic exception from the ACL Profile. This is a destructive operation. The deletion is
synchronized to HA mates and replication sites via config-sync.
By default, a confirmation prompt is shown before deletion. Use --no-prompt to skip confirmation.
EXAMPLES
$ sc broker acl-profile subscribe-topic-exceptions delete --name=myProfile --topic="orders/*/created" --syntax=smf
$ sc broker acl-profile subscribe-topic-exceptions delete --name=myProfile --topic="devices/+/telemetry" --syntax=mqtt --no-promptSee code: src/commands/broker/acl-profile/subscribe-topic-exceptions/delete.ts
sc broker acl-profile subscribe-topic-exceptions list
List subscribe topic exceptions for an ACL Profile from a Solace Event Broker.
USAGE
$ sc broker acl-profile subscribe-topic-exceptions list -n <value> [--json] [--log-level debug|warn|error|info|trace] [--broker-id <value> | -b
<value>] [-v <value>]
FLAGS
-b, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-n, --name=<value> (required) The name of the ACL Profile.
-v, --msg-vpn-name=<value> The name of the Message VPN.
--broker-id=<value> Stored broker identifier. If not provided, uses the default broker.
GLOBAL FLAGS
--json Format output as json.
--log-level=<option> [default: info] Specify level for logging.
<options: debug|warn|error|info|trace>
DESCRIPTION
List subscribe topic exceptions for an ACL Profile from a Solace Event Broker.
Retrieves and displays all subscribe topic exceptions configured for the specified ACL Profile using the SEMP Monitor
API.
EXAMPLES
$ sc broker acl-profile subscribe-topic-exceptions list --name=myProfileSee code: src/commands/broker/acl-profile/subscribe-topic-exceptions/list.ts
sc broker acl-profile update
Update an ACL Profile on a Solace Event Broker.
USAGE
$ sc broker acl-profile update -n <value> [--json] [--log-level debug|warn|error|info|trace] [--broker-id <value> | -b
<value>] [-v <value>] [--client-connect-default-action allow|disallow] [--publish-topic-default-action
allow|disallow] [--subscribe-share-name-default-action allow|disallow] [--subscribe-topic-default-action
allow|disallow]
FLAGS
-b, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-n, --name=<value> (required) The name of the ACL Profile to update.
-v, --msg-vpn-name=<value> The name of the Message VPN.
--broker-id=<value> Stored broker identifier. If not provided, uses the default
broker.
--client-connect-default-action=<option> The default action to take when a client using the ACL Profile
connects.
<options: allow|disallow>
--publish-topic-default-action=<option> The default action to take when a client using the ACL Profile
publishes to a topic.
<options: allow|disallow>
--subscribe-share-name-default-action=<option> The default action to take when a client using the ACL Profile
subscribes to a share-name subscription.
<options: allow|disallow>
--subscribe-topic-default-action=<option> The default action to take when a client using the ACL Profile
subscribes to a topic.
<options: allow|disallow>
GLOBAL FLAGS
--json Format output as json.
--log-level=<option> [default: info] Specify level for logging.
<options: debug|warn|error|info|trace>
DESCRIPTION
Update an ACL Profile on a Solace Event Broker.
Any attribute missing from the request will be left unchanged.
EXAMPLES
$ sc broker acl-profile update --name=myProfile --client-connect-default-action=allow
$ sc broker acl-profile update --acl-profile-name=myProfile --publish-topic-default-action=disallowSee code: src/commands/broker/acl-profile/update.ts
sc broker client-profile create
Create a Client Profile on a Solace Event Broker.
USAGE
$ sc broker client-profile create -n <value> [--json] [--log-level debug|warn|error|info|trace] [--broker-id <value> | -b
<value>] [-v <value>] [--allow-bridge-connections-enabled] [--allow-guaranteed-endpoint-create-durability
all|durable|non-durable] [--allow-guaranteed-endpoint-create-enabled] [--allow-guaranteed-msg-receive-enabled]
[--allow-guaranteed-msg-send-enabled] [--allow-shared-subscriptions-enabled] [--allow-transacted-sessions-enabled]
[--api-queue-management-copy-from-on-create-name <value>] [--api-queue-management-copy-from-on-create-template-name
<value>] [--compression-enabled] [--eliding-delay <value>] [--eliding-enabled]
[--tls-allow-downgrade-to-plain-text-enabled]
FLAGS
-b, --broker-name=<value> Stored broker name. If not provided, uses the
default broker.
-n, --name=<value> (required) The name of the client profile to
create.
-v, --msg-vpn-name=<value> The name of the Message VPN.
--[no-]allow-bridge-connections-enabled Enable or disable allowing Bridge clients using
the Client Profile to connect.
--allow-guaranteed-endpoint-create-durability=<option> The types of Queues and Topic Endpoints that
clients can create.
<options: all|durable|non-durable>
--[no-]allow-guaranteed-endpoint-create-enabled Enable or disable allowing clients to create
topic endpoints or queues.
--[no-]allow-guaranteed-msg-receive-enabled Enable or disable allowing clients to receive
guaranteed messages.
--[no-]allow-guaranteed-msg-send-enabled Enable or disable allowing clients to send
guaranteed messages.
--[no-]allow-shared-subscriptions-enabled Enable or disable allowing shared subscriptions.
--[no-]allow-transacted-sessions-enabled Enable or disable allowing clients to establish
transacted sessions.
--api-queue-management-copy-from-on-create-name=<value> The name of a queue to copy settings from when a
new queue is created by a client.
--api-queue-management-copy-from-on-create-template-name=<value> The name of a queue template to copy settings
from when a new queue is created by a client.
--broker-id=<value> Stored broker identifier. If not provided, uses
the default broker.
--[no-]compression-enabled Enable or disable allowing clients to use
compression.
--eliding-delay=<value> The amount of time to delay the delivery of
messages to clients, in milliseconds.
--[no-]eliding-enabled Enable or disable message eliding.
--[no-]tls-allow-downgrade-to-plain-text-enabled Enable or disable allowing a client to downgrade
an encrypted connection to plain text.
GLOBAL FLAGS
--json Format output as json.
--log-level=<option> [default: info] Specify level for logging.
<options: debug|warn|error|info|trace>
DESCRIPTION
Create a Client Profile on a Solace Event Broker.
Any attribute missing from the request will be set to its default value. The creation of instances of this object are
synchronized to HA mates and replication sites via config-sync.
EXAMPLES
$ sc broker client-profile create --name=myProfile
$ sc broker client-profile create --name=myProfile --allow-guaranteed-msg-receive-enabled --compression-enabled --eliding-enabled
$ sc broker client-profile create --name=myProfile --no-allow-guaranteed-msg-send-enabledSee code: src/commands/broker/client-profile/create.ts
sc broker client-profile delete
Delete a Client Profile from a Solace Event Broker.
USAGE
$ sc broker client-profile delete -n <value> [--json] [--log-level debug|warn|error|info|trace] [--broker-id <value> | -b
<value>] [-v <value>] [--no-prompt]
FLAGS
-b, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-n, --name=<value> (required) The name of the client profile to delete.
-v, --msg-vpn-name=<value> The name of the Message VPN.
--broker-id=<value> Stored broker identifier. If not provided, uses the default broker.
--no-prompt Skip confirmation prompt.
GLOBAL FLAGS
--json Format output as json.
--log-level=<option> [default: info] Specify level for logging.
<options: debug|warn|error|info|trace>
DESCRIPTION
Delete a Client Profile from a Solace Event Broker.
Deletes the specified Client Profile from the Message VPN. This action cannot be undone. A confirmation prompt will be
displayed unless --no-prompt is specified.
EXAMPLES
$ sc broker client-profile delete --name=myProfile
$ sc broker client-profile delete --name=myProfile --no-promptSee code: src/commands/broker/client-profile/delete.ts
sc broker client-profile display
Display a Client Profile from a Solace Event Broker.
USAGE
$ sc broker client-profile display -n <value> [--json] [--log-level debug|warn|error|info|trace] [--broker-id <value> | -b
<value>] [-v <value>]
FLAGS
-b, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-n, --name=<value> (required) The name of the client profile to display.
-v, --msg-vpn-name=<value> The name of the Message VPN.
--broker-id=<value> Stored broker identifier. If not provided, uses the default broker.
GLOBAL FLAGS
--json Format output as json.
--log-level=<option> [default: info] Specify level for logging.
<options: debug|warn|error|info|trace>
DESCRIPTION
Display a Client Profile from a Solace Event Broker.
Retrieves and displays detailed information about a specific Client Profile using the SEMP Monitor API.
EXAMPLES
$ sc broker client-profile display --name=myProfileSee code: src/commands/broker/client-profile/display.ts
sc broker client-profile list
List Client Profiles from a Solace Event Broker.
USAGE
$ sc broker client-profile list [--json] [--log-level debug|warn|error|info|trace] [--broker-id <value> | -b <value>] [-v
<value>] [-a] [--count <value>] [-n <value>] [-s <value>]
FLAGS
-a, --all Display all client profiles (auto-pagination).
-b, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-n, --name=<value> Filter client profiles by name. Supports * wildcard.
-s, --select=<value> Comma-separated list of attributes to display (max 10).
-v, --msg-vpn-name=<value> The name of the Message VPN.
--broker-id=<value> Stored broker identifier. If not provided, uses the default broker.
--count=<value> [default: 10] Number of client profiles to display per page.
GLOBAL FLAGS
--json Format output as json.
--log-level=<option> [default: info] Specify level for logging.
<options: debug|warn|error|info|trace>
DESCRIPTION
List Client Profiles from a Solace Event Broker.
Retrieves and displays Client Profiles from the specified Message VPN using the SEMP Monitor API.
Supports filtering by name (with wildcards), custom attribute selection, and pagination.
EXAMPLES
$ sc broker client-profile list
$ sc broker client-profile list --count=20
$ sc broker client-profile list --name="test*"
$ sc broker client-profile list --select=clientProfileName,compressionEnabled,elidingEnabled
$ sc broker client-profile list --all
$ sc broker client-profile list --name="*prod*" --count=5 --allSee code: src/commands/broker/client-profile/list.ts
sc broker client-profile update
Update a Client Profile on a Solace Event Broker.
USAGE
$ sc broker client-profile update -n <value> [--json] [--log-level debug|warn|error|info|trace] [--broker-id <value> | -b
<value>] [-v <value>] [--allow-bridge-connections-enabled] [--allow-guaranteed-endpoint-create-durability
all|durable|non-durable] [--allow-guaranteed-endpoint-create-enabled] [--allow-guaranteed-msg-receive-enabled]
[--allow-guaranteed-msg-send-enabled] [--allow-shared-subscriptions-enabled] [--allow-transacted-sessions-enabled]
[--api-queue-management-copy-from-on-create-name <value>] [--api-queue-management-copy-from-on-create-template-name
<value>] [--compression-enabled] [--eliding-delay <value>] [--eliding-enabled]
[--tls-allow-downgrade-to-plain-text-enabled]
FLAGS
-b, --broker-name=<value> Stored broker name. If not provided, uses the
default broker.
-n, --name=<value> (required) The name of the client profile to
update.
-v, --msg-vpn-name=<value> The name of the Message VPN.
--[no-]allow-bridge-connections-enabled Enable or disable allowing Bridge clients using
the Client Profile to connect.
--allow-guaranteed-endpoint-create-durability=<option> The types of Queues and Topic Endpoints that
clients can create.
<options: all|durable|non-durable>
--[no-]allow-guaranteed-endpoint-create-enabled Enable or disable allowing clients to create
topic endpoints or queues.
--[no-]allow-guaranteed-msg-receive-enabled Enable or disable allowing clients to receive
guaranteed messages.
--[no-]allow-guaranteed-msg-send-enabled Enable or disable allowing clients to send
guaranteed messages.
--[no-]allow-shared-subscriptions-enabled Enable or disable allowing shared subscriptions.
--[no-]allow-transacted-sessions-enabled Enable or disable allowing clients to establish
transacted sessions.
--api-queue-management-copy-from-on-create-name=<value> The name of a queue to copy settings from when a
new queue is created by a client.
--api-queue-management-copy-from-on-create-template-name=<value> The name of a queue template to copy settings
from when a new queue is created by a client.
--broker-id=<value> Stored broker identifier. If not provided, uses
the default broker.
--[no-]compression-enabled Enable or disable allowing clients to use
compression.
--eliding-delay=<value> The amount of time to delay the delivery of
messages to clients, in milliseconds.
--[no-]eliding-enabled Enable or disable message eliding.
--[no-]tls-allow-downgrade-to-plain-text-enabled Enable or disable allowing a client to downgrade
an encrypted connection to plain text.
GLOBAL FLAGS
--json Format output as json.
--log-level=<option> [default: info] Specify level for logging.
<options: debug|warn|error|info|trace>
DESCRIPTION
Update a Client Profile on a Solace Event Broker.
Updates the configuration of an existing Client Profile. Only provided attributes will be updated (PATCH semantics).
The updates are synchronized to HA mates and replication sites via config-sync.
EXAMPLES
$ sc broker client-profile update --name=myProfile --compression-enabled
$ sc broker client-profile update --name=myProfile --no-eliding-enabled
$ sc broker client-profile update --name=myProfile --eliding-delay=100See code: src/commands/broker/client-profile/update.ts
sc broker client-username create
Create a Client Username on a Solace Event Broker.
USAGE
$ sc broker client-username create -u <value> [--json] [--log-level debug|warn|error|info|trace] [--broker-id <value> | -b
<value>] [-v <value>] [--acl-profile-name <value>] [--client-profile-name <value>] [--enabled]
[--guaranteed-endpoint-permission-override-enabled] [--password <value>] [--subscription-manager-enabled]
FLAGS
-b, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-u, --username=<value> (required) The name of the Client Username to create.
-v, --msg-vpn-name=<value> The name of the Message VPN.
--acl-profile-name=<value> The ACL Profile name for authorization.
--broker-id=<value> Stored broker identifier. If not provided, uses the default
broker.
--client-profile-name=<value> The Client Profile name for connection settings.
--enabled Enable the Client Username. When disabled, clients cannot
connect.
--guaranteed-endpoint-permission-override-enabled Enable permission override for guaranteed endpoints.
--password=<value> Password for Client Username authentication.
--subscription-manager-enabled Enable subscription management capability.
GLOBAL FLAGS
--json Format output as json.
--log-level=<option> [default: info] Specify level for logging.
<options: debug|warn|error|info|trace>
DESCRIPTION
Create a Client Username on a Solace Event Broker.
Any attribute missing from the request will be set to its default value. The creation of instances of this object are
synchronized to HA mates and replication sites via config-sync.
A Client Username represents a client that can connect to the broker with specific authentication and authorization
settings.
EXAMPLES
$ sc broker client-username create --username=user1
$ sc broker client-username create --username=user1 --enabled
$ sc broker client-username create --username=user1 --password=secret123 --acl-profile-name=custom-acl --client-profile-name=custom-profile
$ sc broker client-username create --username=admin --enabled --subscription-manager-enabled --guaranteed-endpoint-permission-override-enabledSee code: src/commands/broker/client-username/create.ts
sc broker client-username delete
Delete a Client Username from a Solace Event Broker.
USAGE
$ sc broker client-username delete -u <value> [--json] [--log-level debug|warn|error|info|trace] [--broker-id <value> | -b
<value>] [-v <value>] [--no-prompt]
FLAGS
-b, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-u, --username=<value> (required) The name of the Client Username to delete.
-v, --msg-vpn-name=<value> The name of the Message VPN.
--broker-id=<value> Stored broker identifier. If not provided, uses the default broker.
--no-prompt Skip confirmation prompt and proceed with deletion.
GLOBAL FLAGS
--json Format output as json.
--log-level=<option> [default: info] Specify level for logging.
<options: debug|warn|error|info|trace>
DESCRIPTION
Delete a Client Username from a Solace Event Broker.
Deletes the specified Client Username from the Message VPN. This is a destructive operation that removes the Client
Username. Any clients currently connected with this username will be disconnected.
The deletion is synchronized to HA mates and replication sites via config-sync.
By default, a confirmation prompt is shown before deletion. Use --no-prompt to skip confirmation.
EXAMPLES
$ sc broker client-username delete --username=user1
$ sc broker client-username delete --username=user1 --no-promptSee code: src/commands/broker/client-username/delete.ts
sc broker client-username display
Display Client Username information from a Solace Event Broker.
USAGE
$ sc broker client-username display -u <value> [--json] [--log-level debug|warn|error|info|trace] [--broker-id <value> | -b
<value>] [-v <value>]
FLAGS
-b, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-u, --username=<value> (required) The name of the Client Username to display.
-v, --msg-vpn-name=<value> The name of the Message VPN.
--broker-id=<value> Stored broker identifier. If not provided, uses the default broker.
GLOBAL FLAGS
--json Format output as json.
--log-level=<option> [default: info] Specify level for logging.
<options: debug|warn|error|info|trace>
DESCRIPTION
Display Client Username information from a Solace Event Broker.
Retrieves and displays detailed information about a Client Username using the SEMP Monitor API, including
configuration settings and associated profiles.
EXAMPLES
$ sc broker client-username display --username=user1See code: src/commands/broker/client-username/display.ts
sc broker client-username list
List Client Usernames from a Solace Event Broker.
USAGE
$ sc broker client-username list [--json] [--log-level debug|warn|error|info|trace] [--broker-id <value> | -b <value>] [-v
<value>] [-a] [-c <value>] [-s <value>] [-u <value>]
FLAGS
-a, --all Display all Client Usernames (auto-pagination).
-b, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-c, --count=<value> [default: 10] Number of Client Usernames to display per page.
-s, --select=<value> Comma-separated list of attributes to display (max 10).
-u, --username=<value> Filter Client Usernames by name. Supports * wildcard.
-v, --msg-vpn-name=<value> The name of the Message VPN.
--broker-id=<value> Stored broker identifier. If not provided, uses the default broker.
GLOBAL FLAGS
--json Format output as json.
--log-level=<option> [default: info] Specify level for logging.
<options: debug|warn|error|info|trace>
DESCRIPTION
List Client Usernames from a Solace Event Broker.
Retrieves and displays Client Usernames from the specified Message VPN using the SEMP Monitor API.
Supports filtering by name (with wildcards), custom attribute selection, and pagination.
EXAMPLES
$ sc broker client-username list
$ sc broker client-username list --count=20
$ sc broker client-username list --username="user*"
$ sc broker client-username list --select=clientUsername,enabled,aclProfileName
$ sc broker client-username list --all
$ sc broker client-username list --username="admin*" --count=5 --allSee code: src/commands/broker/client-username/list.ts
sc broker client-username update
Update a Client Username on a Solace Event Broker.
USAGE
$ sc broker client-username update -u <value> [--json] [--log-level debug|warn|error|info|trace] [--broker-id <value> | -b
<value>] [-v <value>] [--acl-profile-name <value>] [--client-profile-name <value>] [--enabled]
[--guaranteed-endpoint-permission-override-enabled] [--password <value>] [--subscription-manager-enabled]
FLAGS
-b, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-u, --username=<value> (required) The name of the Client Username to update.
-v, --msg-vpn-name=<value> The name of the Message VPN.
--acl-profile-name=<value> The ACL Profile name for authorization.
--broker-id=<value> Stored broker identifier. If not provided, uses the default
broker.
--client-profile-name=<value> The Client Profile name for connection settings.
--enabled Enable or disable the Client Username.
--guaranteed-endpoint-permission-override-enabled Enable or disable permission override for guaranteed endpoints.
--password=<value> Update the password for authentication.
--subscription-manager-enabled Enable or disable subscription management capability.
GLOBAL FLAGS
--json Format output as json.
--log-level=<option> [default: info] Specify level for logging.
<options: debug|warn|error|info|trace>
DESCRIPTION
Update a Client Username on a Solace Event Broker.
Any attribute missing from the request will be left unchanged. The update of instances of this object are synchronized
to HA mates and replication sites via config-sync.
Note: Modifying aclProfileName or clientProfileName while enabled may be service impacting as the Client Username will
be temporarily disabled to apply the change.
EXAMPLES
$ sc broker client-username update --username=user1 --enabled
$ sc broker client-username update --username=user1 --acl-profile-name=new-acl
$ sc broker client-username update --username=user1 --password=newPassword123
$ sc broker client-username update --username=admin --subscription-manager-enabled --guaranteed-endpoint-permission-override-enabledSee code: src/commands/broker/client-username/update.ts
sc broker login basic
Authorize the SC CLI to make SEMP API calls to a Solace Event Broker using Basic authentication.
USAGE
$ sc broker login basic -b <value> -p <value> -u <value> [--json] [--log-level debug|warn|error|info|trace] [-v
<value>] [--no-prompt] [-d]
FLAGS
-b, --broker-name=<value> (required) Name/identifier for the broker
-d, --set-default Set this broker as the default
-p, --semp-port=<value> (required) SEMP port number (1-65535)
-u, --semp-url=<value> (required) SEMP endpoint URL (must start with http:// or https://)
-v, --msg-vpn-name=<value> Default Message VPN name for this broker (used when --msg-vpn-name is not supplied to a
command)
--no-prompt Read credentials from SC_SEMP_USERNAME and SC_SEMP_PASSWORD environment variables
GLOBAL FLAGS
--json Format output as json.
--log-level=<option> [default: info] Specify level for logging.
<options: debug|warn|error|info|trace>
DESCRIPTION
Authorize the SC CLI to make SEMP API calls to a Solace Event Broker using Basic authentication.
Stores broker credentials securely using encrypted local storage.
Credentials are base64-encoded and encrypted before storage.
If a broker with the same name already exists, you'll be prompted to overwrite.
EXAMPLES
$ sc broker login basic --broker-name=dev-broker --semp-url=https://localhost --semp-port=8080
$ sc broker login basic --broker-name=dev-broker --semp-url=https://localhost --semp-port=8080 --msg-vpn-name=default
$ sc broker login basic --broker-name=ci-broker --semp-url=http://192.168.1.100 --semp-port=8080 --no-prompt
$ sc broker login basic --broker-name=default-broker --semp-url=https://broker.example.com --semp-port=943 --set-defaultSee code: src/commands/broker/login/basic.ts
sc broker login cloud
Authorize the SC CLI to make SEMP API calls to a Solace Cloud Event Broker using Basic Authentication.
USAGE
$ sc broker login cloud -b <value> [--json] [--log-level debug|warn|error|info|trace] [--no-prompt] [-o <value>] [-d]
FLAGS
-b, --broker-name=<value> (required) Name of the broker in Solace Cloud
-d, --set-default Set this broker as the default
-o, --org-name=<value> Solace Cloud organization name (uses default org if not specified)
--no-prompt Skip confirmation prompts for overwriting existing broker
GLOBAL FLAGS
--json Format output as json.
--log-level=<option> [default: info] Specify level for logging.
<options: debug|warn|error|info|trace>
DESCRIPTION
Authorize the SC CLI to make SEMP API calls to a Solace Cloud Event Broker using Basic Authentication.
Retrieves SEMP credentials automatically from Event Broker Service using Solace Cloud REST API.
Requires prior authentication to Solace Cloud (sc:account:login).
The command will:
1. Look up the broker by name in your Solace Cloud organization
2. Retrieve SEMP endpoint details and credentials from Cloud API
3. Store encrypted broker credentials locally for future use
Required Cloud API permissions: Read access to Event Broker Services
EXAMPLES
$ sc broker login cloud --broker-name=production-broker
$ sc broker login cloud --broker-name=dev-broker --set-default
$ sc broker login cloud --