The Solace Cloud CLI
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
$ npm install -g @dishantlangayan/solace-cloud-cli
$ sc COMMAND
running command...
$ sc (--version)
@dishantlangayan/solace-cloud-cli/0.5.3 linux-x64 node-v22.23.1
$ sc --help [COMMAND]
USAGE
$ sc COMMAND
...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.
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
Contributions are encouraged! Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
See the list of contributors who participated in this project.
See the LICENSE file for details.
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 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 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 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
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 list
See code: src/commands/account/list.ts
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.cloud
See code: src/commands/account/login.ts
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-prompt
See code: src/commands/account/logout.ts
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-cache
See code: @oclif/plugin-autocomplete
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/24
See code: @dishantlangayan/sc-plugin-broker
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-prompt
See code: @dishantlangayan/sc-plugin-broker
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=myProfile
See code: @dishantlangayan/sc-plugin-broker
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=allow
See code: @dishantlangayan/sc-plugin-broker
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-prompt
See code: @dishantlangayan/sc-plugin-broker
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=myProfile
See code: @dishantlangayan/sc-plugin-broker
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 --all
See code: @dishantlangayan/sc-plugin-broker
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=mqtt
See code: @dishantlangayan/sc-plugin-broker
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-prompt
See code: @dishantlangayan/sc-plugin-broker
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=myProfile
See code: @dishantlangayan/sc-plugin-broker
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=mqtt
See code: @dishantlangayan/sc-plugin-broker
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-prompt
See code: @dishantlangayan/sc-plugin-broker
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=myProfile
See code: @dishantlangayan/sc-plugin-broker
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=mqtt
See code: @dishantlangayan/sc-plugin-broker
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-prompt
See code: @dishantlangayan/sc-plugin-broker
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=myProfile
See code: @dishantlangayan/sc-plugin-broker
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=disallow
See code: @dishantlangayan/sc-plugin-broker
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] [--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.
-c, --client-profile-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 --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=myProfile
See code: @dishantlangayan/sc-plugin-broker
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] [--broker-id <value> | -b
<value>] [-v <value>] [--no-prompt]
FLAGS
-b, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-c, --client-profile-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 --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-prompt
See code: @dishantlangayan/sc-plugin-broker
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] [--broker-id <value> | -b
<value>] [-v <value>]
FLAGS
-b, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-c, --client-profile-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 --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=myProfile
See code: @dishantlangayan/sc-plugin-broker
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] [-c <value>] [--count <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.
-c, --client-profile-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 --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 --all
See code: @dishantlangayan/sc-plugin-broker
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] [--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.
-c, --client-profile-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 --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=100
See code: @dishantlangayan/sc-plugin-broker
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, --client-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 --client-username=user1 --msg-vpn-name=default
$ sc broker client-username create --broker-name=dev-broker --client-username=user1 --enabled
$ sc broker client-username create --client-username=user1 --password=secret123 --acl-profile-name=custom-acl --client-profile-name=custom-profile
$ sc broker client-username create --client-username=admin --enabled --subscription-manager-enabled --guaranteed-endpoint-permission-override-enabled
See code: @dishantlangayan/sc-plugin-broker
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, --client-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 --client-username=user1 --msg-vpn-name=default
$ sc broker client-username delete --broker-name=dev-broker --client-username=user1
$ sc broker client-username delete --client-username=user1 --no-prompt
$ sc broker client-username delete --broker-id=prod --client-username=tempUser --msg-vpn-name=production --no-prompt
See code: @dishantlangayan/sc-plugin-broker
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, --client-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 --client-username=user1 --msg-vpn-name=default
$ sc broker client-username display --broker-name=dev-broker --client-username=user1
$ sc broker client-username display --client-username=admin
See code: @dishantlangayan/sc-plugin-broker
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] [--client-username <value>] [-c <value>] [-s <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).
-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-username=<value> Filter Client Usernames 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 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 --client-username="user*"
$ sc broker client-username list --select=clientUsername,enabled,aclProfileName
$ sc broker client-username list --all
$ sc broker client-username list --client-username="admin*" --count=5 --all
See code: @dishantlangayan/sc-plugin-broker
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, --client-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 --client-username=user1 --enabled
$ sc broker client-username update --broker-name=dev-broker --client-username=user1 --acl-profile-name=new-acl
$ sc broker client-username update --client-username=user1 --password=newPassword123
$ sc broker client-username update --client-username=admin --subscription-manager-enabled --guaranteed-endpoint-permission-override-enabled
See code: @dishantlangayan/sc-plugin-broker
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-default
See code: @dishantlangayan/sc-plugin-broker
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 --broker-name=staging-broker --org-name=my-org
$ sc broker login cloud --broker-name=prod --no-prompt
See code: @dishantlangayan/sc-plugin-broker
List all authenticated brokers.
USAGE
$ sc broker login 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 brokers.
Displays brokers you have logged into, including their authentication type, SEMP endpoints, and which one is set as
default.
EXAMPLES
$ sc broker login list
See code: @dishantlangayan/sc-plugin-broker
Logout from authenticated brokers.
USAGE
$ sc broker logout [--json] [--log-level debug|warn|error|info|trace] [-a | -b <value>] [--no-prompt]
FLAGS
-a, --all Logout from all brokers
-b, --broker-name=<value> Broker name 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 brokers.
Removes locally stored broker credentials.
Interactive mode allows selection with arrow keys and spacebar.
EXAMPLES
$ sc broker logout
$ sc broker logout --broker-name=dev-broker
$ sc broker logout --all
$ sc broker logout --broker-name=prod --no-prompt
See code: @dishantlangayan/sc-plugin-broker
Create a Queue Template on a Solace Event Broker.
USAGE
$ sc broker queue-template create -t <value> [--json] [--log-level debug|warn|error|info|trace] [--broker-id <value> | -b
<value>] [-v <value>] [-a exclusive|non-exclusive] [--dead-msg-queue <value>] [--durability-override
none|non-durable|durable] [--max-bind-count <value>] [--max-delivered-unacked-msgs-per-flow <value>] [--max-msg-size
<value>] [-s <value>] [--max-redelivery-count <value>] [--max-ttl <value>] [-p
consume|delete|modify-topic|no-access|read-only] [-f <value>]
FLAGS
-a, --access-type=<option> The access type for queues created from this template.
<options: exclusive|non-exclusive>
-b, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-f, --queue-name-filter=<value> A wildcarded pattern to match queue names for applying this
template. Supports * and > wildcards.
-p, --permission=<option> The permission level for all consumers of queues created from this
template, excluding the owner.
<options: consume|delete|modify-topic|no-access|read-only>
-s, --max-msg-spool-usage=<value> The maximum message spool usage allowed by queues created from this
template, in megabytes (MB).
-t, --queue-template-name=<value> (required) The name of the queue template 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.
--dead-msg-queue=<value> The name of the Dead Message Queue.
--durability-override=<option> Controls the durability of queues created from this template,
overriding the requested durability.
<options: none|non-durable|durable>
--max-bind-count=<value> The maximum number of consumer flows that can bind to queues
created from this template.
--max-delivered-unacked-msgs-per-flow=<value> The maximum number of messages delivered but not acknowledged per
flow.
--max-msg-size=<value> The maximum message size allowed in queues created from this
template, in bytes.
--max-redelivery-count=<value> The maximum number of times a message will be redelivered before it
is discarded or moved to the DMQ.
--max-ttl=<value> The maximum time in seconds a message can stay in queues created
from this template when respect-ttl-enabled is true.
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 Queue Template 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 queue-template create --broker-name=dev-broker --queue-template-name=myTemplate --msg-vpn-name=default
$ sc broker queue-template create --broker-id=dev-broker --queue-template-name=myTemplate --msg-vpn-name=default --access-type=non-exclusive
$ sc broker queue-template create --broker-name=dev-broker --queue-template-name=myTemplate --msg-vpn-name=default --max-msg-spool-usage=1024 --permission=consume
$ sc broker queue-template create --queue-template-name=myTemplate --queue-name-filter="order.*"
$ sc broker queue-template create --queue-template-name=myTemplate --max-bind-count=500 --durability-override=non-durable
See code: @dishantlangayan/sc-plugin-broker
Delete a Queue Template from a Solace Event Broker.
USAGE
$ sc broker queue-template delete -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.
-t, --queue-template-name=<value> (required) The name of the queue template 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 Queue Template from a Solace Event Broker.
Deletes the specified queue template from the Message VPN. This is a destructive operation that removes the template
configuration.
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 queue-template delete --queue-template-name=myTemplate --msg-vpn-name=default
$ sc broker queue-template delete --broker-name=dev-broker --queue-template-name=myTemplate
$ sc broker queue-template delete --queue-template-name=myTemplate --no-prompt
$ sc broker queue-template delete --broker-id=prod --queue-template-name=tempTemplate --msg-vpn-name=production --no-prompt
See code: @dishantlangayan/sc-plugin-broker
Display queue template information from a Solace Event Broker.
USAGE
$ sc broker queue-template display -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.
-t, --queue-template-name=<value> (required) The name of the queue template 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 queue template information from a Solace Event Broker.
Retrieves and displays detailed information about a queue template using the SEMP Monitor API, including configuration
and state.
EXAMPLES
$ sc broker queue-template display --queue-template-name=myTemplate --msg-vpn-name=default
$ sc broker queue-template display --broker-name=dev-broker --queue-template-name=myTemplate --msg-vpn-name=default
$ sc broker queue-template display --queue-template-name=myTemplate
See code: @dishantlangayan/sc-plugin-broker
List queue templates from a Solace Event Broker.
USAGE
$ sc broker queue-template list [--json] [--log-level debug|warn|error|info|trace] [--broker-id <value> | -b <value>] [-v
<value>] [-a] [-c <value>] [-t <value>] [-s <value>]
FLAGS
-a, --all Display all queue templates (auto-pagination).
-b, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-c, --count=<value> [default: 10] Number of queue templates to display per page.
-s, --select=<value> Comma-separated list of attributes to display (max 10).
-t, --queue-template-name=<value> Filter queue templates 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 queue templates from a Solace Event Broker.
Retrieves and displays queue templates from the specified Message VPN using the SEMP Monitor API.
Supports filtering by name (with wildcards), custom attribute selection, and pagination.
EXAMPLES
$ sc broker queue-template list
$ sc broker queue-template list --count=20
$ sc broker queue-template list --queue-template-name="order*"
$ sc broker queue-template list --select=queueTemplateName,permission,maxMsgSpoolUsage
$ sc broker queue-template list --all
$ sc broker queue-template list --queue-template-name="*test*" --count=5 --all
See code: @dishantlangayan/sc-plugin-broker
Update a Queue Template on a Solace Event Broker.
USAGE
$ sc broker queue-template update -t <value> [--json] [--log-level debug|warn|error|info|trace] [--broker-id <value> | -b
<value>] [-v <value>] [-a exclusive|non-exclusive] [--dead-msg-queue <value>] [--durability-override
none|non-durable|durable] [--max-bind-count <value>] [--max-delivered-unacked-msgs-per-flow <value>] [--max-msg-size
<value>] [-s <value>] [--max-redelivery-count <value>] [--max-ttl <value>] [-p
consume|delete|modify-topic|no-access|read-only] [-f <value>]
FLAGS
-a, --access-type=<option> The access type for queues created from this template.
<options: exclusive|non-exclusive>
-b, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-f, --queue-name-filter=<value> A wildcarded pattern to match queue names for applying this
template. Supports * and > wildcards.
-p, --permission=<option> The permission level for all consumers of queues created from this
template, excluding the owner.
<options: consume|delete|modify-topic|no-access|read-only>
-s, --max-msg-spool-usage=<value> The maximum message spool usage allowed by queues created from this
template, in megabytes (MB).
-t, --queue-template-name=<value> (required) The name of the queue template 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.
--dead-msg-queue=<value> The name of the Dead Message Queue.
--durability-override=<option> Controls the durability of queues created from this template,
overriding the requested durability.
<options: none|non-durable|durable>
--max-bind-count=<value> The maximum number of consumer flows that can bind to queues
created from this template.
--max-delivered-unacked-msgs-per-flow=<value> The maximum number of messages delivered but not acknowledged per
flow.
--max-msg-size=<value> The maximum message size allowed in queues created from this
template, in bytes.
--max-redelivery-count=<value> The maximum number of times a message will be redelivered before it
is discarded or moved to the DMQ.
--max-ttl=<value> The maximum time in seconds a message can stay in queues created
from this template when respect-ttl-enabled is true.
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 Queue Template 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 queue-template update --broker-name=dev-broker --queue-template-name=myTemplate --msg-vpn-name=default --permission=consume
$ sc broker queue-template update --broker-id=dev-broker --queue-template-name=myTemplate --msg-vpn-name=default --max-msg-spool-usage=2048
$ sc broker queue-template update --broker-name=dev-broker --queue-template-name=myTemplate --msg-vpn-name=default --max-msg-spool-usage=1024 --max-ttl=3600
$ sc broker queue-template update --queue-template-name=myTemplate --queue-name-filter="order.*"
$ sc broker queue-template update --queue-template-name=myTemplate --permission=read-only --max-bind-count=200
See code: @dishantlangayan/sc-plugin-broker
Create a Queue on a Solace Event Broker.
USAGE
$ sc broker queue create -n <value> [--json] [--log-level debug|warn|error|info|trace] [--broker-id <value> | -b
<value>] [-v <value>] [-a exclusive|non-exclusive] [--dead-msg-queue <value>] [--egress-enabled] [--ingress-enabled]
[-s <value>] [--max-redelivery-count <value>] [--max-ttl <value>] [-o <value>] [-p
consume|delete|modify-topic|no-access|read-only] [--respect-ttl-enabled]
FLAGS
-a, --access-type=<option> The access type for the queue.
<options: exclusive|non-exclusive>
-b, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-n, --name=<value> (required) The name of the queue to create.
-o, --owner=<value> The client username that owns the queue and has permission equivalent to delete.
-p, --permission=<option> [default: consume] The permission level for all consumers of the queue, excluding
the owner.
<options: consume|delete|modify-topic|no-access|read-only>
-s, --max-msg-spool-usage=<value> The maximum message spool usage allowed by the queue, in megabytes (MB).
-v, --msg-vpn-name=<value> The name of the Message VPN.
--broker-id=<value> Stored broker identifier. If not provided, uses the default broker.
--dead-msg-queue=<value> The name of the Dead Message Queue.
--[no-]egress-enabled Enable or disable egress (message consumption) from the queue.
--[no-]ingress-enabled Enable or disable ingress (message reception) to the queue.
--max-redelivery-count=<value> The maximum number of times a message will be redelivered before it is discarded
or moved to the DMQ.
--max-ttl=<value> The maximum time in seconds a message can stay in the queue when
respect-ttl-enabled is true.
--[no-]respect-ttl-enabled Enable or disable the respecting of the time-to-live (TTL) for messages.
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 Queue on a Solace Event Broker.
EXAMPLES
$ sc broker queue create --name=myQueue
$ sc broker queue create --name=myQueue --access-type=non-exclusive --max-msg-spool-usage=1024 --egress-enabled --ingress-enabled
See code: @dishantlangayan/sc-plugin-broker
Delete a Queue from a Solace Event Broker.
USAGE
$ sc broker queue 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 queue 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 Queue from a Solace Event Broker.
This is a destructive operation that removes the queue and deletes any messages persisted on the queue.
By default, a confirmation prompt is shown before deletion. Use --no-prompt to skip confirmation.
EXAMPLES
$ sc broker queue delete --name=myQueue
$ sc broker queue delete --queue-name=myQueue --no-prompt
See code: @dishantlangayan/sc-plugin-broker
Display queue information from a Solace Event Broker.
USAGE
$ sc broker queue display -n <value> [--json] [--log-level debug|warn|error|info|trace] [--broker-id <value> | -b
<value>] [-v <value>] [-s]
FLAGS
-b, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-n, --name=<value> (required) The name of the queue to display.
-s, --show-subscriptions Display only queue subscriptions without queue details.
-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 queue information from a Solace Event Broker.
Retrieves and displays detailed information about a queue using the SEMP Monitor API, including operational state,
statistics, and configuration.
EXAMPLES
$ sc broker queue display --queue-name=myQueue
$ sc broker queue display --queue-name=myQueue --show-subscriptions
See code: @dishantlangayan/sc-plugin-broker
List queues from a Solace Event Broker.
USAGE
$ sc broker queue 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 queues (auto-pagination).
-b, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-c, --count=<value> [default: 10] Number of queues to display per page.
-n, --name=<value> Filter queues 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 queues from a Solace Event Broker.
Retrieves and displays queues from the specified Message VPN using the SEMP Monitor API.
Supports filtering by name (with wildcards), custom attribute selection, and pagination.
Refer to the SEMP Monitor API docs for available attributes.
EXAMPLES
$ sc broker queue list
$ sc broker queue list --count=20
$ sc broker queue list --name="order*"
$ sc broker queue list --select=queueName,owner,maxMsgSpoolUsage
$ sc broker queue list --all
$ sc broker queue list --name="*test*" --count=5 --all
See code: @dishantlangayan/sc-plugin-broker
Create a topic subscription on a Queue in a Solace Event Broker.
USAGE
$ sc broker queue subscriptions create -n <value> -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 queue to add the subscription to.
-t, --topic=<value> (required) The subscription topic to add to the queue.
-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 topic subscription on a Queue in a Solace Event Broker.
Guaranteed messages published to topics matching the subscription will be delivered to the queue.
Subscriptions use topic pattern matching which can include wildcards:
- '*' matches exactly one level in the topic hierarchy
- '>' matches one or more levels at the end of the topic
Multiple subscriptions can be added to a single queue.
EXAMPLES
$ sc broker queue subscriptions create --name=myQueue --topic=orders/>
$ sc broker queue subscriptions create --name=myQueue --topic=events/user/*
See code: @dishantlangayan/sc-plugin-broker
Delete a topic subscription from a Queue in a Solace Event Broker.
USAGE
$ sc broker queue subscriptions delete -n <value> -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 queue to remove the subscription from.
-t, --topic=<value> (required) The subscription topic to remove from the queue.
-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 topic subscription from a Queue in a Solace Event Broker.
This is a destructive operation that removes the subscription.
By default, a confirmation prompt is shown before deletion. Use --no-prompt to skip confirmation.
EXAMPLES
$ sc broker queue subscriptions delete --name=myQueue --topic=orders/>
$ sc broker queue subscriptions delete --name=myQueue --topic=orders/> --no-prompt
See code: @dishantlangayan/sc-plugin-broker
Update a Queue on a Solace Event Broker.
USAGE
$ sc broker queue update -n <value> [--json] [--log-level debug|warn|error|info|trace] [--broker-id <value> | -b
<value>] [-v <value>] [-a exclusive|non-exclusive] [--dead-msg-queue <value>] [--egress-enabled] [--ingress-enabled]
[-s <value>] [--max-redelivery-count <value>] [--max-ttl <value>] [-o <value>] [-p
consume|delete|modify-topic|no-access|read-only] [--respect-ttl-enabled]
FLAGS
-a, --access-type=<option> The access type for the queue.
<options: exclusive|non-exclusive>
-b, --broker-name=<value> Stored broker name. If not provided, uses the default broker.
-n, --name=<value> (required) The name of the queue to update.
-o, --owner=<value> The client username that owns the queue and has permission equivalent to delete.
-p, --permission=<option> The permission level for all consumers of the queue, excluding the owner.
<options: consume|delete|modify-topic|no-access|read-only>
-s, --max-msg-spool-usage=<value> The maximum message spool usage allowed by the queue, in megabytes (MB).
-v, --msg-vpn-name=<value> The name of the Message VPN.
--broker-id=<value> Stored broker identifier. If not provided, uses the default broker.
--dead-msg-queue=<value> The name of the Dead Message Queue.
--[no-]egress-enabled Enable or disable egress (message consumption) from the queue.
--[no-]ingress-enabled Enable or disable ingress (message reception) to the queue.
--max-redelivery-count=<value> The maximum number of times a message will be redelivered before it is discarded
or moved to the DMQ.
--max-ttl=<value> The maximum time in seconds a message can stay in the queue when
respect-ttl-enabled is true.
--[no-]respect-ttl-enabled Enable or disable the respecting of the time-to-live (TTL) for messages.
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 Queue on a Solace Event Broker.
Any attribute missing from the request will be left unchanged.
EXAMPLES
$ sc broker queue update --name=myQueue --egress-enabled
$ sc broker queue update --name=myQueue --max-msg-spool-usage=1024 --max-ttl=3600
$ sc broker queue update --name=myQueue --no-egress-enabled
See code: @dishantlangayan/sc-plugin-broker
List all sc commands.
USAGE
$ sc commands [--json] [-c id|plugin|summary|type... | --tree] [--deprecated] [-x | ] [--hidden]
[--no-truncate | ] [--sort id|plugin|summary|type | ]
FLAGS
-c, --columns=<option>... Only show provided columns (comma-separated).
<options: id|plugin|summary|type>
-x, --extended Show extra columns.
--deprecated Show deprecated commands.
--hidden Show hidden commands.
--no-truncate Do not truncate output.
--sort=<option> [default: id] Property to sort by.
<options: id|plugin|summary|type>
--tree Show tree of commands.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List all sc commands.
See code: @oclif/plugin-commands
Display help for sc.
USAGE
$ sc help [COMMAND...] [-n]
ARGUMENTS
[COMMAND...] Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for sc.
See code: @oclif/plugin-help
Create an event broker service. You must provide a unique name and select a service class and datacenter. You can optionally define other properties for the event broker service.
USAGE
$ sc missionctrl broker create -d <value> -n <value> -c <value> [--json] [--log-level debug|warn|error|info|trace] [-a
<value> | -o <value>] [-e <value>] [-l] [-s <value>] [-m <value>] [-r] [-v <value>]
FLAGS
-a, --alias=<value>
Organization alias to use. If not specified, uses the default organization.
-c, --service-class-id=<value>
(required) Supported service classes.
-d, --datacenter-id=<value>
(required) The identifier of the datacenter.
-e, --env-name=<value>
The name of the environment environment where you want to create the service.
You can only specify an environment identifier when creating services in a Public Region.
You cannot specify an environment identifier when creating a service in a Dedicated Region.
If no name is provided, the service will be created in the default environment.
-l, --locked
Indicates if you can delete the event broker service after creating it. The default value is false.
-m, --msg-vpn-name=<value>
The message VPN name. A default message VPN name is provided when this is not specified.
-n, --name=<value>
(required) Name of the event broker service to create.
-o, --org=<value>
Organization ID to use. If not specified, uses the default organization or alias if specified.
-r, --redundancy-group-ssl-enabled
Enable or disable SSL for the redundancy group (for mate-link encryption). The default value is false (disabled)
-s, --max-spool-usage=<value>
The message spool size, in gigabytes (GB). A default message spool size is provided if this is not specified.
-v, --version=<value>
The event broker version. A default version is provided when this is not specified.
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 event broker service. You must provide a unique name and select a service class and datacenter. You can
optionally define other properties for the event broker service.
Your token must have one of the permissions listed in the Token Permissions.
Token Permissions: [ `services:post` ]
EXAMPLES
$ sc missionctrl broker create --name=MyBrokerName --datacenter-id=eks-ca-central-1a --service-class-id=DEVELOPER
$ sc missionctrl broker create --org=my-org --name=MyBrokerName --datacenter-id=eks-ca-central-1a --service-class-id=DEVELOPER
$ sc missionctrl broker create --alias=my-alias --name=MyBrokerName --datacenter-id=eks-ca-central-1a --service-class-id=DEVELOPER
See code: src/commands/missionctrl/broker/create.ts
Delete a service using its unique identifier.
USAGE
$ sc missionctrl broker delete [--json] [--log-level debug|warn|error|info|trace] [-a <value> | -o <value>] [-b <value>] [-n
<value>] [--no-prompt]
FLAGS
-a, --alias=<value> Organization alias to use. If not specified, uses the default organization.
-b, --broker-id=<value> Id of the event broker service.
-n, --name=<value> Name of the event broker service.
-o, --org=<value> Organization ID to use. If not specified, uses the default organization or alias if
specified.
--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
Delete a service using its unique identifier.
Your token must have one of the permissions listed in the Token Permissions.
Token Permissions: [ `services:delete` **or** `services:delete:self` **or** `mission_control:access` ]
EXAMPLES
$ sc missionctrl broker delete --broker-id=MyBrokerId
$ sc missionctrl broker delete --name=MyBrokerName
$ sc missionctrl broker delete --org=my-org --broker-id=MyBrokerId
$ sc missionctrl broker delete --alias=my-alias --name=MyBrokerName
$ sc missionctrl broker delete --broker-id=MyBrokerId --no-prompt
See code: src/commands/missionctrl/broker/delete.ts
Get the details of an event broker service using its identifier or name.
USAGE
$ sc missionctrl broker display [--json] [--log-level debug|warn|error|info|trace] [-a <value> | -o <value>] [-b <value>] [-n
<value>]
FLAGS
-a, --alias=<value> Organization alias to use. If not specified, uses the default organization.
-b, --broker-id=<value> Id of the event broker service.
-n, --name=<value> Name of the event broker service.
-o, --org=<value> Organization ID to use. If not specified, uses the default organization or alias if
specified.
GLOBAL FLAGS
--json Format output as json.
--log-level=<option> [default: info] Specify level for logging.
<options: debug|warn|error|info|trace>
DESCRIPTION
Get the details of an event broker service using its identifier or name.
Use either the Event Broker's ID (--broker-id) or name of the Event Broker (--name).
Token Permissions: [ `mission_control:access` **or** `services:get` **or** `services:get:self` **or** `services:view`
**or** `services:view:self` ]
EXAMPLES
$ sc missionctrl broker display --broker-id=MyBrokerId
$ sc missionctrl broker display --org=my-org --name=MyBrokerName
$ sc missionctrl broker display --alias=my-alias --name=MyBrokerName
See code: src/commands/missionctrl/broker/display.ts
Get a listing of event broker services.
USAGE
$ sc missionctrl broker list [--json] [--log-level debug|warn|error|info|trace] [-a <value> | -o <value>] [-n <value>]
[--pageNumber <value>] [--pageSize <value>] [--sort <value>]
FLAGS
-a, --alias=<value>
Organization alias to use. If not specified, uses the default organization.
-n, --name=<value>
Name of the event broker service to match on.
-o, --org=<value>
Organization ID to use. If not specified, uses the default organization or alias if specified.
--pageNumber=<value>
The page number to get. Defaults to 1
--pageSize=<value>
The number of event broker services to return per page. Defaults to 10
--sort=<value>
Sort the returned event broker services by attribute.
You can use the following value formats for the sort order:
* attributes-names
* attributes-names:sort-order
GLOBAL FLAGS
--json Format output as json.
--log-level=<option> [default: info] Specify level for logging.
<options: debug|warn|error|info|trace>
DESCRIPTION
Get a listing of event broker services.
Your token must have one of the permissions listed in the Token Permissions.
Token Permissions: [ `mission_control:access` **or** `services:get` **or** `services:get:self` **or** `services:view`
**or** `services:view:self` ]
EXAMPLES
$ sc missionctrl broker list
$ sc missionctrl broker list --org=my-org
$ sc missionctrl broker list --alias=my-alias --name=MyBrokerName --pageNumber=1 --pageSize=10 --sort=name:asc
See code: src/commands/missionctrl/broker/list.ts
Get the status of all operations being performed on an event broker service.
USAGE
$ sc missionctrl broker opstatus [--json] [--log-level debug|warn|error|info|trace] [-a <value> | -o <value>] [-b <value>] [-n
<value>] [-p] [-w <value>]
FLAGS
-a, --alias=<value> Organization alias to use. If not specified, uses the default organization.
-b, --broker-id=<value> Id of the event broker service.
-n, --name=<value> Name of the event broker service.
-o, --org=<value> Organization ID to use. If not specified, uses the default organization or alias if
specified.
-p, --show-progress Displays a status bar of the in-progress operations. The command will wait for completion of
each step of the operation.
-w, --wait-ms=<value> The milliseconds to wait between API calls for checking progress of the operation. Default is
5000 ms.
GLOBAL FLAGS
--json Format output as json.
--log-level=<option> [default: info] Specify level for logging.
<options: debug|warn|error|info|trace>
DESCRIPTION
Get the status of all operations being performed on an event broker service.
To get the operation status, you must provide the identifier or name of the event broker service.
Token Permissions: [ mission_control:access or services:get or services:get:self or services:view or
services:view:self ]
EXAMPLES
$ sc missionctrl broker opstatus -b <broker-id>
$ sc missionctrl broker opstatus -n <broker-name>
$ sc missionctrl broker opstatus --org=my-org -b <broker-id>
$ sc missionctrl broker opstatus --alias=my-alias -b <broker-id>
See code: src/commands/missionctrl/broker/opstatus.ts
Get the availability state of an event broker service and the name of the active messaging node using the service's unique identifier.
USAGE
$ sc missionctrl broker state [--json] [--log-level debug|warn|error|info|trace] [-a <value> | -o <value>] [-b <value>] [-n
<value>]
FLAGS
-a, --alias=<value> Organization alias to use. If not specified, uses the default organization.
-b, --broker-id=<value> Id of the event broker service.
-n, --name=<value> Name of the event broker service.
-o, --org=<value> Organization ID to use. If not specified, uses the default organization or alias if
specified.
GLOBAL FLAGS
--json Format output as json.
--log-level=<option> [default: info] Specify level for logging.
<options: debug|warn|error|info|trace>
DESCRIPTION
Get the availability state of an event broker service and the name of the active messaging node using the service's
unique identifier.
Your token must have one of the permissions listed in the Token Permissions.
Token Permissions: [ mission_control:access or services:get or services:get:self or services:view or
services:view:self ]
EXAMPLES
$ sc missionctrl broker state --broker-id=MyBrokerServiceId
$ sc missionctrl broker state --name=MyBrokerName
$ sc missionctrl broker state --org=my-org --broker-id=MyBrokerServiceId
$ sc missionctrl broker state --alias=my-alias --name=MyBrokerName
See code: src/commands/missionctrl/broker/state.ts
Update the configuration of an existing event broker service.
USAGE
$ sc missionctrl broker update [--json] [--log-level debug|warn|error|info|trace] [-a <value> | -o <value>] [-b <value>] [-l
<value>] [-n <value>] [--new-name <value>]
FLAGS
-a, --alias=<value> Organization alias to use. If not specified, uses the default organization.
-b, --broker-id=<value> Id of the event broker service.
-l, --locked=<value> Indicates whether the event broker service has deletion protection enabled. The valid values
are 'true' (enabled) or 'false' (disabled).
-n, --name=<value> Name of the event broker service.
-o, --org=<value> Organization ID to use. If not specified, uses the default organization or alias if
specified.
--new-name=<value> New name of the event broker service. The new service name must be unique within an
organization.
GLOBAL FLAGS
--json Format output as json.
--log-level=<option> [default: info] Specify level for logging.
<options: debug|warn|error|info|trace>
DESCRIPTION
Update the configuration of an existing event broker service.
You can provide any combination of supported flags. If a flag is not provided, then it will not be updated.
Your token must have one of the permissions listed in the Token Permissions.
Token Permissions: [ mission_control:access or services:put ]
EXAMPLES
$ sc missionctrl broker update
$ sc missionctrl broker update --broker-id <broker-id> --new-name <new-name>
$ sc missionctrl broker update --org=my-org --name <name> --new-name <new-name>
$ sc missionctrl broker update --alias=my-alias --name <name> --new-name <new-name>
See code: src/commands/missionctrl/broker/update.ts
Create a new environment.
USAGE
$ sc platform env create -n <value> [--json] [--log-level debug|warn|error|info|trace] [-a <value> | -o <value>] [-d
<value>] [--isDefault] [--isProduction]
FLAGS
-a, --alias=<value> Organization alias to use. If not specified, uses the default organization.
-d, --description=<value> Description of the environment to create.
-n, --name=<value> (required) Name of the environment to create.
-o, --org=<value> Organization ID to use. If not specified, uses the default organization or alias if
specified.
--isDefault Indicates this is the organization's default environment.
--isProduction Indicates this is an organization's production environment.
This is an immutable field. If an environment needs to be migrated,
architecture can be migrated to a new environment with the desired
environment type instead.
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 new environment.
Token Permissions: [ environments:edit ]
EXAMPLES
$ sc platform env create --name=MyEnvironment
$ sc platform env create --org=my-org --name=MyEnvironment --description="My environment description" --isDefault --isProduction
$ sc platform env create --alias=my-alias --name=MyEnvironment --isDefault
See code: src/commands/platform/env/create.ts
Delete an environment using either its name or unique identifier. The default environment cannot be deleted.
USAGE
$ sc platform env delete [--json] [--log-level debug|warn|error|info|trace] [-a <value> | -o <value>] [-e <value>] [-n
<value>] [--no-prompt]
FLAGS
-a, --alias=<value> Organization alias to use. If not specified, uses the default organization.
-e, --env-id=<value> Id of the environment.
-n, --name=<value> Name of the environment.
-o, --org=<value> Organization ID to use. If not specified, uses the default organization or alias if specified.
--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
Delete an environment using either its name or unique identifier. The default environment cannot be deleted.
Token Permissions: [ environments:edit ]
EXAMPLES
$ sc platform env delete --name=MyEnvName
$ sc platform env delete --env-id=MyEnvId
$ sc platform env delete --org=my-org --name=MyEnvName
$ sc platform env delete --alias=my-alias --name=MyEnvName
$ sc platform env delete --env-id=MyEnvId --no-prompt
See code: src/commands/platform/env/delete.ts
Display information about an Environment.
USAGE
$ sc platform env display [--json] [--log-level debug|warn|error|info|trace] [-a <value> | -o <value>] [-e <value>] [-n
<value>]
FLAGS
-a, --alias=<value> Organization alias to use. If not specified, uses the default organization.
-e, --env-id=<value> Id of the environment.
-n, --name=<value> Name of the environment.
-o, --org=<value> Organization ID to use. If not specified, uses the default organization or alias if specified.
GLOBAL FLAGS
--json Format output as json.
--log-level=<option> [default: info] Specify level for logging.
<options: debug|warn|error|info|trace>
DESCRIPTION
Display information about an Environment.
Use either the Environment's ID (--env-id) or name of the Environment (--name).
Required token permissions: [ environments:view ]
EXAMPLES
$ sc platform env display --name=MyEnvName
$ sc platform env display --env-id=MyEnvId
$ sc platform env display --org=my-org --env-id=MyEnvId
$ sc platform env display --alias=my-alias --name=MyEnvName
See code: src/commands/platform/env/display.ts
Get a list of all Environments.
USAGE
$ sc platform env list [--json] [--log-level debug|warn|error|info|trace] [-a <value> | -o <value>] [-n <value>] [-p
<value>] [-s <value>] [--sort <value>]
FLAGS
-a, --alias=<value> Organization alias to use. If not specified, uses the default organization.
-n, --name=<value> Name of the environment to match on.
-o, --org=<value> Organization ID to use. If not specified, uses the default organization or alias if
specified.
-p, --pageNumber=<value> The page number to get. Defaults to 10
-s, --pageSize=<value> The number of environments to get per page. Defaults to 1
--sort=<value> The query (fieldName:<ASC/DESC>) used to sort the environment list in the response.
GLOBAL FLAGS
--json Format output as json.
--log-level=<option> [default: info] Specify level for logging.
<options: debug|warn|error|info|trace>
DESCRIPTION
Get a list of all Environments.
Required token permissions: [ environments:view ]
EXAMPLES
$ sc platform env list
$ sc platform env list --org=my-org
$ sc platform env list --alias=my-alias --name=Default --pageNumber=1 --pageSize=10 --sort=name:ASC
See code: src/commands/platform/env/list.ts
Modify an environment's attributes
USAGE
$ sc platform env update [--json] [--log-level debug|warn|error|info|trace] [-a <value> | -o <value>] [-d <value>] [-e
<value>] [--isDefault] [-n <value>] [--new-name <value>]
FLAGS
-a, --alias=<value> Organization alias to use. If not specified, uses the default organization.
-d, --description=<value> Description of the environment to update.
-e, --env-id=<value> Id of the environment.
-n, --name=<value> Current name of the environment.
-o, --org=<value> Organization ID to use. If not specified, uses the default organization or alias if
specified.
--isDefault Indicates this is the organization's default environment. The default value is false.
--new-name=<value> New name of the environment.
GLOBAL FLAGS
--json Format output as json.
--log-level=<option> [default: info] Specify level for logging.
<options: debug|warn|error|info|trace>
DESCRIPTION
Modify an environment's attributes
Use either the Environment's ID (--env-id) or name of the Environment (--name).
Token Permissions: [ environments:edit ]
EXAMPLES
$ sc platform env update --name=MyEnvName --new-name=MyNewEnvName
$ sc platform env update --env-id=MyEnvId --new-name=MyNewEnvName --description="My description to update" --isDefault
$ sc platform env update --org=my-org --name=MyEnvName --isDefault
$ sc platform env update --alias=my-alias --name=MyEnvName --new-name=MyNewEnvName
See code: src/commands/platform/env/update.ts
List installed plugins.
USAGE
$ sc plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ sc plugins
See code: @oclif/plugin-plugins
Installs a plugin into sc.
USAGE
$ sc plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
ARGUMENTS
PLUGIN... Plugin to install.
FLAGS
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
-h, --help Show CLI help.
-s, --silent Silences npm output.
-v, --verbose Show verbose npm output.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Installs a plugin into sc.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the SC_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the SC_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ sc plugins add
EXAMPLES
Install a plugin from npm registry.
$ sc plugins add myplugin
Install a plugin from a github url.
$ sc plugins add https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ sc plugins add someuser/someplugin
Displays installation properties of a plugin.
USAGE
$ sc plugins inspect PLUGIN...
ARGUMENTS
PLUGIN... [default: .] Plugin to inspect.
FLAGS
-h, --help Show CLI help.
-v, --verbose
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Displays installation properties of a plugin.
EXAMPLES
$ sc plugins inspect myplugin
See code: @oclif/plugin-plugins
Installs a plugin into sc.
USAGE
$ sc plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
ARGUMENTS
PLUGIN... Plugin to install.
FLAGS
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
-h, --help Show CLI help.
-s, --silent Silences npm output.
-v, --verbose Show verbose npm output.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Installs a plugin into sc.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the SC_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the SC_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ sc plugins add
EXAMPLES
Install a plugin from npm registry.
$ sc plugins install myplugin
Install a plugin from a github url.
$ sc plugins install https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ sc plugins install someuser/someplugin
See code: @oclif/plugin-plugins
Links a plugin into the CLI for development.
USAGE
$ sc plugins link PATH [-h] [--install] [-v]
ARGUMENTS
PATH [default: .] path to plugin
FLAGS
-h, --help Show CLI help.
-v, --verbose
--[no-]install Install dependencies after linking the plugin.
DESCRIPTION
Links a plugin into the CLI for development.
Installation of a linked plugin will override a user-installed or core plugin.
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
command will override the user-installed or core plugin implementation. This is useful for development work.
EXAMPLES
$ sc plugins link myplugin
See code: @oclif/plugin-plugins
Removes a plugin from the CLI.
USAGE
$ sc plugins remove [PLUGIN...] [-h] [-v]
ARGUMENTS
[PLUGIN...] plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ sc plugins unlink
$ sc plugins remove
EXAMPLES
$ sc plugins remove myplugin
Remove all user-installed and linked plugins.
USAGE
$ sc plugins reset [--hard] [--reinstall]
FLAGS
--hard Delete node_modules and package manager related files in addition to uninstalling plugins.
--reinstall Reinstall all plugins after uninstalling.
See code: @oclif/plugin-plugins
Removes a plugin from the CLI.
USAGE
$ sc plugins uninstall [PLUGIN...] [-h] [-v]
ARGUMENTS
[PLUGIN...] plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ sc plugins unlink
$ sc plugins remove
EXAMPLES
$ sc plugins uninstall myplugin
See code: @oclif/plugin-plugins
Removes a plugin from the CLI.
USAGE
$ sc plugins unlink [PLUGIN...] [-h] [-v]
ARGUMENTS
[PLUGIN...] plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ sc plugins unlink
$ sc plugins remove
EXAMPLES
$ sc plugins unlink myplugin
Update installed plugins.
USAGE
$ sc plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
See code: @oclif/plugin-plugins
Search for a command.
USAGE
$ sc search
DESCRIPTION
Search for a command.
Once you select a command, hit enter and it will show the help for that command.
See code: @oclif/plugin-search
update the sc CLI
USAGE
$ sc update [CHANNEL] [--force | | [-a | -v <value> | -i]] [-b ]
FLAGS
-a, --available See available versions.
-b, --verbose Show more details about the available versions.
-i, --interactive Interactively select version to install. This is ignored if a channel is provided.
-v, --version=<value> Install a specific version.
--force Force a re-download of the requested version.
DESCRIPTION
update the sc CLI
EXAMPLES
Update to the stable channel:
$ sc update stable
Update to a specific version:
$ sc update --version 1.0.0
Interactively select version:
$ sc update --interactive
See available versions:
$ sc update --available
See code: @oclif/plugin-update
USAGE
$ sc version [--json] [--verbose]
FLAGS
--verbose Show additional information about the CLI.
GLOBAL FLAGS
--json Format output as json.
FLAG DESCRIPTIONS
--verbose Show additional information about the CLI.
Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.
See code: @oclif/plugin-version
Show which plugin a command is in.
USAGE
$ sc which [--json]
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Show which plugin a command is in.
EXAMPLES
See which plugin the `help` command is in:
$ sc which help
Use colon separators.
$ sc which foo:bar:baz
Use spaces as separators.
$ sc which foo bar baz
Wrap command in quotes to use spaces as separators.
$ sc which "foo bar baz"
See code: @oclif/plugin-which