1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
|
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. Copyright 2017-18 Huawei Technologies Co., Ltd.
.. toctree::
:maxdepth: 2
.. _cli_cmd_help:
open-cli
=========
Open CLI is the OCLIP platform facilitates creating the commands from YAMLs. Currently it supports commands
for refreshing the existing command YAMLs and validating the YAMLs.
[1] schema-refresh
-----------------------------------------------
usage: oclip schema-refresh
OCLIP command to refresh schemas stored in open-cli-schema folders.
Product: open-cli
Service: schema
Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
Options::
[-s | --long] [-D | --context] [-h | --help]
[-f | --format] [-t | --no-title] [-v | --version]
[-d | --debug]
where::
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-h | --help print help message. It is of type BOOL.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-t | --no-title whether to print title or not. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
Results::
sr.no Serial Number and is of type STRING.
command Command name and is of type STRING.
product Command product version and is of type STRING.
schema Schema name and is of type STRING.
ocs-version Schema version and is of type STRING.
type Command type and is of type STRING.
Error::
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[2] schema-validate
-----------------------------------------------
usage: oclip schema-validate
OCLIP command to validate schema
Product: open-cli
Service: schema
Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
Options::
[-s | --long] [-D | --context] [-h | --help]
[-f | --format] [-t | --no-title] [-b | --ocs-version]
[-v | --version] [-d | --debug] [-l | --schema-location]
[-i | --internal-schema]
where::
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-h | --help print help message. It is of type BOOL.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-t | --no-title whether to print title or not. It is of type BOOL.
-b | --ocs-version OCS version. It is of type STRING. It is optional.
-v | --version print service version. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-l | --schema-location Schema file location. It is of type URL. By
default, it is .
-i | --internal-schema Validate existing schema file. It is of type BOOL.
Results::
sl-no Serial Number of error and is of type STRING.
error Schema validation error and is of type STRING.
Error::
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[65] subscription-create
-----------------------------------------------
usage: oclip subscription-create
Create a subscription of a customer for given service in specific cloud region in Onap
Product: onap-beijing
Service: aai
Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
[-m | --host-url] [-C | --no-catalog] [-h | --help]
[-f | --format] [-t | --no-title] [-V | --verify]
[-v | --version] [-d | --debug] [-x | --customer-name]
[-z | --cloud-name] [-c | --cloud-tenant-id] [-s | --long]
[-D | --context] [-e | --service-type] [-u | --host-username]
[-a | --no-auth] [-p | --host-password] [-r | --cloud-region]
where::
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog whether to use given host-url directly without
looking into catalog, it will overrid the
service->mode. It is of type BOOL. It is
optional.
-h | --help print help message. It is of type BOOL.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-t | --no-title whether to print title or not. It is of type BOOL.
-V | --verify verify the command using available command sample
file and mocking file. By default it goes with
mock style. To enable the verification in real
time, set DISABLE_MOCKING=true in the context
param. It is of type BOOL. It is optional.
-v | --version print service version. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-x | --customer-name Onap customer name. It is of type STRING. By
default, it is .
-z | --cloud-name Onap cloud name. It is of type STRING. By
default, it is .
-c | --cloud-tenant-id Onap cloud tenant id. It is of type STRING. By
default, it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-e | --service-type Onap service type. It is of type STRING. By
default, it is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
-r | --cloud-region Onap cloud region. It is of type STRING. By
default, it is .
Error::
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[66] subscription-create-with-template
-----------------------------------------------
usage: oclip subscription-create-with-template
Create a subscription of a customer with template
Product: onap-beijing
Service: aai
Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
[-m | --host-url] [-C | --no-catalog] [-h | --help]
[-f | --format] [-t | --no-title] [-V | --verify]
[-v | --version] [-d | --debug] [-x | --customer-name]
[-r | --template] [-s | --long] [-D | --context]
[-e | --service-type] [-u | --host-username] [-a | --no-auth]
[-p | --host-password]
where::
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog whether to use given host-url directly without
looking into catalog, it will overrid the
service->mode. It is of type BOOL. It is
optional.
-h | --help print help message. It is of type BOOL.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-t | --no-title whether to print title or not. It is of type BOOL.
-V | --verify verify the command using available command sample
file and mocking file. By default it goes with
mock style. To enable the verification in real
time, set DISABLE_MOCKING=true in the context
param. It is of type BOOL. It is optional.
-v | --version print service version. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-x | --customer-name Onap customer name. It is of type STRING. By
default, it is .
-r | --template template. It is of type JSON. It's recommended to
input the complete path of the file, which is
having the value for it.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-e | --service-type Onap service type. It is of type STRING. By
default, it is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Error::
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[67] subscription-delete
-----------------------------------------------
usage: oclip subscription-delete
Delete the subscription for a given customer in Onap
Product: onap-beijing
Service: aai
Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
[-m | --host-url] [-C | --no-catalog] [-h | --help]
[-f | --format] [-t | --no-title] [-V | --verify]
[-v | --version] [-d | --debug] [-x | --customer-name]
[-y | --service-type] [-s | --long] [-D | --context]
[-g | --resource-version] [-u | --host-username] [-a | --no-auth]
[-p | --host-password]
where::
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog whether to use given host-url directly without
looking into catalog, it will overrid the
service->mode. It is of type BOOL. It is
optional.
-h | --help print help message. It is of type BOOL.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-t | --no-title whether to print title or not. It is of type BOOL.
-V | --verify verify the command using available command sample
file and mocking file. By default it goes with
mock style. To enable the verification in real
time, set DISABLE_MOCKING=true in the context
param. It is of type BOOL. It is optional.
-v | --version print service version. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-x | --customer-name Onap customer name. It is of type STRING. By
default, it is .
-y | --service-type Onap subscribtion id. It is of type STRING. By
default, it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-g | --resource-version Onap subscription resource version. It is of type
STRING. It is optional. By default, it is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Error::
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[68] subscription-list
-----------------------------------------------
usage: oclip subscription-list
Lists the subscription for a given customer in Onap
Product: onap-beijing
Service: aai
Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
[-m | --host-url] [-C | --no-catalog] [-h | --help]
[-f | --format] [-t | --no-title] [-V | --verify]
[-v | --version] [-d | --debug] [-x | --customer-name]
[-s | --long] [-D | --context] [-u | --host-username]
[-a | --no-auth] [-p | --host-password]
where::
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog whether to use given host-url directly without
looking into catalog, it will overrid the
service->mode. It is of type BOOL. It is
optional.
-h | --help print help message. It is of type BOOL.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-t | --no-title whether to print title or not. It is of type BOOL.
-V | --verify verify the command using available command sample
file and mocking file. By default it goes with
mock style. To enable the verification in real
time, set DISABLE_MOCKING=true in the context
param. It is of type BOOL. It is optional.
-v | --version print service version. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-x | --customer-name Onap customer name. It is of type STRING. By
default, it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Results::
service-type Onap service type and is of type STRING.
resource-version Onap subscription resource version and is of type
STRING.
tenant Onap tenant name and is of type STRING.
region Onap region name and is of type STRING.
cloud Onap cloud name and is of type STRING.
Error::
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
|
