Skip to content

Commit 35d30b2

Browse files
Updated README with event broker services commands
1 parent 2aaebf3 commit 35d30b2

File tree

1 file changed

+126
-0
lines changed

1 file changed

+126
-0
lines changed

README.md

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,10 @@ USAGE
3030
<!-- usagestop -->
3131
# Commands
3232
<!-- commands -->
33+
* [`sc missionctrl broker create`](#sc-missionctrl-broker-create)
34+
* [`sc missionctrl broker delete`](#sc-missionctrl-broker-delete)
35+
* [`sc missionctrl broker display`](#sc-missionctrl-broker-display)
36+
* [`sc missionctrl broker list`](#sc-missionctrl-broker-list)
3337
* [`sc platform env create`](#sc-platform-env-create)
3438
* [`sc platform env delete`](#sc-platform-env-delete)
3539
* [`sc platform env display`](#sc-platform-env-display)
@@ -46,6 +50,128 @@ USAGE
4650
* [`sc plugins unlink [PLUGIN]`](#sc-plugins-unlink-plugin)
4751
* [`sc plugins update`](#sc-plugins-update)
4852

53+
## `sc missionctrl broker create`
54+
55+
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.
56+
57+
```
58+
USAGE
59+
$ sc missionctrl broker create -d <value> -n <value> -c <value> [-e <value>] [-l] [-s <value>] [-m <value>] [-v <value>]
60+
61+
FLAGS
62+
-c, --service-class-id=<value> (required) Supported service classes.
63+
-d, --datacenter-id=<value> (required) The identifier of the datacenter.
64+
-e, --env-name=<value> The name of the environment environment where you want to create the service. If no name is provided, the service will be
65+
created in the default environment.
66+
-l, --locked Indicates if you can delete the event broker service after creating it. The default value is false.
67+
-m, --msg-vpn-name=<value> The message VPN name. A default message VPN name is provided when this is not specified.
68+
-n, --name=<value> (required) Name of the event broker service to create.
69+
-s, --max-spool-usage=<value> The message spool size, in gigabytes (GB). A default message spool size is provided if this is not specified.
70+
-v, --version=<value> The event broker version. A default version is provided when this is not specified.
71+
72+
DESCRIPTION
73+
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
74+
event broker service.
75+
76+
Your token must have one of the permissions listed in the Token Permissions.
77+
78+
Token Permissions: [ `services:post` ]
79+
80+
EXAMPLES
81+
$ sc missionctrl broker create --datacenter-id=MyDatacenterId --name=MyBrokerName --service-class-id=DEVELOPER
82+
```
83+
84+
_See code: [src/commands/missionctrl/broker/create.ts](https://github.com/dishantlangayan/solace-cloud-cli/blob/v0.0.0/src/commands/missionctrl/broker/create.ts)_
85+
86+
## `sc missionctrl broker delete`
87+
88+
Delete a service using its unique identifier.
89+
90+
```
91+
USAGE
92+
$ sc missionctrl broker delete [-e <value>] [-n <value>]
93+
94+
FLAGS
95+
-e, --broker-id=<value> Id of the event broker service.
96+
-n, --name=<value> Name of the event broker service.
97+
98+
DESCRIPTION
99+
Delete a service using its unique identifier.
100+
101+
Your token must have one of the permissions listed in the Token Permissions.
102+
103+
Token Permissions: [ `services:delete` **or** `services:delete:self` **or** `mission_control:access` ]
104+
105+
EXAMPLES
106+
$ sc missionctrl broker delete --broker-id=MyBrokerId
107+
108+
$ sc missionctrl broker delete --name=MyBrokerName
109+
```
110+
111+
_See code: [src/commands/missionctrl/broker/delete.ts](https://github.com/dishantlangayan/solace-cloud-cli/blob/v0.0.0/src/commands/missionctrl/broker/delete.ts)_
112+
113+
## `sc missionctrl broker display`
114+
115+
```
116+
USAGE
117+
$ sc missionctrl broker display [-b <value>] [-n <value>]
118+
119+
FLAGS
120+
-b, --broker-id=<value> Id of the event broker service.
121+
-n, --name=<value> Name of the event broker service.
122+
123+
DESCRIPTION
124+
Get the details of an event broker service using its identifier or name.
125+
126+
Use either the Event Broker's ID (--broker-id) or name of the Event Broker (--name).
127+
128+
Token Permissions: [ `mission_control:access` **or** `services:get` **or** `services:get:self` **or** `services:view` **or** `services:view:self` ]
129+
130+
EXAMPLES
131+
$ sc missionctrl broker display
132+
```
133+
134+
_See code: [src/commands/missionctrl/broker/display.ts](https://github.com/dishantlangayan/solace-cloud-cli/blob/v0.0.0/src/commands/missionctrl/broker/display.ts)_
135+
136+
## `sc missionctrl broker list`
137+
138+
Get a listing of event broker services.
139+
140+
```
141+
USAGE
142+
$ sc missionctrl broker list [-n <value>] [--pageNumber <value>] [--pageSize <value>] [--sort <value>]
143+
144+
FLAGS
145+
-n, --name=<value>
146+
Name of the event broker service to match on.
147+
148+
--pageNumber=<value>
149+
The page number to get. Defaults to 1
150+
151+
--pageSize=<value>
152+
The number of event broker services to return per page. Defaults to 100
153+
154+
--sort=<value>
155+
Sort the returned event broker services by attribute.
156+
157+
You can use the following value formats for the sort order:
158+
159+
* attributes-names
160+
* attributes-names:sort-order
161+
162+
DESCRIPTION
163+
Get a listing of event broker services.
164+
165+
Your token must have one of the permissions listed in the Token Permissions.
166+
167+
Token Permissions: [ `mission_control:access` **or** `services:get` **or** `services:get:self` **or** `services:view` **or** `services:view:self` ]
168+
169+
EXAMPLES
170+
$ sc missionctrl broker list --name=MyBrokerName --pageNumber=1 --pageSize=10 --sort=name:asc
171+
```
172+
173+
_See code: [src/commands/missionctrl/broker/list.ts](https://github.com/dishantlangayan/solace-cloud-cli/blob/v0.0.0/src/commands/missionctrl/broker/list.ts)_
174+
49175
## `sc platform env create`
50176

51177
Create a new environment.

0 commit comments

Comments
 (0)