@dishantlangayan/solace-cloud-cli
v0.5.2
Published
The Solace Cloud CLI
Readme
@dishantlangayan/solace-cloud-cli
The Solace Cloud CLI
Overview
The Solace Cloud CLI is a command line interface that simplifies deployment, configuration, and automation when working with your Solace Cloud org and services.
Use it to:
- Create and manage Environments
- Create and manage Mission Control and Event Broker Services
- Script deployment of Solace Cloud resources in your org
The CLI is built using the oclif framework that allows for plugin based development where users can add and extend the functionality of this CLI. For example, a new command can be added that can create and manage VPN Bridges, which uses the SEMP API to provision the bridges across two Message VPN on the same broker or across two brokers.
[!TIP] For more information see the Solace Cloud CLI Documentation
Usage
$ npm install -g @dishantlangayan/solace-cloud-cli
$ sc COMMAND
running command...
$ sc (--version)
@dishantlangayan/solace-cloud-cli/0.5.2 linux-x64 node-v25.9.0
$ sc --help [COMMAND]
USAGE
$ sc COMMAND
...Authenticating with Solace Cloud
To use any commands you will need to configure an Access Token in Solace Cloud Console with the appropriate permissions first. You can then authorize the CLI to use your Solace Cloud by setting the access token using the account:login command:
sc account login --org <Your Org Name>Refer to the Solace Cloud CLI documention for more information.
Resources
This is not an officially supported Solace product.
For more information try these resources:
- Solace Cloud CLI Documentation
- Ask the Solace Community
- The Solace Developer Portal website at: https://solace.dev
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 account listsc account loginsc account logoutsc autocomplete [SHELL]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 login basicsc broker login cloudsc broker login listsc broker logoutsc broker queue createsc broker queue deletesc broker queue displaysc broker queue listsc broker queue subscriptions createsc broker queue subscriptions deletesc broker queue updatesc commandssc help [COMMAND]sc missionctrl broker createsc missionctrl broker deletesc missionctrl broker displaysc missionctrl broker listsc missionctrl broker opstatussc missionctrl broker statesc missionctrl broker updatesc platform env createsc platform env deletesc platform env displaysc platform env listsc platform env updatesc pluginssc plugins add PLUGINsc plugins:inspect PLUGIN...sc plugins install PLUGINsc plugins link PATHsc plugins remove [PLUGIN]sc plugins resetsc plugins uninstall [PLUGIN]sc plugins unlink [PLUGIN]sc plugins updatesc searchsc update [CHANNEL]sc versionsc which
sc account list
List all authenticated organizations.
USAGE
$ sc account list [--json] [--log-level debug|warn|error|info|trace]
GLOBAL FLAGS
--json Format output as json.
--log-level=<option> [default: info] Specify level for logging.
<options: debug|warn|error|info|trace>
DESCRIPTION
List all authenticated organizations.
Displays organizations you have logged into, including their aliases and which one is set as default.
EXAMPLES
$ sc account listSee code: src/commands/account/list.ts
sc account login
Login to a Solace Cloud organization.
USAGE
$ sc account login -o <value> [--json] [--log-level debug|warn|error|info|trace] [-a <value>] [--api-version
<value>] [--base-url <value>] [--no-prompt] [-d]
FLAGS
-a, --alias=<value> Alias name for this organization (allows storing multiple tokens for the same org with
different aliases)
-d, --set-default Set this organization as the default
-o, --org=<value> (required) Organization ID to login to
--api-version=<value> API version to use (optional)
--base-url=<value> Custom base URL for Solace Cloud API (optional)
--no-prompt Read access token from SC_ACCESS_TOKEN environment variable instead of prompting
GLOBAL FLAGS
--json Format output as json.
--log-level=<option> [default: info] Specify level for logging.
<options: debug|warn|error|info|trace>
DESCRIPTION
Login to a Solace Cloud organization.
Stores organization credentials securely using OS keychain.
The access token is encrypted and stored locally.
You can store multiple access tokens for the same organization by using unique aliases.
Without an alias, only one token per organization ID is allowed.
Required token permissions: Varies by operations you intend to perform
EXAMPLES
$ sc account login --org=my-org-id
$ sc account login --org=my-org-id --alias=production
$ sc account login --org=my-org-id --alias=staging
$ sc account login --org=my-org-id --set-default
$ sc account login --org=my-org-id --no-prompt
$ sc account login --org=my-org-id --base-url=https://api.custom.solace.cloudSee code: src/commands/account/login.ts
sc account logout
Logout from authenticated organizations.
USAGE
$ sc account logout [--json] [--log-level debug|warn|error|info|trace] [-a] [--no-prompt] [-o <value>]
FLAGS
-a, --all Logout of all organizations
-o, --org=<value> Organization ID or alias to logout from
--no-prompt Skip confirmation prompt and assume Yes
GLOBAL FLAGS
--json Format output as json.
--log-level=<option> [default: info] Specify level for logging.
<options: debug|warn|error|info|trace>
DESCRIPTION
Logout from authenticated organizations.
Removes locally stored organization credentials and access tokens.
Interactive mode allows selection with arrow keys and spacebar.
EXAMPLES
$ sc account logout
$ sc account logout --org=my-org-id
$ sc account logout --org=production
$ sc account logout --all
$ sc account logout --org=my-org-id --no-promptSee code: src/commands/account/logout.ts
sc autocomplete [SHELL]
Display autocomplete installation instructions.
USAGE
$ sc autocomplete [SHELL] [-r]
ARGUMENTS
[SHELL] (zsh|bash|powershell) Shell type
FLAGS
-r, --refresh-cache Refresh cache (ignores displaying instructions)
DESCRIPTION
Display autocomplete installation instructions.
EXAMPLES
$ sc autocomplete
$ sc autocomplete bash
$ sc autocomplete zsh
$ sc autocomplete powershell
$ sc autocomplete --refresh-cacheSee code: @oclif/plugin-autocomplete
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> -c <value> [--json] [--log-level debug|warn|error|info|trace] [-b <value> | -n
<value>] [-v <value>]
FLAGS
-a, --acl-profile-name=<value> (required) The name of the ACL Profile.
-b, --broker-id=<value> Stored broker identifier. If not provided, uses the default broker.
-c, --client-connect-exception-address=<value> (required) The IP address/netmask of the client connect exception in
CIDR form (e.g., 192.168.1.0/24).
-n, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-v, --msg-vpn-name=<value> The name of the Message VPN.
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. The creation is synchronized to HA mates and replication
sites via config-sync.
EXAMPLES
$ sc broker acl-profile client-connect-exceptions create --acl-profile-name=myProfile --client-connect-exception-address=192.168.1.0/24
$ sc broker acl-profile client-connect-exceptions create --broker-name=dev-broker --acl-profile-name=myProfile --msg-vpn-name=default --client-connect-exception-address=10.0.0.0/8See code: @dishantlangayan/sc-plugin-broker
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> -c <value> [--json] [--log-level debug|warn|error|info|trace] [-b <value> | -n
<value>] [-v <value>] [--no-prompt]
FLAGS
-a, --acl-profile-name=<value> (required) The name of the ACL Profile.
-b, --broker-id=<value> Stored broker identifier. If not provided, uses the default broker.
-c, --client-connect-exception-address=<value> (required) The IP address/netmask of the client connect exception to
delete in CIDR form.
-n, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-v, --msg-vpn-name=<value> The name of the Message VPN.
--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. 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 client-connect-exceptions delete --acl-profile-name=myProfile --client-connect-exception-address=192.168.1.0/24
$ sc broker acl-profile client-connect-exceptions delete --acl-profile-name=myProfile --client-connect-exception-address=10.0.0.0/8 --no-prompt
$ sc broker acl-profile client-connect-exceptions delete --broker-name=dev-broker --acl-profile-name=myProfile --msg-vpn-name=default --client-connect-exception-address=172.16.0.0/12 --no-promptSee code: @dishantlangayan/sc-plugin-broker
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 -a <value> [--json] [--log-level debug|warn|error|info|trace] [-b <value> | -n <value>] [-v
<value>]
FLAGS
-a, --acl-profile-name=<value> (required) The name of the ACL Profile.
-b, --broker-id=<value> Stored broker identifier. If not provided, uses the default broker.
-n, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-v, --msg-vpn-name=<value> The name of the Message VPN.
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 --acl-profile-name=myProfile
$ sc broker acl-profile client-connect-exceptions list --broker-name=dev-broker --acl-profile-name=myProfile --msg-vpn-name=defaultSee code: @dishantlangayan/sc-plugin-broker
sc broker acl-profile create
Create an ACL Profile on a Solace Event Broker.
USAGE
$ sc broker acl-profile create -a <value> [--json] [--log-level debug|warn|error|info|trace] [-b <value> | -n <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
-a, --acl-profile-name=<value> (required) The name of the ACL Profile to create.
-b, --broker-id=<value> Stored broker identifier. If not provided, uses the default
broker.
-n, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-v, --msg-vpn-name=<value> The name of the Message VPN.
--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.
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 acl-profile create --broker-name=dev-broker --acl-profile-name=myProfile --msg-vpn-name=default
$ sc broker acl-profile create --broker-id=dev-broker --acl-profile-name=myProfile --msg-vpn-name=default --client-connect-default-action=allow
$ sc broker acl-profile create --broker-name=dev-broker --acl-profile-name=myProfile --msg-vpn-name=default --publish-topic-default-action=allow --subscribe-topic-default-action=allow
$ sc broker acl-profile create --acl-profile-name=myProfileSee code: @dishantlangayan/sc-plugin-broker
sc broker acl-profile delete
Delete an ACL Profile from a Solace Event Broker.
USAGE
$ sc broker acl-profile delete -a <value> [--json] [--log-level debug|warn|error|info|trace] [-b <value> | -n <value>] [-v
<value>] [--no-prompt]
FLAGS
-a, --acl-profile-name=<value> (required) The name of the ACL Profile to delete.
-b, --broker-id=<value> Stored broker identifier. If not provided, uses the default broker.
-n, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-v, --msg-vpn-name=<value> The name of the Message VPN.
--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.
Deletes the specified ACL Profile from the Message VPN. 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.
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 delete --acl-profile-name=myProfile --msg-vpn-name=default
$ sc broker acl-profile delete --broker-name=dev-broker --acl-profile-name=myProfile
$ sc broker acl-profile delete --acl-profile-name=myProfile --no-prompt
$ sc broker acl-profile delete --broker-id=prod --acl-profile-name=tempProfile --msg-vpn-name=production --no-promptSee code: @dishantlangayan/sc-plugin-broker
sc broker acl-profile display
Display ACL Profile information from a Solace Event Broker.
USAGE
$ sc broker acl-profile display -a <value> [--json] [--log-level debug|warn|error|info|trace] [-b <value> | -n <value>] [-v
<value>]
FLAGS
-a, --acl-profile-name=<value> (required) The name of the ACL Profile to display.
-b, --broker-id=<value> Stored broker identifier. If not provided, uses the default broker.
-n, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-v, --msg-vpn-name=<value> The name of the Message VPN.
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 --acl-profile-name=myProfile --msg-vpn-name=default
$ sc broker acl-profile display --broker-name=dev-broker --acl-profile-name=myProfile --msg-vpn-name=default
$ sc broker acl-profile display --acl-profile-name=myProfileSee code: @dishantlangayan/sc-plugin-broker
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] [-b <value> | -n <value>] [-v <value>]
[--acl-profile-name <value>] [-a] [-c <value>] [-s <value>]
FLAGS
-a, --all Display all ACL profiles (auto-pagination).
-b, --broker-id=<value> Stored broker identifier. If not provided, uses the default broker.
-c, --count=<value> [default: 10] Number of ACL profiles to display per page.
-n, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-s, --select=<value> Comma-separated list of attributes to display (max 10).
-v, --msg-vpn-name=<value> The name of the Message VPN.
--acl-profile-name=<value> Filter ACL profiles by name. Supports * wildcard.
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 --acl-profile-name="client*"
$ sc broker acl-profile list --select=aclProfileName,clientConnectDefaultAction,publishTopicDefaultAction
$ sc broker acl-profile list --all
$ sc broker acl-profile list --acl-profile-name="*custom*" --count=5 --allSee code: @dishantlangayan/sc-plugin-broker
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 -a <value> -p <value> -s smf|mqtt [--json] [--log-level debug|warn|error|info|trace] [-b
<value> | -n <value>] [-v <value>]
FLAGS
-a, --acl-profile-name=<value> (required) The name of the ACL Profile.
-b, --broker-id=<value> Stored broker identifier. If not provided, uses the default broker.
-n, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-p, --publish-topic-exception=<value> (required) The topic for the exception. May include wildcards.
-s, --syntax=<option> (required) The syntax of the topic.
<options: smf|mqtt>
-v, --msg-vpn-name=<value> The name of the Message VPN.
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). The creation is synchronized to HA mates and
replication sites via config-sync.
EXAMPLES
$ sc broker acl-profile publish-topic-exceptions create --acl-profile-name=myProfile --publish-topic-exception="orders/*/created" --syntax=smf
$ sc broker acl-profile publish-topic-exceptions create --broker-name=dev-broker --acl-profile-name=myProfile --msg-vpn-name=default --publish-topic-exception="devices/+/telemetry" --syntax=mqttSee code: @dishantlangayan/sc-plugin-broker
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 -a <value> -p <value> -s smf|mqtt [--json] [--log-level debug|warn|error|info|trace] [-b
<value> | -n <value>] [-v <value>] [--no-prompt]
FLAGS
-a, --acl-profile-name=<value> (required) The name of the ACL Profile.
-b, --broker-id=<value> Stored broker identifier. If not provided, uses the default broker.
-n, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-p, --publish-topic-exception=<value> (required) The topic of the exception to delete.
-s, --syntax=<option> (required) The syntax of the topic.
<options: smf|mqtt>
-v, --msg-vpn-name=<value> The name of the Message VPN.
--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. 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 publish-topic-exceptions delete --acl-profile-name=myProfile --publish-topic-exception="orders/*/created" --syntax=smf
$ sc broker acl-profile publish-topic-exceptions delete --acl-profile-name=myProfile --publish-topic-exception="devices/+/telemetry" --syntax=mqtt --no-prompt
$ sc broker acl-profile publish-topic-exceptions delete --broker-name=dev-broker --acl-profile-name=myProfile --msg-vpn-name=default --publish-topic-exception="test/topic" --syntax=smf --no-promptSee code: @dishantlangayan/sc-plugin-broker
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 -a <value> [--json] [--log-level debug|warn|error|info|trace] [-b <value> | -n <value>] [-v
<value>]
FLAGS
-a, --acl-profile-name=<value> (required) The name of the ACL Profile.
-b, --broker-id=<value> Stored broker identifier. If not provided, uses the default broker.
-n, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-v, --msg-vpn-name=<value> The name of the Message VPN.
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 --acl-profile-name=myProfile
$ sc broker acl-profile publish-topic-exceptions list --broker-name=dev-broker --acl-profile-name=myProfile --msg-vpn-name=defaultSee code: @dishantlangayan/sc-plugin-broker
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 -a <value> -s <value> -x smf|mqtt [--json] [--log-level debug|warn|error|info|trace] [-b
<value> | -n <value>] [-v <value>]
FLAGS
-a, --acl-profile-name=<value> (required) The name of the ACL Profile.
-b, --broker-id=<value> Stored broker identifier. If not provided, uses the default broker.
-n, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-s, --subscribe-share-name-exception=<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>
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). The creation is
synchronized to HA mates and replication sites via config-sync.
EXAMPLES
$ sc broker acl-profile subscribe-share-name-exceptions create --acl-profile-name=myProfile --subscribe-share-name-exception="orders/*" --syntax=smf
$ sc broker acl-profile subscribe-share-name-exceptions create --broker-name=dev-broker --acl-profile-name=myProfile --msg-vpn-name=default --subscribe-share-name-exception="devices/+" --syntax=mqttSee code: @dishantlangayan/sc-plugin-broker
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 -a <value> -s <value> -x smf|mqtt [--json] [--log-level debug|warn|error|info|trace] [-b
<value> | -n <value>] [-v <value>] [--no-prompt]
FLAGS
-a, --acl-profile-name=<value> (required) The name of the ACL Profile.
-b, --broker-id=<value> Stored broker identifier. If not provided, uses the default broker.
-n, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-s, --subscribe-share-name-exception=<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>
--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. 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-share-name-exceptions delete --acl-profile-name=myProfile --subscribe-share-name-exception="orders/*" --syntax=smf
$ sc broker acl-profile subscribe-share-name-exceptions delete --acl-profile-name=myProfile --subscribe-share-name-exception="devices/+" --syntax=mqtt --no-prompt
$ sc broker acl-profile subscribe-share-name-exceptions delete --broker-name=dev-broker --acl-profile-name=myProfile --msg-vpn-name=default --subscribe-share-name-exception="test/share" --syntax=smf --no-promptSee code: @dishantlangayan/sc-plugin-broker
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 -a <value> [--json] [--log-level debug|warn|error|info|trace] [-b <value> | -n <value>] [-v
<value>]
FLAGS
-a, --acl-profile-name=<value> (required) The name of the ACL Profile.
-b, --broker-id=<value> Stored broker identifier. If not provided, uses the default broker.
-n, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-v, --msg-vpn-name=<value> The name of the Message VPN.
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 --acl-profile-name=myProfile
$ sc broker acl-profile subscribe-share-name-exceptions list --broker-name=dev-broker --acl-profile-name=myProfile --msg-vpn-name=defaultSee code: @dishantlangayan/sc-plugin-broker
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 -a <value> -s <value> -x smf|mqtt [--json] [--log-level debug|warn|error|info|trace] [-b
<value> | -n <value>] [-v <value>]
FLAGS
-a, --acl-profile-name=<value> (required) The name of the ACL Profile.
-b, --broker-id=<value> Stored broker identifier. If not provided, uses the default broker.
-n, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-s, --subscribe-topic-exception=<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>
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 --acl-profile-name=myProfile --subscribe-topic-exception="orders/*/created" --syntax=smf
$ sc broker acl-profile subscribe-topic-exceptions create --broker-name=dev-broker --acl-profile-name=myProfile --msg-vpn-name=default --subscribe-topic-exception="devices/+/telemetry" --syntax=mqttSee code: @dishantlangayan/sc-plugin-broker
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 -a <value> -s <value> -x smf|mqtt [--json] [--log-level debug|warn|error|info|trace] [-b
<value> | -n <value>] [-v <value>] [--no-prompt]
FLAGS
-a, --acl-profile-name=<value> (required) The name of the ACL Profile.
-b, --broker-id=<value> Stored broker identifier. If not provided, uses the default broker.
-n, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-s, --subscribe-topic-exception=<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>
--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 --acl-profile-name=myProfile --subscribe-topic-exception="orders/*/created" --syntax=smf
$ sc broker acl-profile subscribe-topic-exceptions delete --acl-profile-name=myProfile --subscribe-topic-exception="devices/+/telemetry" --syntax=mqtt --no-prompt
$ sc broker acl-profile subscribe-topic-exceptions delete --broker-name=dev-broker --acl-profile-name=myProfile --msg-vpn-name=default --subscribe-topic-exception="test/topic" --syntax=smf --no-promptSee code: @dishantlangayan/sc-plugin-broker
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 -a <value> [--json] [--log-level debug|warn|error|info|trace] [-b <value> | -n <value>] [-v
<value>]
FLAGS
-a, --acl-profile-name=<value> (required) The name of the ACL Profile.
-b, --broker-id=<value> Stored broker identifier. If not provided, uses the default broker.
-n, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-v, --msg-vpn-name=<value> The name of the Message VPN.
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 --acl-profile-name=myProfile
$ sc broker acl-profile subscribe-topic-exceptions list --broker-name=dev-broker --acl-profile-name=myProfile --msg-vpn-name=defaultSee code: @dishantlangayan/sc-plugin-broker
sc broker acl-profile update
Update an ACL Profile on a Solace Event Broker.
USAGE
$ sc broker acl-profile update -a <value> [--json] [--log-level debug|warn|error|info|trace] [-b <value> | -n <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
-a, --acl-profile-name=<value> (required) The name of the ACL Profile to update.
-b, --broker-id=<value> Stored broker identifier. If not provided, uses the default
broker.
-n, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-v, --msg-vpn-name=<value> The name of the Message VPN.
--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. The update of instances of this object are synchronized
to HA mates and replication sites via config-sync.
EXAMPLES
$ sc broker acl-profile update --broker-name=dev-broker --acl-profile-name=myProfile --msg-vpn-name=default --client-connect-default-action=allow
$ sc broker acl-profile update --broker-id=dev-broker --acl-profile-name=myProfile --msg-vpn-name=default --publish-topic-default-action=allow
$ sc broker acl-profile update --broker-name=dev-broker --acl-profile-name=myProfile --msg-vpn-name=default --subscribe-topic-default-action=allow --subscribe-share-name-default-action=disallow
$ sc broker acl-profile update --acl-profile-name=myProfile --publish-topic-default-action=disallowSee code: @dishantlangayan/sc-plugin-broker
sc broker client-profile create
Create a Client Profile on a Solace Event Broker.
USAGE
$ sc broker client-profile create -c <value> [--json] [--log-level debug|warn|error|info|trace] [-b <value> | -n <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-id=<value> Stored broker identifier. If not provided, uses
the default broker.
-c, --client-profile-name=<value> (required) The name of the client profile to
create.
-n, --broker-name=<value> Stored broker name. If not provided, uses the
default broker.
-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.
--[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 --broker-name=dev-broker --client-profile-name=myProfile --msg-vpn-name=default
$ sc broker client-profile create --broker-id=dev-broker --client-profile-name=myProfile --msg-vpn-name=default --allow-guaranteed-msg-receive-enabled
$ sc broker client-profile create --broker-name=dev-broker --client-profile-name=myProfile --msg-vpn-name=default --compression-enabled --eliding-enabled
$ sc broker client-profile create --client-profile-name=myProfileSee code: @dishantlangayan/sc-plugin-broker
sc broker client-profile delete
Delete a Client Profile from a Solace Event Broker.
USAGE
$ sc broker client-profile delete -c <value> [--json] [--log-level debug|warn|error|info|trace] [-b <value> | -n <value>] [-v
<value>] [--no-prompt]
FLAGS
-b, --broker-id=<value> Stored broker identifier. If not provided, uses the default broker.
-c, --client-profile-name=<value> (required) The name of the client profile to delete.
-n, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-v, --msg-vpn-name=<value> The name of the Message VPN.
--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 --broker-name=dev-broker --client-profile-name=myProfile --msg-vpn-name=default
$ sc broker client-profile delete --broker-id=dev-broker --client-profile-name=myProfile --msg-vpn-name=default --no-prompt
$ sc broker client-profile delete --client-profile-name=myProfile
$ sc broker client-profile delete --client-profile-name=myProfile --no-promptSee code: @dishantlangayan/sc-plugin-broker
sc broker client-profile display
Display a Client Profile from a Solace Event Broker.
USAGE
$ sc broker client-profile display -c <value> [--json] [--log-level debug|warn|error|info|trace] [-b <value> | -n <value>] [-v
<value>]
FLAGS
-b, --broker-id=<value> Stored broker identifier. If not provided, uses the default broker.
-c, --client-profile-name=<value> (required) The name of the client profile to display.
-n, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-v, --msg-vpn-name=<value> The name of the Message VPN.
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 --broker-name=dev-broker --client-profile-name=myProfile --msg-vpn-name=default
$ sc broker client-profile display --broker-id=dev-broker --client-profile-name=myProfile --msg-vpn-name=default
$ sc broker client-profile display --client-profile-name=myProfileSee code: @dishantlangayan/sc-plugin-broker
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] [-b <value> | -n <value>] [-v <value>] [-a]
[-c <value>] [--count <value>] [-s <value>]
FLAGS
-a, --all Display all client profiles (auto-pagination).
-b, --broker-id=<value> Stored broker identifier. If not provided, uses the default broker.
-c, --client-profile-name=<value> Filter client profiles by name. Supports * wildcard.
-n, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-s, --select=<value> Comma-separated list of attributes to display (max 10).
-v, --msg-vpn-name=<value> The name of the Message VPN.
--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 --client-profile-name="test*"
$ sc broker client-profile list --select=clientProfileName,compressionEnabled,elidingEnabled
$ sc broker client-profile list --all
$ sc broker client-profile list --client-profile-name="*prod*" --count=5 --allSee code: @dishantlangayan/sc-plugin-broker
sc broker client-profile update
Update a Client Profile on a Solace Event Broker.
USAGE
$ sc broker client-profile update -c <value> [--json] [--log-level debug|warn|error|info|trace] [-b <value> | -n <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-id=<value> Stored broker identifier. If not provided, uses
the default broker.
-c, --client-profile-name=<value> (required) The name of the client profile to
update.
-n, --broker-name=<value> Stored broker name. If not provided, uses the
default broker.
-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.
--[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 --broker-name=dev-broker --client-profile-name=myProfile --msg-vpn-name=default --compression-enabled
$ sc broker client-profile update --broker-id=dev-broker --client-profile-name=myProfile --msg-vpn-name=default --no-eliding-enabled
$ sc broker client-profile update --broker-name=dev-broker --client-profile-name=myProfile --msg-vpn-name=default --allow-guaranteed-msg-send-enabled --allow-guaranteed-msg-receive-enabled
$ sc broker client-profile update --client-profile-name=myProfile --eliding-delay=100See code: @dishantlangayan/sc-plugin-broker
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]
[--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://)
--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=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: @dishantlangayan/sc-plugin-broker
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: debu