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
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
|
.. 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
==========================
[1] basic-login
-----------------------------------------------
usage: oclip basic-login
Provides HTTP basic authorization support.
Product: open-cli
Service: basic-auth
Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
Options::
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-s | --long]
[-D | --context] [-u | --host-username] [-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 or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-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.
-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::
Authorization Authorization and is of type STRING.
Error::
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[2] basic-logout
-----------------------------------------------
usage: oclip basic-logout
Provides HTTP basic authorization support. As part of logout, it invalidate authoirzation key generated while login.
Product: open-cli
Service: basic-auth
Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
Options::
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-s | --long]
[-D | --context]
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 or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-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.
Error::
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[3] catalog
-----------------------------------------------
usage: oclip catalog
Provides catalog discovery support to find the base api path for given service from product's catalog service.
Any product want to support catalog, it could derive from this command. Currently ONAP uses it and create
derived command by using ONAP MSB service.
Product: open-cli
Service: catalog
Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
Options::
[-m | --host-url] [-C | --no-catalog] [-l | --catalog-service-name]
[-f | --format] [-h | --help] [-V | --verify]
[-t | --no-title] [-d | --debug] [-v | --version]
[-s | --long] [-D | --context] [-i | --catalog-service-version]
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 or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-l | --catalog-service-name service name registered in catalog service. It is
of type STRING. By default, it is .
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-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.
-i | --catalog-service-version service version registered in catalog service. It
is of type STRING. By default, it is .
Results::
catalog-service-host-url Service connection url and is of type STRING.
catalog-service-base-path service base path, to append with host-url for
connecting the service. and is of type STRING.
Error::
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[4] execution-list
-----------------------------------------------
usage: oclip execution-list
List the executions of the given command so far
Product: open-cli
Service: execution
Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
Options::
[-e | --request-id] [-b | --service] [-f | --format]
[-h | --help] [-t | --no-title] [-d | --debug]
[-x | --start-time] [-v | --version] [-n | --command]
[-l | --product] [-y | --end-time] [-s | --long]
[-D | --context] [-c | --profile]
where::
-e | --request-id Request id. It is of type STRING. It is optional.
By default, it is .
-b | --service For a given service. It is of type STRING. It is
optional. By default, it is .
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-x | --start-time From start time. It is of type STRING. It is
optional. By default, it is .
-v | --version print service version. It is of type BOOL.
-n | --command For a given command. It is of type STRING. It is
optional. By default, it is .
-l | --product For a given product version. It is of type
STRING. It is optional. By default, it is .
-y | --end-time Till end time. It is of type STRING. It is
optional. 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.
-c | --profile For a given profile. It is of type STRING. It is
optional. By default, it is .
Results::
request-id Request id and is of type STRING.
execution-id Execution id and is of type STRING.
product Product and is of type STRING.
service service and is of type STRING.
command command and is of type STRING.
profile Profile and is of type STRING.
status Execution status and is of type STRING.
start-time Command execution starting Time and is of type
STRING.
end-time Command execution finishing Time and is of type
STRING.
input Input and is of type STRING.
output Output and is of type STRING.
Error::
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[5] execution-show
-----------------------------------------------
usage: oclip execution-show
Show the complete executions for the given request id
Product: open-cli
Service: execution
Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
Options::
[-l | --execution-id] [-D | --context] [-s | --long]
[-h | --help] [-f | --format] [-t | --no-title]
[-d | --debug] [-v | --version]
where::
-l | --execution-id Execution id. It is of type STRING. By default,
it is .
-D | --context command context. It is of type MAP. It is
optional.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-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.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
Results::
request-id Request id and is of type STRING.
product Product and is of type STRING.
service service and is of type STRING.
command command and is of type STRING.
profile Profile and is of type STRING.
input Input and is of type STRING.
status Execution status and is of type STRING.
start-time Command execution starting Time and is of type
STRING.
end-time Command execution finishing Time and is of type
STRING.
output Output and is of type STRING.
Error::
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[6] product-list
-----------------------------------------------
usage: oclip product-list
List available products registered in OCLIP
Product: open-cli
Service: product
Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
Options::
[-D | --context] [-s | --long] [-h | --help]
[-f | --format] [-t | --no-title] [-d | --debug]
[-v | --version]
where::
-D | --context command context. It is of type MAP. It is
optional.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-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.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
Results::
product Product name and is of type STRING.
description Product description and is of type STRING.
Error::
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[8] schema-list
-----------------------------------------------
usage: oclip schema-list
OCLIP command to list available schema
Product: open-cli
Service: schema
Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
Options::
[-l | --product] [-D | --context] [-s | --long]
[-h | --help] [-f | --format] [-t | --no-title]
[-d | --debug] [-v | --version] [-n | --service]
where::
-l | --product For a given product version. It is of type
STRING. By default, it is .
-D | --context command context. It is of type MAP. It is
optional.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-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.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-n | --service For a given service in a product. It is of type
STRING. It is optional. By default, it is .
Results::
command Command name and is of type STRING.
schema Schema name and is of type STRING.
service Service name and is of type STRING.
ocs-version Schema version and is of type STRING.
type Command type and is of type STRING.
enabled Command is enabled or not and is of type STRING.
rpc Command is executed remotely and is of type
STRING.
Error::
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[9] 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::
[-D | --context] [-s | --long] [-h | --help]
[-f | --format] [-t | --no-title] [-d | --debug]
[-v | --version]
where::
-D | --context command context. It is of type MAP. It is
optional.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-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.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
Results::
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.
enabled Command is enabled or not and is of type STRING.
Error::
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[10] schema-show
-----------------------------------------------
usage: oclip schema-show
OCLIP command to show available schema in JSON format
Product: open-cli
Service: schema
Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
Options::
[-l | --product] [-D | --context] [-s | --long]
[-h | --help] [-f | --format] [-t | --no-title]
[-d | --debug] [-x | --service] [-v | --version]
[-n | --command]
where::
-l | --product For a given product version. It is of type
STRING. By default, it is .
-D | --context command context. It is of type MAP. It is
optional.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-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.
-d | --debug Enable debug output. It is of type BOOL.
-x | --service For a given service. It is of type STRING. It is
optional. By default, it is .
-v | --version print service version. It is of type BOOL.
-n | --command Schema details to fetch. It is of type STRING. By
default, it is .
Results::
schema Scheam json and is of type JSON.
Error::
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[11] schema-switch
-----------------------------------------------
usage: oclip schema-switch
OCLIP command to switch the given command enable/disable
Product: open-cli
Service: schema
Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
Options::
[-l | --name] [-i | --product] [-D | --context]
[-s | --long] [-h | --help] [-f | --format]
[-t | --no-title] [-d | --debug] [-v | --version]
where::
-l | --name Command name. It is of type STRING. By default,
it is .
-i | --product Product name. It is of type STRING. By default,
it is .
-D | --context command context. It is of type MAP. It is
optional.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-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.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
Error::
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[12] schema-validate
-----------------------------------------------
usage: oclip schema-validate
OCLIP command to validate schema
Product: open-cli
Service: schema
Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
Options::
[-D | --context] [-s | --long] [-h | --help]
[-b | --ocs-version] [-f | --format] [-t | --no-title]
[-d | --debug] [-v | --version] [-l | --schema-location]
[-i | --internal-schema]
where::
-D | --context command context. It is of type MAP. It is
optional.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-h | --help print help message. It is of type BOOL.
-b | --ocs-version OCS version. It is of type STRING. It is optional.
-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.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. 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::
error Schema validation error and is of type STRING.
Error::
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[13] service-list
-----------------------------------------------
usage: oclip service-list
List the services in given product registered in OCLIP
Product: open-cli
Service: product
Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
Options::
[-l | --product] [-D | --context] [-s | --long]
[-h | --help] [-f | --format] [-t | --no-title]
[-d | --debug] [-v | --version]
where::
-l | --product For a given product version. It is of type
STRING. By default, it is .
-D | --context command context. It is of type MAP. It is
optional.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-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.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
Results::
service Service name and is of type STRING.
description Product description and is of type STRING.
Error::
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
|
