@@ -22,7 +22,7 @@ $ npm install -g @dishantlangayan/solace-cloud-cli
2222$ sc COMMAND
2323running command...
2424$ sc (--version)
25- @dishantlangayan/solace-cloud-cli/0.0.2 darwin -x64 node-v23.10 .0
25+ @dishantlangayan/solace-cloud-cli/0.0.2 linux -x64 node-v22.17 .0
2626$ sc --help [COMMAND]
2727USAGE
2828 $ sc COMMAND
@@ -46,15 +46,6 @@ The following Environment variables are optional:
4646# Commands
4747<!-- commands -->
4848* [ ` sc help [COMMAND] ` ] ( #sc-help-command )
49- * [ ` sc missionctrl broker create ` ] ( #sc-missionctrl-broker-create )
50- * [ ` sc missionctrl broker delete ` ] ( #sc-missionctrl-broker-delete )
51- * [ ` sc missionctrl broker display ` ] ( #sc-missionctrl-broker-display )
52- * [ ` sc missionctrl broker list ` ] ( #sc-missionctrl-broker-list )
53- * [ ` sc platform env create ` ] ( #sc-platform-env-create )
54- * [ ` sc platform env delete ` ] ( #sc-platform-env-delete )
55- * [ ` sc platform env display ` ] ( #sc-platform-env-display )
56- * [ ` sc platform env list ` ] ( #sc-platform-env-list )
57- * [ ` sc platform env update ` ] ( #sc-platform-env-update )
5849* [ ` sc plugins ` ] ( #sc-plugins )
5950* [ ` sc plugins add PLUGIN ` ] ( #sc-plugins-add-plugin )
6051* [ ` sc plugins:inspect PLUGIN... ` ] ( #sc-pluginsinspect-plugin )
@@ -86,292 +77,6 @@ DESCRIPTION
8677
8778_ See code: [ @oclif/plugin-help ] ( https://github.com/oclif/plugin-help/blob/v6.2.29/src/commands/help.ts ) _
8879
89- ## ` sc missionctrl broker create `
90-
91- 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.
92-
93- ```
94- USAGE
95- $ sc missionctrl broker create -d <value> -n <value> -c <value> [-e <value>] [-l] [-s <value>] [-m <value>] [-r] [-v
96- <value>]
97-
98- FLAGS
99- -c, --service-class-id=<value>
100- (required) Supported service classes.
101-
102- -d, --datacenter-id=<value>
103- (required) The identifier of the datacenter.
104-
105- -e, --env-name=<value>
106- The name of the environment environment where you want to create the service.
107- You can only specify an environment identifier when creating services in a Public Region.
108- You cannot specify an environment identifier when creating a service in a Dedicated Region.
109- If no name is provided, the service will be created in the default environment.
110-
111- -l, --locked
112- Indicates if you can delete the event broker service after creating it. The default value is false.
113-
114- -m, --msg-vpn-name=<value>
115- The message VPN name. A default message VPN name is provided when this is not specified.
116-
117- -n, --name=<value>
118- (required) Name of the event broker service to create.
119-
120- -r, --redundancy-group-ssl-enabled
121- Enable or disable SSL for the redundancy group (for mate-link encryption). The default value is false (disabled)
122-
123- -s, --max-spool-usage=<value>
124- The message spool size, in gigabytes (GB). A default message spool size is provided if this is not specified.
125-
126- -v, --version=<value>
127- The event broker version. A default version is provided when this is not specified.
128-
129- DESCRIPTION
130- Create an event broker service. You must provide a unique name and select a service class and datacenter. You can
131- optionally define other properties for the event broker service.
132-
133- Your token must have one of the permissions listed in the Token Permissions.
134-
135- Token Permissions: [ `services:post` ]
136-
137- EXAMPLES
138- $ sc missionctrl broker create --name=MyBrokerName --datacenter-id=eks-ca-central-1a --service-class-id=DEVELOPER
139- ```
140-
141- _ See code: [ src/commands/missionctrl/broker/create.ts] ( https://github.com/dishantlangayan/solace-cloud-cli/blob/v0.0.2/src/commands/missionctrl/broker/create.ts ) _
142-
143- ## ` sc missionctrl broker delete `
144-
145- Delete a service using its unique identifier.
146-
147- ```
148- USAGE
149- $ sc missionctrl broker delete [-b <value>] [-n <value>]
150-
151- FLAGS
152- -b, --broker-id=<value> Id of the event broker service.
153- -n, --name=<value> Name of the event broker service.
154-
155- DESCRIPTION
156- Delete a service using its unique identifier.
157-
158- Your token must have one of the permissions listed in the Token Permissions.
159-
160- Token Permissions: [ `services:delete` **or** `services:delete:self` **or** `mission_control:access` ]
161-
162- EXAMPLES
163- $ sc missionctrl broker delete --broker-id=MyBrokerId
164-
165- $ sc missionctrl broker delete --name=MyBrokerName
166- ```
167-
168- _ See code: [ src/commands/missionctrl/broker/delete.ts] ( https://github.com/dishantlangayan/solace-cloud-cli/blob/v0.0.2/src/commands/missionctrl/broker/delete.ts ) _
169-
170- ## ` sc missionctrl broker display `
171-
172- Get the details of an event broker service using its identifier or name.
173-
174- ```
175- USAGE
176- $ sc missionctrl broker display [-b <value>] [-n <value>]
177-
178- FLAGS
179- -b, --broker-id=<value> Id of the event broker service.
180- -n, --name=<value> Name of the event broker service.
181-
182- DESCRIPTION
183- Get the details of an event broker service using its identifier or name.
184-
185- Use either the Event Broker's ID (--broker-id) or name of the Event Broker (--name).
186-
187- Token Permissions: [ `mission_control:access` **or** `services:get` **or** `services:get:self` **or** `services:view`
188- **or** `services:view:self` ]
189-
190- EXAMPLES
191- $ sc missionctrl broker display
192- ```
193-
194- _ See code: [ src/commands/missionctrl/broker/display.ts] ( https://github.com/dishantlangayan/solace-cloud-cli/blob/v0.0.2/src/commands/missionctrl/broker/display.ts ) _
195-
196- ## ` sc missionctrl broker list `
197-
198- Get a listing of event broker services.
199-
200- ```
201- USAGE
202- $ sc missionctrl broker list [-n <value>] [--pageNumber <value>] [--pageSize <value>] [--sort <value>]
203-
204- FLAGS
205- -n, --name=<value>
206- Name of the event broker service to match on.
207-
208- --pageNumber=<value>
209- The page number to get. Defaults to 1
210-
211- --pageSize=<value>
212- The number of event broker services to return per page. Defaults to 100
213-
214- --sort=<value>
215- Sort the returned event broker services by attribute.
216-
217- You can use the following value formats for the sort order:
218-
219- * attributes-names
220- * attributes-names:sort-order
221-
222- DESCRIPTION
223- Get a listing of event broker services.
224-
225- Your token must have one of the permissions listed in the Token Permissions.
226-
227- Token Permissions: [ `mission_control:access` **or** `services:get` **or** `services:get:self` **or** `services:view`
228- **or** `services:view:self` ]
229-
230- EXAMPLES
231- $ sc missionctrl broker list --name=MyBrokerName --pageNumber=1 --pageSize=10 --sort=name:asc
232- ```
233-
234- _ See code: [ src/commands/missionctrl/broker/list.ts] ( https://github.com/dishantlangayan/solace-cloud-cli/blob/v0.0.2/src/commands/missionctrl/broker/list.ts ) _
235-
236- ## ` sc platform env create `
237-
238- Create a new environment.
239-
240- ```
241- USAGE
242- $ sc platform env create -n <value> [-d <value>] [--isDefault] [--isProduction]
243-
244- FLAGS
245- -d, --desc=<value> Description of the environment to create.
246- -n, --name=<value> (required) Name of the environment to create.
247- --isDefault Indicates this is the organization’s default environment.
248- --isProduction Indicates this is an organization’s production environment.
249- This is an immutable field. If an environment needs to be migrated,
250- architecture can be migrated to a new environment with the desired
251- environment type instead.
252-
253- DESCRIPTION
254- Create a new environment.
255-
256- Token Permissions: [ environments:edit ]
257-
258- EXAMPLES
259- $ sc platform env create --name=MyEnvironment --desc="My environment description" --isDefault --isProduction
260- ```
261-
262- _ See code: [ src/commands/platform/env/create.ts] ( https://github.com/dishantlangayan/solace-cloud-cli/blob/v0.0.2/src/commands/platform/env/create.ts ) _
263-
264- ## ` sc platform env delete `
265-
266- Delete an environment using either its name or unique identifier. The default environment cannot be deleted.
267-
268- ```
269- USAGE
270- $ sc platform env delete [-e <value>] [-n <value>]
271-
272- FLAGS
273- -e, --env-id=<value> Id of the environment.
274- -n, --name=<value> Name of the environment.
275-
276- DESCRIPTION
277- Delete an environment using either its name or unique identifier. The default environment cannot be deleted.
278-
279- Token Permissions: [ environments:edit ]
280-
281- EXAMPLES
282- $ sc platform env delete --name=MyEnvName
283-
284- $ sc platform env delete --env-id=MyEnvId
285- ```
286-
287- _ See code: [ src/commands/platform/env/delete.ts] ( https://github.com/dishantlangayan/solace-cloud-cli/blob/v0.0.2/src/commands/platform/env/delete.ts ) _
288-
289- ## ` sc platform env display `
290-
291- Display information about an Environment.
292-
293- ```
294- USAGE
295- $ sc platform env display [-e <value>] [-n <value>]
296-
297- FLAGS
298- -e, --env-id=<value> Id of the environment.
299- -n, --name=<value> Name of the environment.
300-
301- DESCRIPTION
302- Display information about an Environment.
303-
304- Use either the Environment's ID (--env-id) or name of the Environment (--name).
305-
306- Required token permissions: [ environments:view ]
307-
308-
309- EXAMPLES
310- $ sc platform env display --name=MyEnvName
311-
312- $ sc platform env display --env-id=MyEnvId
313- ```
314-
315- _ See code: [ src/commands/platform/env/display.ts] ( https://github.com/dishantlangayan/solace-cloud-cli/blob/v0.0.2/src/commands/platform/env/display.ts ) _
316-
317- ## ` sc platform env list `
318-
319- Get a list of all Environments.
320-
321- ```
322- USAGE
323- $ sc platform env list [-n <value>] [--pageNumber <value>] [--pageSize <value>] [--sort <value>]
324-
325- FLAGS
326- -n, --name=<value> Name of the environment to match on.
327- --pageNumber=<value> The page number to get. Defaults to 10
328- --pageSize=<value> The number of environments to get per page. Defaults to 1
329- --sort=<value> The query (fieldName:<ASC/DESC>) used to sort the environment list in the response.
330-
331- DESCRIPTION
332- Get a list of all Environments.
333-
334- Required token permissions: [ environments:view ]
335-
336- EXAMPLES
337- $ sc platform env list
338-
339- $ sc platform env list --name=Default --pageNumber=1 --pageSize=10 --sort=name:ASC
340- ```
341-
342- _ See code: [ src/commands/platform/env/list.ts] ( https://github.com/dishantlangayan/solace-cloud-cli/blob/v0.0.2/src/commands/platform/env/list.ts ) _
343-
344- ## ` sc platform env update `
345-
346- Modify an environment's attributes
347-
348- ```
349- USAGE
350- $ sc platform env update [-d <value>] [-e <value>] [--isDefault] [-n <value>] [--new-name <value>]
351-
352- FLAGS
353- -d, --desc=<value> Description of the environment to update.
354- -e, --env-id=<value> Id of the environment.
355- -n, --name=<value> Current name of the environment.
356- --isDefault Indicates this is the organization's default environment. The default value is false.
357- --new-name=<value> New name of the environment.
358-
359- DESCRIPTION
360- Modify an environment's attributes
361-
362- Use either the Environment's ID (--env-id) or name of the Environment (--name).
363-
364- Token Permissions: [ environments:edit ]
365-
366-
367- EXAMPLES
368- $ sc platform env update --name=MyEnvName --new-name=MyNewEnvName --desc="My description to update" --isDefault
369-
370- $ sc platform env update --env-id=MyEnvId --new-name=MyNewEnvName --desc="My description to update" --isDefault
371- ```
372-
373- _ See code: [ src/commands/platform/env/update.ts] ( https://github.com/dishantlangayan/solace-cloud-cli/blob/v0.0.2/src/commands/platform/env/update.ts ) _
374-
37580## ` sc plugins `
37681
37782List installed plugins.
0 commit comments