Add cookbook for OCLIP
[cli.git] / docs / cmd_help.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. Copyright 2017 Huawei Technologies Co., Ltd.
4
5
6 .. toctree::
7    :maxdepth: 2
8
9
10 .. _cli_cmd_help:
11
12 open-cli
13 ==========================
14
15
16 [1] basic-logout
17 -----------------------------------------------
18
19
20 usage: oclip basic-logout
21
22 basic logout auth command
23
24 Product: open-cli
25 Service: basic-auth
26 Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
27
28 Options::
29
30  [-h | --help] [-v | --version] [-d | --debug]
31  [-f | --format] [-s | --long] [-t | --no-title]
32  [-m | --host-url]
33
34 where::
35
36  -h | --help      print help message. It is of type STRING. By
37                   default, it is false.
38  -v | --version   print service version. It is of type STRING. By
39                   default, it is false.
40  -d | --debug     Enable debug output. It is of type BOOL. By
41                   default, it is false.
42  -f | --format    Output formats, supported formats such as table,
43                   csv, json, yaml. It is of type STRING. By
44                   default, it is table.
45  -s | --long      whether to print all attributes or only short
46                   attributes. It is of type BOOL. By default, it is
47                   false.
48  -t | --no-title  whether to print title or not. It is of type
49                   BOOL. By default, it is false.
50  -m | --host-url  host url in http(s). It is of type URL. By
51                   default, it is read from environment variable
52                   OPEN_CLI_HOST_URL.
53
54
55 Error::
56
57  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
58
59
60
61 [2] catalog
62 -----------------------------------------------
63
64
65 usage: oclip catalog
66
67 cli catalog command to find the base path for service.
68
69 Product: open-cli
70 Service: catalog
71 Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
72
73 Options::
74
75  [-h | --help] [-v | --version] [-d | --debug]
76  [-f | --format] [-s | --long] [-t | --no-title]
77  [-l | --catalog-service-name] [-i | --catalog-service-version] [-m | --host-url]
78
79 where::
80
81  -h | --help                      print help message. It is of type STRING. By
82                                   default, it is false.
83  -v | --version                   print service version. It is of type STRING. By
84                                   default, it is false.
85  -d | --debug                     Enable debug output. It is of type BOOL. By
86                                   default, it is false.
87  -f | --format                    Output formats, supported formats such as table,
88                                   csv, json, yaml. It is of type STRING. By
89                                   default, it is table.
90  -s | --long                      whether to print all attributes or only short
91                                   attributes. It is of type BOOL. By default, it is
92                                   false.
93  -t | --no-title                  whether to print title or not. It is of type
94                                   BOOL. By default, it is false.
95  -l | --catalog-service-name      service name registered in catalog service. It is
96                                   of type STRING.
97  -i | --catalog-service-version   service version registered in catalog service. It
98                                   is of type STRING.
99  -m | --host-url                  host url in http(s). It is of type URL. By
100                                   default, it is read from environment variable
101                                   OPEN_CLI_HOST_URL.
102
103
104 Results::
105
106  catalog-service-host-url   Service connection url and is of type STRING.
107  catalog-service-base-path  service base path, to append with host-url for
108                             connecting the service. and is of type STRING.
109
110
111 Error::
112
113  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
114
115
116
117 [3] schema-refresh
118 -----------------------------------------------
119
120
121 usage: oclip schema-refresh
122
123 Oclip command to refresh schemas stored in open-cli-schema folders.
124
125 Product: open-cli
126 Service: schema
127 Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
128
129 Options::
130
131  [-h | --help] [-v | --version] [-d | --debug]
132  [-f | --format] [-s | --long] [-t | --no-title]
133
134 where::
135
136  -h | --help      print help message. It is of type STRING. By
137                   default, it is false.
138  -v | --version   print service version. It is of type STRING. By
139                   default, it is false.
140  -d | --debug     Enable debug output. It is of type BOOL. By
141                   default, it is false.
142  -f | --format    Output formats, supported formats such as table,
143                   csv, json, yaml. It is of type STRING. By
144                   default, it is table.
145  -s | --long      whether to print all attributes or only short
146                   attributes. It is of type BOOL. By default, it is
147                   false.
148  -t | --no-title  whether to print title or not. It is of type
149                   BOOL. By default, it is false.
150
151
152 Results::
153
154  sr.no        Serial Number and is of type STRING.
155  command      Command name and is of type STRING.
156  product      Command product version and is of type STRING.
157  schema       Schema name and is of type STRING.
158  ocs-version  Schema version and is of type STRING.
159  type         Command type and is of type STRING.
160
161
162 Error::
163
164  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
165
166
167
168 [4] schema-validate
169 -----------------------------------------------
170
171
172 usage: oclip schema-validate
173
174 Oclip command to validate schema
175
176 Product: open-cli
177 Service: schema
178 Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
179
180 Options::
181
182  [-h | --help] [-v | --version] [-d | --debug]
183  [-f | --format] [-s | --long] [-t | --no-title]
184  [-l | --schema-location] [-i | --internal-schema] [-b | --ocs-version]
185
186 where::
187
188  -h | --help              print help message. It is of type STRING. By
189                           default, it is false.
190  -v | --version           print service version. It is of type STRING. By
191                           default, it is false.
192  -d | --debug             Enable debug output. It is of type BOOL. By
193                           default, it is false.
194  -f | --format            Output formats, supported formats such as table,
195                           csv, json, yaml. It is of type STRING. By
196                           default, it is table.
197  -s | --long              whether to print all attributes or only short
198                           attributes. It is of type BOOL. By default, it is
199                           false.
200  -t | --no-title          whether to print title or not. It is of type
201                           BOOL. By default, it is false.
202  -l | --schema-location   Schema file location. It is of type URL.
203  -i | --internal-schema   Validate existing schema file. It is of type
204                           BOOL. By default, it is false.
205  -b | --ocs-version       OCS version. It is of type STRING. It is
206                           optional. By default, it is 1.0.
207
208
209 Results::
210
211  sl-no  Serial Number of error and is of type STRING.
212  error  Schema validation error and is of type STRING.
213
214
215 Error::
216
217  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
218
219
220
221 [5] basic-login
222 -----------------------------------------------
223
224
225 usage: oclip basic-login
226
227 basic login auth command
228
229 Product: open-cli
230 Service: basic-auth
231 Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
232
233 Options::
234
235  [-h | --help] [-v | --version] [-d | --debug]
236  [-f | --format] [-s | --long] [-t | --no-title]
237  [-u | --host-username] [-p | --host-password] [-m | --host-url]
238  [-a | --no-auth]
239
240 where::
241
242  -h | --help            print help message. It is of type STRING. By
243                         default, it is false.
244  -v | --version         print service version. It is of type STRING. By
245                         default, it is false.
246  -d | --debug           Enable debug output. It is of type BOOL. By
247                         default, it is false.
248  -f | --format          Output formats, supported formats such as table,
249                         csv, json, yaml. It is of type STRING. By
250                         default, it is table.
251  -s | --long            whether to print all attributes or only short
252                         attributes. It is of type BOOL. By default, it is
253                         false.
254  -t | --no-title        whether to print title or not. It is of type
255                         BOOL. By default, it is false.
256  -u | --host-username   Host user name. It is of type STRING. By default,
257                         it is read from environment variable
258                         OPEN_CLI_HOST_USERNAME.
259  -p | --host-password   Host user password. It is of type STRING. By
260                         default, it is read from environment variable
261                         OPEN_CLI_HOST_PASSWORD. Secured.
262  -m | --host-url        host url in http(s). It is of type URL. By
263                         default, it is read from environment variable
264                         OPEN_CLI_HOST_URL.
265  -a | --no-auth         whether to authenticate user or not. It is of
266                         type BOOL. By default, it is false.
267
268
269 Results::
270
271  Authorization  Authorization and is of type STRING.
272
273
274 Error::
275
276  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
277
278
279
280 onap-amsterdam
281 ==========================
282
283
284 [1] catalog
285 -----------------------------------------------
286
287
288 usage: oclip catalog
289
290 ONAP catalog command to find the base path for service.
291
292 Product: onap-amsterdam
293 Service: msb
294 Author: ONAP CLI Team onap-discuss@lists.onap.org
295
296 Options::
297
298  [-h | --help] [-v | --version] [-d | --debug]
299  [-f | --format] [-s | --long] [-t | --no-title]
300  [-l | --catalog-service-name] [-i | --catalog-service-version] [-m | --host-url]
301
302 where::
303
304  -h | --help                      print help message. It is of type STRING. By
305                                   default, it is false.
306  -v | --version                   print service version. It is of type STRING. By
307                                   default, it is false.
308  -d | --debug                     Enable debug output. It is of type BOOL. By
309                                   default, it is false.
310  -f | --format                    Output formats, supported formats such as table,
311                                   csv, json, yaml. It is of type STRING. By
312                                   default, it is table.
313  -s | --long                      whether to print all attributes or only short
314                                   attributes. It is of type BOOL. By default, it is
315                                   false.
316  -t | --no-title                  whether to print title or not. It is of type
317                                   BOOL. By default, it is false.
318  -l | --catalog-service-name      service name registered in catalog service. It is
319                                   of type STRING.
320  -i | --catalog-service-version   service version registered in catalog service. It
321                                   is of type STRING.
322  -m | --host-url                  host url in http(s). It is of type URL. By
323                                   default, it is read from environment variable
324                                   OPEN_CLI_HOST_URL.
325
326
327 Results::
328
329  catalog-service-host-url   Service connection url and is of type STRING.
330  catalog-service-base-path  service base path, to append with host-url for
331                             connecting the service. and is of type STRING.
332
333
334 Error::
335
336  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
337
338
339
340 [2] sdc-basic-login
341 -----------------------------------------------
342
343
344 usage: oclip sdc-basic-login
345
346 ONAP basic login auth command
347
348 Product: onap-amsterdam
349 Service: sdc-basic-auth
350 Author: ONAP CLI Team onap-discuss@lists.onap.org
351
352 Options::
353
354  [-h | --help] [-v | --version] [-d | --debug]
355  [-f | --format] [-s | --long] [-t | --no-title]
356  [-u | --host-username] [-p | --host-password] [-m | --host-url]
357  [-a | --no-auth]
358
359 where::
360
361  -h | --help            print help message. It is of type STRING. By
362                         default, it is false.
363  -v | --version         print service version. It is of type STRING. By
364                         default, it is false.
365  -d | --debug           Enable debug output. It is of type BOOL. By
366                         default, it is false.
367  -f | --format          Output formats, supported formats such as table,
368                         csv, json, yaml. It is of type STRING. By
369                         default, it is table.
370  -s | --long            whether to print all attributes or only short
371                         attributes. It is of type BOOL. By default, it is
372                         false.
373  -t | --no-title        whether to print title or not. It is of type
374                         BOOL. By default, it is false.
375  -u | --host-username   Host user name. It is of type STRING. By default,
376                         it is read from environment variable
377                         OPEN_CLI_HOST_USERNAME.
378  -p | --host-password   Host user password. It is of type STRING. By
379                         default, it is read from environment variable
380                         OPEN_CLI_HOST_PASSWORD. Secured.
381  -m | --host-url        host url in http(s). It is of type URL. By
382                         default, it is read from environment variable
383                         OPEN_CLI_HOST_URL.
384  -a | --no-auth         whether to authenticate user or not. It is of
385                         type BOOL. By default, it is false.
386
387
388 Results::
389
390  Authorization    Authorization and is of type STRING.
391  X-TransactionId  X-TransactionId and is of type STRING.
392  X-FromAppId      X-FromAppId and is of type STRING.
393  USER_ID          USER_ID for sdc and is of type STRING.
394
395
396 Error::
397
398  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
399
400
401
402 [3] basic-login
403 -----------------------------------------------
404
405
406 usage: oclip basic-login
407
408 ONAP basic login auth command
409
410 Product: onap-amsterdam
411 Service: basic-auth
412 Author: ONAP CLI Team onap-discuss@lists.onap.org
413
414 Options::
415
416  [-h | --help] [-v | --version] [-d | --debug]
417  [-f | --format] [-s | --long] [-t | --no-title]
418  [-u | --host-username] [-p | --host-password] [-m | --host-url]
419  [-a | --no-auth]
420
421 where::
422
423  -h | --help            print help message. It is of type STRING. By
424                         default, it is false.
425  -v | --version         print service version. It is of type STRING. By
426                         default, it is false.
427  -d | --debug           Enable debug output. It is of type BOOL. By
428                         default, it is false.
429  -f | --format          Output formats, supported formats such as table,
430                         csv, json, yaml. It is of type STRING. By
431                         default, it is table.
432  -s | --long            whether to print all attributes or only short
433                         attributes. It is of type BOOL. By default, it is
434                         false.
435  -t | --no-title        whether to print title or not. It is of type
436                         BOOL. By default, it is false.
437  -u | --host-username   Host user name. It is of type STRING. By default,
438                         it is read from environment variable
439                         OPEN_CLI_HOST_USERNAME.
440  -p | --host-password   Host user password. It is of type STRING. By
441                         default, it is read from environment variable
442                         OPEN_CLI_HOST_PASSWORD. Secured.
443  -m | --host-url        host url in http(s). It is of type URL. By
444                         default, it is read from environment variable
445                         OPEN_CLI_HOST_URL.
446  -a | --no-auth         whether to authenticate user or not. It is of
447                         type BOOL. By default, it is false.
448
449
450 Results::
451
452  Authorization    Authorization and is of type STRING.
453  X-TransactionId  X-TransactionId and is of type STRING.
454  X-FromAppId      X-FromAppId and is of type STRING.
455
456
457 Error::
458
459  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
460
461
462
463 [4] basic-logout
464 -----------------------------------------------
465
466
467 usage: oclip basic-logout
468
469 ONAP basic logout auth command
470
471 Product: onap-amsterdam
472 Service: basic-auth
473 Author: ONAP CLI Team onap-discuss@lists.onap.org
474
475 Options::
476
477  [-h | --help] [-v | --version] [-d | --debug]
478  [-f | --format] [-s | --long] [-t | --no-title]
479  [-m | --host-url]
480
481 where::
482
483  -h | --help      print help message. It is of type STRING. By
484                   default, it is false.
485  -v | --version   print service version. It is of type STRING. By
486                   default, it is false.
487  -d | --debug     Enable debug output. It is of type BOOL. By
488                   default, it is false.
489  -f | --format    Output formats, supported formats such as table,
490                   csv, json, yaml. It is of type STRING. By
491                   default, it is table.
492  -s | --long      whether to print all attributes or only short
493                   attributes. It is of type BOOL. By default, it is
494                   false.
495  -t | --no-title  whether to print title or not. It is of type
496                   BOOL. By default, it is false.
497  -m | --host-url  host url in http(s). It is of type URL. By
498                   default, it is read from environment variable
499                   OPEN_CLI_HOST_URL.
500
501
502 Error::
503
504  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
505
506
507
508 [5] service-delete
509 -----------------------------------------------
510
511
512 usage: oclip service-delete
513
514 Delete service instance (experimental)
515
516 Product: onap-amsterdam
517 Service: so
518 Author: ONAP CLI Team onap-discuss@lists.onap.org
519
520 Options::
521
522  [-h | --help] [-v | --version] [-d | --debug]
523  [-f | --format] [-s | --long] [-t | --no-title]
524  [-x | --service-instace-id] [-b | --model-invariant-id] [-i | --model-uuid]
525  [-e | --model-name] [-g | --model-version] [-c | --customer-name]
526  [-j | --cloud-region] [-k | --tenant-id] [-u | --host-username]
527  [-p | --host-password] [-m | --host-url] [-a | --no-auth]
528
529 where::
530
531  -h | --help                print help message. It is of type STRING. By
532                             default, it is false.
533  -v | --version             print service version. It is of type STRING. By
534                             default, it is false.
535  -d | --debug               Enable debug output. It is of type BOOL. By
536                             default, it is false.
537  -f | --format              Output formats, supported formats such as table,
538                             csv, json, yaml. It is of type STRING. By
539                             default, it is table.
540  -s | --long                whether to print all attributes or only short
541                             attributes. It is of type BOOL. By default, it is
542                             false.
543  -t | --no-title            whether to print title or not. It is of type
544                             BOOL. By default, it is false.
545  -x | --service-instace-id  unique id for service instance. It is of type
546                             STRING.
547  -b | --model-invariant-id  model invariant id for service in SDC catalog. It
548                             is of type STRING.
549  -i | --model-uuid          model uuid for service in SDC catalog. It is of
550                             type STRING.
551  -e | --model-name          model name available in SDC catalog. It is of
552                             type STRING.
553  -g | --model-version       model version of service (eg. 1.0). It is of type
554                             STRING.
555  -c | --customer-name       unique id for customer. It is of type STRING.
556  -j | --cloud-region        cloud region id. It is of type STRING.
557  -k | --tenant-id           tenant id. It is of type STRING.
558  -u | --host-username       Host user name. It is of type STRING. By default,
559                             it is read from environment variable
560                             OPEN_CLI_HOST_USERNAME.
561  -p | --host-password       Host user password. It is of type STRING. By
562                             default, it is read from environment variable
563                             OPEN_CLI_HOST_PASSWORD. Secured.
564  -m | --host-url            host url in http(s). It is of type URL. By
565                             default, it is read from environment variable
566                             OPEN_CLI_HOST_URL.
567  -a | --no-auth             whether to authenticate user or not. It is of
568                             type BOOL. By default, it is false.
569
570
571 Error::
572
573  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
574
575
576
577 [6] vf-module-create
578 -----------------------------------------------
579
580
581 usage: oclip vf-module-create
582
583 Create a VF Module
584
585 Product: onap-amsterdam
586 Service: so
587 Author: ONAP CLI Team onap-discuss@lists.onap.org
588
589 Options::
590
591  [-h | --help] [-v | --version] [-d | --debug]
592  [-f | --format] [-s | --long] [-t | --no-title]
593  [-l | --lcp-cloudregion-id] [-w | --tenant-id] [-y | --vnf-instace-id]
594  [-x | --service-instace-id] [-z | --parenet-service-model] [-r | --supress-rollback]
595  [-i | --instance-name] [-u | --host-username] [-p | --host-password]
596  [-m | --host-url] [-a | --no-auth]
597
598 where::
599
600  -h | --help                    print help message. It is of type STRING. By
601                                 default, it is false.
602  -v | --version                 print service version. It is of type STRING. By
603                                 default, it is false.
604  -d | --debug                   Enable debug output. It is of type BOOL. By
605                                 default, it is false.
606  -f | --format                  Output formats, supported formats such as table,
607                                 csv, json, yaml. It is of type STRING. By
608                                 default, it is table.
609  -s | --long                    whether to print all attributes or only short
610                                 attributes. It is of type BOOL. By default, it is
611                                 false.
612  -t | --no-title                whether to print title or not. It is of type
613                                 BOOL. By default, it is false.
614  -l | --lcp-cloudregion-id      AIC LCP node location identifier. It is of type
615                                 STRING.
616  -w | --tenant-id               openstack tenant id (uuid). It is of type STRING.
617  -y | --vnf-instace-id          vnf instance id. It is of type STRING.
618  -x | --service-instace-id      unique id for service instance. It is of type
619                                 STRING.
620  -z | --parenet-service-model   parent service model name. It is of type STRING.
621  -r | --supress-rollback        rollback changes if instantiation fails. It is of
622                                 type BOOL. It is optional. By default, it is
623                                 false.
624  -i | --instance-name           service instance name. It is of type STRING.
625  -u | --host-username           Host user name. It is of type STRING. By default,
626                                 it is read from environment variable
627                                 OPEN_CLI_HOST_USERNAME.
628  -p | --host-password           Host user password. It is of type STRING. By
629                                 default, it is read from environment variable
630                                 OPEN_CLI_HOST_PASSWORD. Secured.
631  -m | --host-url                host url in http(s). It is of type URL. By
632                                 default, it is read from environment variable
633                                 OPEN_CLI_HOST_URL.
634  -a | --no-auth                 whether to authenticate user or not. It is of
635                                 type BOOL. By default, it is false.
636
637
638 Error::
639
640  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
641
642
643
644 [7] vfmodule-delete
645 -----------------------------------------------
646
647
648 usage: oclip vfmodule-delete
649
650 delete a VF module (experimental)
651
652 Product: onap-amsterdam
653 Service: so
654 Author: ONAP CLI Team onap-discuss@lists.onap.org
655
656 Options::
657
658  [-h | --help] [-v | --version] [-d | --debug]
659  [-f | --format] [-s | --long] [-t | --no-title]
660  [-x | --vfmodule-id] [-j | --service-id] [-y | --vf-id]
661  [-k | --vf-model-invariant-id] [-e | --vfmodule-name] [-g | --vfmodule-version]
662  [-l | --cloud-region] [-z | --tenant-id] [-u | --host-username]
663  [-p | --host-password] [-m | --host-url] [-a | --no-auth]
664
665 where::
666
667  -h | --help                    print help message. It is of type STRING. By
668                                 default, it is false.
669  -v | --version                 print service version. It is of type STRING. By
670                                 default, it is false.
671  -d | --debug                   Enable debug output. It is of type BOOL. By
672                                 default, it is false.
673  -f | --format                  Output formats, supported formats such as table,
674                                 csv, json, yaml. It is of type STRING. By
675                                 default, it is table.
676  -s | --long                    whether to print all attributes or only short
677                                 attributes. It is of type BOOL. By default, it is
678                                 false.
679  -t | --no-title                whether to print title or not. It is of type
680                                 BOOL. By default, it is false.
681  -x | --vfmodule-id             VF module Id. It is of type STRING.
682  -j | --service-id              unique id for service. It is of type STRING.
683  -y | --vf-id                   unique id for related VF. It is of type STRING.
684  -k | --vf-model-invariant-id   vf model invariant id. It is of type STRING.
685  -e | --vfmodule-name           vfmodule model name. It is of type STRING.
686  -g | --vfmodule-version        vf module version. It is of type STRING.
687  -l | --cloud-region            cloud region identifier. It is of type STRING.
688  -z | --tenant-id               openstack tenant id. It is of type STRING.
689  -u | --host-username           Host user name. It is of type STRING. By default,
690                                 it is read from environment variable
691                                 OPEN_CLI_HOST_USERNAME.
692  -p | --host-password           Host user password. It is of type STRING. By
693                                 default, it is read from environment variable
694                                 OPEN_CLI_HOST_PASSWORD. Secured.
695  -m | --host-url                host url in http(s). It is of type URL. By
696                                 default, it is read from environment variable
697                                 OPEN_CLI_HOST_URL.
698  -a | --no-auth                 whether to authenticate user or not. It is of
699                                 type BOOL. By default, it is false.
700
701
702 Error::
703
704  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
705
706
707
708 [8] vfmodule-create
709 -----------------------------------------------
710
711
712 usage: oclip vfmodule-create
713
714 Create a VF module
715
716 Product: onap-amsterdam
717 Service: so
718 Author: ONAP CLI Team onap-discuss@lists.onap.org
719
720 Options::
721
722  [-h | --help] [-v | --version] [-d | --debug]
723  [-f | --format] [-s | --long] [-t | --no-title]
724  [-l | --cloud-region] [-B | --tenant-id] [-b | --vfmodule-invariant-id]
725  [-c | --vfmodule-uuid] [-e | --vfmodule-name] [-g | --vfmodule-version]
726  [-i | --module-name] [-j | --service-id] [-y | --vf-id]
727  [-k | --vf-model-invariant-id] [-A | --vf-model-uuid] [-n | --vf-model-name]
728  [-o | --vf-model-version] [-q | --vf-model-customization-id] [-r | --service-model-invariant-id]
729  [-w | --service-model-uuid] [-x | --service-model-name] [-z | --service-model-version]
730  [-u | --host-username] [-p | --host-password] [-m | --host-url]
731  [-a | --no-auth]
732
733 where::
734
735  -h | --help                        print help message. It is of type STRING. By
736                                     default, it is false.
737  -v | --version                     print service version. It is of type STRING. By
738                                     default, it is false.
739  -d | --debug                       Enable debug output. It is of type BOOL. By
740                                     default, it is false.
741  -f | --format                      Output formats, supported formats such as table,
742                                     csv, json, yaml. It is of type STRING. By
743                                     default, it is table.
744  -s | --long                        whether to print all attributes or only short
745                                     attributes. It is of type BOOL. By default, it is
746                                     false.
747  -t | --no-title                    whether to print title or not. It is of type
748                                     BOOL. By default, it is false.
749  -l | --cloud-region                cloud region identifier. It is of type STRING.
750  -B | --tenant-id                   openstack tenant id. It is of type STRING.
751  -b | --vfmodule-invariant-id       vfmodule model invariant id. It is of type STRING.
752  -c | --vfmodule-uuid               model uuid for vfmodule. It is of type STRING.
753  -e | --vfmodule-name               vfmodule model name. It is of type STRING.
754  -g | --vfmodule-version            vf module version. It is of type STRING.
755  -i | --module-name                 vfmodule name. It is of type STRING.
756  -j | --service-id                  unique id for service. It is of type STRING.
757  -y | --vf-id                       unique id for related VF. It is of type STRING.
758  -k | --vf-model-invariant-id       vf model invariant id. It is of type STRING.
759  -A | --vf-model-uuid               model uuid for vf. It is of type STRING.
760  -n | --vf-model-name               vf model name. It is of type STRING.
761  -o | --vf-model-version            vf model version. It is of type STRING.
762  -q | --vf-model-customization-id   vf model customization id. This can be obtained
763                                     using SDC portal (Home -> service:xxx ->
764                                     Composition -> click on VF for customization id).
765                                     It is of type STRING.
766  -r | --service-model-invariant-id  model invariant id. It is of type STRING.
767  -w | --service-model-uuid          model name version id. It is of type STRING.
768  -x | --service-model-name          service model name. It is of type STRING.
769  -z | --service-model-version       service model version. It is of type STRING.
770  -u | --host-username               Host user name. It is of type STRING. By default,
771                                     it is read from environment variable
772                                     OPEN_CLI_HOST_USERNAME.
773  -p | --host-password               Host user password. It is of type STRING. By
774                                     default, it is read from environment variable
775                                     OPEN_CLI_HOST_PASSWORD. Secured.
776  -m | --host-url                    host url in http(s). It is of type URL. By
777                                     default, it is read from environment variable
778                                     OPEN_CLI_HOST_URL.
779  -a | --no-auth                     whether to authenticate user or not. It is of
780                                     type BOOL. By default, it is false.
781
782
783 Results::
784
785  vfmodule-id  id for the created vnf and is of type STRING.
786
787
788 Error::
789
790  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
791
792
793
794 [9] vf-create
795 -----------------------------------------------
796
797
798 usage: oclip vf-create
799
800 Create a VF
801
802 Product: onap-amsterdam
803 Service: so
804 Author: ONAP CLI Team onap-discuss@lists.onap.org
805
806 Options::
807
808  [-h | --help] [-v | --version] [-d | --debug]
809  [-f | --format] [-s | --long] [-t | --no-title]
810  [-l | --cloud-region] [-z | --tenant-id] [-w | --product-family]
811  [-o | --instance-name] [-y | --service-instance-id] [-b | --vf-model-invariant-id]
812  [-c | --vf-model-uuid] [-e | --vf-model-name] [-g | --vf-model-version]
813  [-i | --vf-model-customization-id] [-j | --service-model-invariant-id] [-k | --service-model-uuid]
814  [-q | --service-model-name] [-n | --service-model-version] [-u | --host-username]
815  [-p | --host-password] [-m | --host-url] [-a | --no-auth]
816
817 where::
818
819  -h | --help                        print help message. It is of type STRING. By
820                                     default, it is false.
821  -v | --version                     print service version. It is of type STRING. By
822                                     default, it is false.
823  -d | --debug                       Enable debug output. It is of type BOOL. By
824                                     default, it is false.
825  -f | --format                      Output formats, supported formats such as table,
826                                     csv, json, yaml. It is of type STRING. By
827                                     default, it is table.
828  -s | --long                        whether to print all attributes or only short
829                                     attributes. It is of type BOOL. By default, it is
830                                     false.
831  -t | --no-title                    whether to print title or not. It is of type
832                                     BOOL. By default, it is false.
833  -l | --cloud-region                cloud region identifier. It is of type STRING.
834  -z | --tenant-id                   openstack tenant id. It is of type STRING.
835  -w | --product-family              service type for serivce (e.g. vLB). It is of
836                                     type STRING.
837  -o | --instance-name               service instance name. It is of type STRING.
838  -y | --service-instance-id         unique id for service instance. It is of type
839                                     STRING.
840  -b | --vf-model-invariant-id       vf model invariant id. It is of type STRING.
841  -c | --vf-model-uuid               model uuid for vf. It is of type STRING.
842  -e | --vf-model-name               vf model name. It is of type STRING.
843  -g | --vf-model-version            vf model version. It is of type STRING.
844  -i | --vf-model-customization-id   vf model customization id. It is of type STRING.
845  -j | --service-model-invariant-id  model invariant id. It is of type STRING.
846  -k | --service-model-uuid          model name version id. It is of type STRING.
847  -q | --service-model-name          service model name. It is of type STRING.
848  -n | --service-model-version       service model version. It is of type STRING.
849  -u | --host-username               Host user name. It is of type STRING. By default,
850                                     it is read from environment variable
851                                     OPEN_CLI_HOST_USERNAME.
852  -p | --host-password               Host user password. It is of type STRING. By
853                                     default, it is read from environment variable
854                                     OPEN_CLI_HOST_PASSWORD. Secured.
855  -m | --host-url                    host url in http(s). It is of type URL. By
856                                     default, it is read from environment variable
857                                     OPEN_CLI_HOST_URL.
858  -a | --no-auth                     whether to authenticate user or not. It is of
859                                     type BOOL. By default, it is false.
860
861
862 Results::
863
864  vf-id  id for the created vnf and is of type STRING.
865
866
867 Error::
868
869  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
870
871
872
873 [10] service-create
874 -----------------------------------------------
875
876
877 usage: oclip service-create
878
879 Create a service instance using MSO
880
881 Product: onap-amsterdam
882 Service: so
883 Author: ONAP CLI Team onap-discuss@lists.onap.org
884
885 Options::
886
887  [-h | --help] [-v | --version] [-d | --debug]
888  [-f | --format] [-s | --long] [-t | --no-title]
889  [-l | --cloud-region] [-b | --tenant-id] [-e | --model-invariant-id]
890  [-g | --model-uuid] [-i | --model-name] [-j | --model-version]
891  [-c | --customer] [-k | --instance-name] [-r | --supress-rollback]
892  [-w | --service-type] [-u | --host-username] [-p | --host-password]
893  [-m | --host-url] [-a | --no-auth]
894
895 where::
896
897  -h | --help                print help message. It is of type STRING. By
898                             default, it is false.
899  -v | --version             print service version. It is of type STRING. By
900                             default, it is false.
901  -d | --debug               Enable debug output. It is of type BOOL. By
902                             default, it is false.
903  -f | --format              Output formats, supported formats such as table,
904                             csv, json, yaml. It is of type STRING. By
905                             default, it is table.
906  -s | --long                whether to print all attributes or only short
907                             attributes. It is of type BOOL. By default, it is
908                             false.
909  -t | --no-title            whether to print title or not. It is of type
910                             BOOL. By default, it is false.
911  -l | --cloud-region        cloud region identifier. It is of type STRING.
912  -b | --tenant-id           tenant id. It is of type STRING.
913  -e | --model-invariant-id  model invariant id generated by ASDC. It is of
914                             type STRING.
915  -g | --model-uuid          model uuid generated by ASDC. It is of type
916                             STRING.
917  -i | --model-name          model name as provided in ASDC design time. It is
918                             of type STRING.
919  -j | --model-version       model-version. It is of type STRING.
920  -c | --customer            unique id for customer. It is of type STRING.
921  -k | --instance-name       service instance name. It is of type STRING.
922  -r | --supress-rollback    rollback changes if instantiation fails. It is of
923                             type BOOL. It is optional. By default, it is
924                             false.
925  -w | --service-type        subscription service type. It is of type STRING.
926  -u | --host-username       Host user name. It is of type STRING. By default,
927                             it is read from environment variable
928                             OPEN_CLI_HOST_USERNAME.
929  -p | --host-password       Host user password. It is of type STRING. By
930                             default, it is read from environment variable
931                             OPEN_CLI_HOST_PASSWORD. Secured.
932  -m | --host-url            host url in http(s). It is of type URL. By
933                             default, it is read from environment variable
934                             OPEN_CLI_HOST_URL.
935  -a | --no-auth             whether to authenticate user or not. It is of
936                             type BOOL. By default, it is false.
937
938
939 Results::
940
941  service-id   instance id for the created service. and is of
942               type STRING.
943
944
945 Error::
946
947  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
948
949
950
951 [11] vf-delete
952 -----------------------------------------------
953
954
955 usage: oclip vf-delete
956
957 delete a VF (experimental)
958
959 Product: onap-amsterdam
960 Service: so
961 Author: ONAP CLI Team onap-discuss@lists.onap.org
962
963 Options::
964
965  [-h | --help] [-v | --version] [-d | --debug]
966  [-f | --format] [-s | --long] [-t | --no-title]
967  [-x | --vf-id] [-y | --service-instance-id] [-l | --cloud-region]
968  [-z | --tenant-id] [-b | --model-invariant-id] [-c | --model-uuid]
969  [-e | --model-name] [-g | --model-version] [-u | --host-username]
970  [-p | --host-password] [-m | --host-url] [-a | --no-auth]
971
972 where::
973
974  -h | --help                  print help message. It is of type STRING. By
975                               default, it is false.
976  -v | --version               print service version. It is of type STRING. By
977                               default, it is false.
978  -d | --debug                 Enable debug output. It is of type BOOL. By
979                               default, it is false.
980  -f | --format                Output formats, supported formats such as table,
981                               csv, json, yaml. It is of type STRING. By
982                               default, it is table.
983  -s | --long                  whether to print all attributes or only short
984                               attributes. It is of type BOOL. By default, it is
985                               false.
986  -t | --no-title              whether to print title or not. It is of type
987                               BOOL. By default, it is false.
988  -x | --vf-id                 id for vnf. It is of type STRING.
989  -y | --service-instance-id   unique id for service instance. It is of type
990                               STRING.
991  -l | --cloud-region          Cloud region ID. It is of type STRING.
992  -z | --tenant-id             openstack tenant id (uuid). It is of type STRING.
993  -b | --model-invariant-id    model invariant id for service in SDC catalog. It
994                               is of type STRING.
995  -c | --model-uuid            model uuid for service in SDC catalog. It is of
996                               type STRING.
997  -e | --model-name            model name available in SDC catalog. It is of
998                               type STRING.
999  -g | --model-version         model version of service (eg. 1.0). It is of type
1000                               STRING.
1001  -u | --host-username         Host user name. It is of type STRING. By default,
1002                               it is read from environment variable
1003                               OPEN_CLI_HOST_USERNAME.
1004  -p | --host-password         Host user password. It is of type STRING. By
1005                               default, it is read from environment variable
1006                               OPEN_CLI_HOST_PASSWORD. Secured.
1007  -m | --host-url              host url in http(s). It is of type URL. By
1008                               default, it is read from environment variable
1009                               OPEN_CLI_HOST_URL.
1010  -a | --no-auth               whether to authenticate user or not. It is of
1011                               type BOOL. By default, it is false.
1012
1013
1014 Error::
1015
1016  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
1017
1018
1019
1020 [12] service-model-add-vf
1021 -----------------------------------------------
1022
1023
1024 usage: oclip service-model-add-vf
1025
1026 Helps to add VF into service models in SDC
1027
1028 Product: onap-amsterdam
1029 Service: sdc
1030 Author: ONAP CLI Team onap-discuss@lists.onap.org
1031
1032 Options::
1033
1034  [-h | --help] [-v | --version] [-d | --debug]
1035  [-f | --format] [-s | --long] [-t | --no-title]
1036  [-x | --service-model-id] [-y | --vf-id] [-z | --vf-name]
1037  [-b | --vf-version] [-u | --host-username] [-p | --host-password]
1038  [-m | --host-url] [-a | --no-auth]
1039
1040 where::
1041
1042  -h | --help              print help message. It is of type STRING. By
1043                           default, it is false.
1044  -v | --version           print service version. It is of type STRING. By
1045                           default, it is false.
1046  -d | --debug             Enable debug output. It is of type BOOL. By
1047                           default, it is false.
1048  -f | --format            Output formats, supported formats such as table,
1049                           csv, json, yaml. It is of type STRING. By
1050                           default, it is table.
1051  -s | --long              whether to print all attributes or only short
1052                           attributes. It is of type BOOL. By default, it is
1053                           false.
1054  -t | --no-title          whether to print title or not. It is of type
1055                           BOOL. By default, it is false.
1056  -x | --service-model-id  Onap Service Name. It is of type STRING.
1057  -y | --vf-id             VF ID. It is of type STRING. It is optional.
1058  -z | --vf-name           VF ID. It is of type STRING. It is optional.
1059  -b | --vf-version        VF version. It is of type STRING. It is optional.
1060  -u | --host-username     Host user name. It is of type STRING. By default,
1061                           it is read from environment variable
1062                           OPEN_CLI_HOST_USERNAME.
1063  -p | --host-password     Host user password. It is of type STRING. By
1064                           default, it is read from environment variable
1065                           OPEN_CLI_HOST_PASSWORD. Secured.
1066  -m | --host-url          host url in http(s). It is of type URL. By
1067                           default, it is read from environment variable
1068                           OPEN_CLI_HOST_URL.
1069  -a | --no-auth           whether to authenticate user or not. It is of
1070                           type BOOL. By default, it is false.
1071
1072
1073 Results::
1074
1075  ID   Service ID and is of type STRING.
1076
1077
1078 Error::
1079
1080  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
1081
1082
1083
1084 [13] vsp-revert
1085 -----------------------------------------------
1086
1087
1088 usage: oclip vsp-revert
1089
1090 Revert Vendor Software Product
1091
1092 Product: onap-amsterdam
1093 Service: sdc
1094 Author: ONAP CLI Team onap-discuss@lists.onap.org
1095
1096 Options::
1097
1098  [-h | --help] [-v | --version] [-d | --debug]
1099  [-f | --format] [-s | --long] [-t | --no-title]
1100  [-x | --vsp-id] [-y | --vsp-version] [-u | --host-username]
1101  [-p | --host-password] [-m | --host-url] [-a | --no-auth]
1102
1103 where::
1104
1105  -h | --help            print help message. It is of type STRING. By
1106                         default, it is false.
1107  -v | --version         print service version. It is of type STRING. By
1108                         default, it is false.
1109  -d | --debug           Enable debug output. It is of type BOOL. By
1110                         default, it is false.
1111  -f | --format          Output formats, supported formats such as table,
1112                         csv, json, yaml. It is of type STRING. By
1113                         default, it is table.
1114  -s | --long            whether to print all attributes or only short
1115                         attributes. It is of type BOOL. By default, it is
1116                         false.
1117  -t | --no-title        whether to print title or not. It is of type
1118                         BOOL. By default, it is false.
1119  -x | --vsp-id          Onap VSP ID. It is of type STRING.
1120  -y | --vsp-version     VSP version. It is of type STRING.
1121  -u | --host-username   Host user name. It is of type STRING. By default,
1122                         it is read from environment variable
1123                         OPEN_CLI_HOST_USERNAME.
1124  -p | --host-password   Host user password. It is of type STRING. By
1125                         default, it is read from environment variable
1126                         OPEN_CLI_HOST_PASSWORD. Secured.
1127  -m | --host-url        host url in http(s). It is of type URL. By
1128                         default, it is read from environment variable
1129                         OPEN_CLI_HOST_URL.
1130  -a | --no-auth         whether to authenticate user or not. It is of
1131                         type BOOL. By default, it is false.
1132
1133
1134 Error::
1135
1136  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
1137
1138
1139
1140 [14] vsp-validate
1141 -----------------------------------------------
1142
1143
1144 usage: oclip vsp-validate
1145
1146 Validated the uploaded Vendor Software Product
1147
1148 Product: onap-amsterdam
1149 Service: sdc
1150 Author: ONAP CLI Team onap-discuss@lists.onap.org
1151
1152 Options::
1153
1154  [-h | --help] [-v | --version] [-d | --debug]
1155  [-f | --format] [-s | --long] [-t | --no-title]
1156  [-x | --vsp-id] [-y | --vsp-version] [-u | --host-username]
1157  [-p | --host-password] [-m | --host-url] [-a | --no-auth]
1158
1159 where::
1160
1161  -h | --help            print help message. It is of type STRING. By
1162                         default, it is false.
1163  -v | --version         print service version. It is of type STRING. By
1164                         default, it is false.
1165  -d | --debug           Enable debug output. It is of type BOOL. By
1166                         default, it is false.
1167  -f | --format          Output formats, supported formats such as table,
1168                         csv, json, yaml. It is of type STRING. By
1169                         default, it is table.
1170  -s | --long            whether to print all attributes or only short
1171                         attributes. It is of type BOOL. By default, it is
1172                         false.
1173  -t | --no-title        whether to print title or not. It is of type
1174                         BOOL. By default, it is false.
1175  -x | --vsp-id          Onap VSP ID. It is of type STRING.
1176  -y | --vsp-version     VSP version. It is of type STRING.
1177  -u | --host-username   Host user name. It is of type STRING. By default,
1178                         it is read from environment variable
1179                         OPEN_CLI_HOST_USERNAME.
1180  -p | --host-password   Host user password. It is of type STRING. By
1181                         default, it is read from environment variable
1182                         OPEN_CLI_HOST_PASSWORD. Secured.
1183  -m | --host-url        host url in http(s). It is of type URL. By
1184                         default, it is read from environment variable
1185                         OPEN_CLI_HOST_URL.
1186  -a | --no-auth         whether to authenticate user or not. It is of
1187                         type BOOL. By default, it is false.
1188
1189
1190 Results::
1191
1192  status   Validation status and is of type STRING.
1193  errors   Validation messages and is of type JSON.
1194
1195
1196 Error::
1197
1198  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
1199
1200
1201
1202 [15] service-model-approve
1203 -----------------------------------------------
1204
1205
1206 usage: oclip service-model-approve
1207
1208 Approves the Service model in SDC
1209
1210 Product: onap-amsterdam
1211 Service: sdc
1212 Author: ONAP CLI Team onap-discuss@lists.onap.org
1213
1214 Options::
1215
1216  [-h | --help] [-v | --version] [-d | --debug]
1217  [-f | --format] [-s | --long] [-t | --no-title]
1218  [-b | --service-model-id] [-u | --host-username] [-p | --host-password]
1219  [-m | --host-url] [-a | --no-auth]
1220
1221 where::
1222
1223  -h | --help              print help message. It is of type STRING. By
1224                           default, it is false.
1225  -v | --version           print service version. It is of type STRING. By
1226                           default, it is false.
1227  -d | --debug             Enable debug output. It is of type BOOL. By
1228                           default, it is false.
1229  -f | --format            Output formats, supported formats such as table,
1230                           csv, json, yaml. It is of type STRING. By
1231                           default, it is table.
1232  -s | --long              whether to print all attributes or only short
1233                           attributes. It is of type BOOL. By default, it is
1234                           false.
1235  -t | --no-title          whether to print title or not. It is of type
1236                           BOOL. By default, it is false.
1237  -b | --service-model-id  Service model ID. It is of type STRING. It is
1238                           optional.
1239  -u | --host-username     Host user name. It is of type STRING. By default,
1240                           it is read from environment variable
1241                           OPEN_CLI_HOST_USERNAME.
1242  -p | --host-password     Host user password. It is of type STRING. By
1243                           default, it is read from environment variable
1244                           OPEN_CLI_HOST_PASSWORD. Secured.
1245  -m | --host-url          host url in http(s). It is of type URL. By
1246                           default, it is read from environment variable
1247                           OPEN_CLI_HOST_URL.
1248  -a | --no-auth           whether to authenticate user or not. It is of
1249                           type BOOL. By default, it is false.
1250
1251
1252 Error::
1253
1254  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
1255
1256
1257
1258 [16] service-model-certify-start
1259 -----------------------------------------------
1260
1261
1262 usage: oclip service-model-certify-start
1263
1264 Starts the certification of Service model in SDC
1265
1266 Product: onap-amsterdam
1267 Service: sdc
1268 Author: ONAP CLI Team onap-discuss@lists.onap.org
1269
1270 Options::
1271
1272  [-h | --help] [-v | --version] [-d | --debug]
1273  [-f | --format] [-s | --long] [-t | --no-title]
1274  [-b | --service-model-id] [-u | --host-username] [-p | --host-password]
1275  [-m | --host-url] [-a | --no-auth]
1276
1277 where::
1278
1279  -h | --help              print help message. It is of type STRING. By
1280                           default, it is false.
1281  -v | --version           print service version. It is of type STRING. By
1282                           default, it is false.
1283  -d | --debug             Enable debug output. It is of type BOOL. By
1284                           default, it is false.
1285  -f | --format            Output formats, supported formats such as table,
1286                           csv, json, yaml. It is of type STRING. By
1287                           default, it is table.
1288  -s | --long              whether to print all attributes or only short
1289                           attributes. It is of type BOOL. By default, it is
1290                           false.
1291  -t | --no-title          whether to print title or not. It is of type
1292                           BOOL. By default, it is false.
1293  -b | --service-model-id  Service model ID. It is of type STRING. It is
1294                           optional.
1295  -u | --host-username     Host user name. It is of type STRING. By default,
1296                           it is read from environment variable
1297                           OPEN_CLI_HOST_USERNAME.
1298  -p | --host-password     Host user password. It is of type STRING. By
1299                           default, it is read from environment variable
1300                           OPEN_CLI_HOST_PASSWORD. Secured.
1301  -m | --host-url          host url in http(s). It is of type URL. By
1302                           default, it is read from environment variable
1303                           OPEN_CLI_HOST_URL.
1304  -a | --no-auth           whether to authenticate user or not. It is of
1305                           type BOOL. By default, it is false.
1306
1307
1308 Error::
1309
1310  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
1311
1312
1313
1314 [17] service-model-checkin
1315 -----------------------------------------------
1316
1317
1318 usage: oclip service-model-checkin
1319
1320 Checkin Service model in SDC
1321
1322 Product: onap-amsterdam
1323 Service: sdc
1324 Author: ONAP CLI Team onap-discuss@lists.onap.org
1325
1326 Options::
1327
1328  [-h | --help] [-v | --version] [-d | --debug]
1329  [-f | --format] [-s | --long] [-t | --no-title]
1330  [-b | --service-model-id] [-u | --host-username] [-p | --host-password]
1331  [-m | --host-url] [-a | --no-auth]
1332
1333 where::
1334
1335  -h | --help              print help message. It is of type STRING. By
1336                           default, it is false.
1337  -v | --version           print service version. It is of type STRING. By
1338                           default, it is false.
1339  -d | --debug             Enable debug output. It is of type BOOL. By
1340                           default, it is false.
1341  -f | --format            Output formats, supported formats such as table,
1342                           csv, json, yaml. It is of type STRING. By
1343                           default, it is table.
1344  -s | --long              whether to print all attributes or only short
1345                           attributes. It is of type BOOL. By default, it is
1346                           false.
1347  -t | --no-title          whether to print title or not. It is of type
1348                           BOOL. By default, it is false.
1349  -b | --service-model-id  Service model ID. It is of type STRING. It is
1350                           optional.
1351  -u | --host-username     Host user name. It is of type STRING. By default,
1352                           it is read from environment variable
1353                           OPEN_CLI_HOST_USERNAME.
1354  -p | --host-password     Host user password. It is of type STRING. By
1355                           default, it is read from environment variable
1356                           OPEN_CLI_HOST_PASSWORD. Secured.
1357  -m | --host-url          host url in http(s). It is of type URL. By
1358                           default, it is read from environment variable
1359                           OPEN_CLI_HOST_URL.
1360  -a | --no-auth           whether to authenticate user or not. It is of
1361                           type BOOL. By default, it is false.
1362
1363
1364 Error::
1365
1366  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
1367
1368
1369
1370 [18] service-model-create
1371 -----------------------------------------------
1372
1373
1374 usage: oclip service-model-create
1375
1376 Create Service model in SDC
1377
1378 Product: onap-amsterdam
1379 Service: sdc
1380 Author: ONAP CLI Team onap-discuss@lists.onap.org
1381
1382 Options::
1383
1384  [-h | --help] [-v | --version] [-d | --debug]
1385  [-f | --format] [-s | --long] [-t | --no-title]
1386  [-x | --name] [-y | --description] [-z | --project-code]
1387  [-b | --category] [-c | --category-display-name] [-e | --icon-id]
1388  [-u | --host-username] [-p | --host-password] [-m | --host-url]
1389  [-a | --no-auth]
1390
1391 where::
1392
1393  -h | --help                    print help message. It is of type STRING. By
1394                                 default, it is false.
1395  -v | --version                 print service version. It is of type STRING. By
1396                                 default, it is false.
1397  -d | --debug                   Enable debug output. It is of type BOOL. By
1398                                 default, it is false.
1399  -f | --format                  Output formats, supported formats such as table,
1400                                 csv, json, yaml. It is of type STRING. By
1401                                 default, it is table.
1402  -s | --long                    whether to print all attributes or only short
1403                                 attributes. It is of type BOOL. By default, it is
1404                                 false.
1405  -t | --no-title                whether to print title or not. It is of type
1406                                 BOOL. By default, it is false.
1407  -x | --name                    Onap Service Name. It is of type STRING.
1408  -y | --description             Description for Service. It is of type STRING. It
1409                                 is optional.
1410  -z | --project-code            Project code. It is of type STRING. It is
1411                                 optional.
1412  -b | --category                Service category. It is of type STRING. It is
1413                                 optional. By default, it is network l1-3.
1414  -c | --category-display-name   Service category display name. It is of type
1415                                 STRING. It is optional. By default, it is Network
1416                                 L1-3.
1417  -e | --icon-id                 Service Icon id. It is of type STRING. It is
1418                                 optional. By default, it is defaulticon.
1419  -u | --host-username           Host user name. It is of type STRING. By default,
1420                                 it is read from environment variable
1421                                 OPEN_CLI_HOST_USERNAME.
1422  -p | --host-password           Host user password. It is of type STRING. By
1423                                 default, it is read from environment variable
1424                                 OPEN_CLI_HOST_PASSWORD. Secured.
1425  -m | --host-url                host url in http(s). It is of type URL. By
1426                                 default, it is read from environment variable
1427                                 OPEN_CLI_HOST_URL.
1428  -a | --no-auth                 whether to authenticate user or not. It is of
1429                                 type BOOL. By default, it is false.
1430
1431
1432 Results::
1433
1434  ID   Service ID and is of type STRING.
1435
1436
1437 Error::
1438
1439  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
1440
1441
1442
1443 [19] service-model-checkout
1444 -----------------------------------------------
1445
1446
1447 usage: oclip service-model-checkout
1448
1449 Checkout Service model in SDC
1450
1451 Product: onap-amsterdam
1452 Service: sdc
1453 Author: ONAP CLI Team onap-discuss@lists.onap.org
1454
1455 Options::
1456
1457  [-h | --help] [-v | --version] [-d | --debug]
1458  [-f | --format] [-s | --long] [-t | --no-title]
1459  [-b | --service-model-id] [-u | --host-username] [-p | --host-password]
1460  [-m | --host-url] [-a | --no-auth]
1461
1462 where::
1463
1464  -h | --help              print help message. It is of type STRING. By
1465                           default, it is false.
1466  -v | --version           print service version. It is of type STRING. By
1467                           default, it is false.
1468  -d | --debug             Enable debug output. It is of type BOOL. By
1469                           default, it is false.
1470  -f | --format            Output formats, supported formats such as table,
1471                           csv, json, yaml. It is of type STRING. By
1472                           default, it is table.
1473  -s | --long              whether to print all attributes or only short
1474                           attributes. It is of type BOOL. By default, it is
1475                           false.
1476  -t | --no-title          whether to print title or not. It is of type
1477                           BOOL. By default, it is false.
1478  -b | --service-model-id  Service model ID. It is of type STRING. It is
1479                           optional.
1480  -u | --host-username     Host user name. It is of type STRING. By default,
1481                           it is read from environment variable
1482                           OPEN_CLI_HOST_USERNAME.
1483  -p | --host-password     Host user password. It is of type STRING. By
1484                           default, it is read from environment variable
1485                           OPEN_CLI_HOST_PASSWORD. Secured.
1486  -m | --host-url          host url in http(s). It is of type URL. By
1487                           default, it is read from environment variable
1488                           OPEN_CLI_HOST_URL.
1489  -a | --no-auth           whether to authenticate user or not. It is of
1490                           type BOOL. By default, it is false.
1491
1492
1493 Error::
1494
1495  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
1496
1497
1498
1499 [20] service-model-certify-request
1500 -----------------------------------------------
1501
1502
1503 usage: oclip service-model-certify-request
1504
1505 Request the certification of Service model in SDC
1506
1507 Product: onap-amsterdam
1508 Service: sdc
1509 Author: ONAP CLI Team onap-discuss@lists.onap.org
1510
1511 Options::
1512
1513  [-h | --help] [-v | --version] [-d | --debug]
1514  [-f | --format] [-s | --long] [-t | --no-title]
1515  [-b | --service-model-id] [-u | --host-username] [-p | --host-password]
1516  [-m | --host-url] [-a | --no-auth]
1517
1518 where::
1519
1520  -h | --help              print help message. It is of type STRING. By
1521                           default, it is false.
1522  -v | --version           print service version. It is of type STRING. By
1523                           default, it is false.
1524  -d | --debug             Enable debug output. It is of type BOOL. By
1525                           default, it is false.
1526  -f | --format            Output formats, supported formats such as table,
1527                           csv, json, yaml. It is of type STRING. By
1528                           default, it is table.
1529  -s | --long              whether to print all attributes or only short
1530                           attributes. It is of type BOOL. By default, it is
1531                           false.
1532  -t | --no-title          whether to print title or not. It is of type
1533                           BOOL. By default, it is false.
1534  -b | --service-model-id  Service model ID. It is of type STRING. It is
1535                           optional.
1536  -u | --host-username     Host user name. It is of type STRING. By default,
1537                           it is read from environment variable
1538                           OPEN_CLI_HOST_USERNAME.
1539  -p | --host-password     Host user password. It is of type STRING. By
1540                           default, it is read from environment variable
1541                           OPEN_CLI_HOST_PASSWORD. Secured.
1542  -m | --host-url          host url in http(s). It is of type URL. By
1543                           default, it is read from environment variable
1544                           OPEN_CLI_HOST_URL.
1545  -a | --no-auth           whether to authenticate user or not. It is of
1546                           type BOOL. By default, it is false.
1547
1548
1549 Error::
1550
1551  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
1552
1553
1554
1555 [21] service-model-revert
1556 -----------------------------------------------
1557
1558
1559 usage: oclip service-model-revert
1560
1561 Checkout Service model in SDC
1562
1563 Product: onap-amsterdam
1564 Service: sdc
1565 Author: ONAP CLI Team onap-discuss@lists.onap.org
1566
1567 Options::
1568
1569  [-h | --help] [-v | --version] [-d | --debug]
1570  [-f | --format] [-s | --long] [-t | --no-title]
1571  [-b | --service-model-id] [-u | --host-username] [-p | --host-password]
1572  [-m | --host-url] [-a | --no-auth]
1573
1574 where::
1575
1576  -h | --help              print help message. It is of type STRING. By
1577                           default, it is false.
1578  -v | --version           print service version. It is of type STRING. By
1579                           default, it is false.
1580  -d | --debug             Enable debug output. It is of type BOOL. By
1581                           default, it is false.
1582  -f | --format            Output formats, supported formats such as table,
1583                           csv, json, yaml. It is of type STRING. By
1584                           default, it is table.
1585  -s | --long              whether to print all attributes or only short
1586                           attributes. It is of type BOOL. By default, it is
1587                           false.
1588  -t | --no-title          whether to print title or not. It is of type
1589                           BOOL. By default, it is false.
1590  -b | --service-model-id  Service model ID. It is of type STRING. It is
1591                           optional.
1592  -u | --host-username     Host user name. It is of type STRING. By default,
1593                           it is read from environment variable
1594                           OPEN_CLI_HOST_USERNAME.
1595  -p | --host-password     Host user password. It is of type STRING. By
1596                           default, it is read from environment variable
1597                           OPEN_CLI_HOST_PASSWORD. Secured.
1598  -m | --host-url          host url in http(s). It is of type URL. By
1599                           default, it is read from environment variable
1600                           OPEN_CLI_HOST_URL.
1601  -a | --no-auth           whether to authenticate user or not. It is of
1602                           type BOOL. By default, it is false.
1603
1604
1605 Error::
1606
1607  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
1608
1609
1610
1611 [22] service-model-distribute
1612 -----------------------------------------------
1613
1614
1615 usage: oclip service-model-distribute
1616
1617 Distributes the Service model in SDC
1618
1619 Product: onap-amsterdam
1620 Service: sdc
1621 Author: ONAP CLI Team onap-discuss@lists.onap.org
1622
1623 Options::
1624
1625  [-h | --help] [-v | --version] [-d | --debug]
1626  [-f | --format] [-s | --long] [-t | --no-title]
1627  [-b | --service-model-id] [-u | --host-username] [-p | --host-password]
1628  [-m | --host-url] [-a | --no-auth]
1629
1630 where::
1631
1632  -h | --help              print help message. It is of type STRING. By
1633                           default, it is false.
1634  -v | --version           print service version. It is of type STRING. By
1635                           default, it is false.
1636  -d | --debug             Enable debug output. It is of type BOOL. By
1637                           default, it is false.
1638  -f | --format            Output formats, supported formats such as table,
1639                           csv, json, yaml. It is of type STRING. By
1640                           default, it is table.
1641  -s | --long              whether to print all attributes or only short
1642                           attributes. It is of type BOOL. By default, it is
1643                           false.
1644  -t | --no-title          whether to print title or not. It is of type
1645                           BOOL. By default, it is false.
1646  -b | --service-model-id  Service model ID. It is of type STRING. It is
1647                           optional.
1648  -u | --host-username     Host user name. It is of type STRING. By default,
1649                           it is read from environment variable
1650                           OPEN_CLI_HOST_USERNAME.
1651  -p | --host-password     Host user password. It is of type STRING. By
1652                           default, it is read from environment variable
1653                           OPEN_CLI_HOST_PASSWORD. Secured.
1654  -m | --host-url          host url in http(s). It is of type URL. By
1655                           default, it is read from environment variable
1656                           OPEN_CLI_HOST_URL.
1657  -a | --no-auth           whether to authenticate user or not. It is of
1658                           type BOOL. By default, it is false.
1659
1660
1661 Error::
1662
1663  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
1664
1665
1666
1667 [23] service-model-list
1668 -----------------------------------------------
1669
1670
1671 usage: oclip service-model-list
1672
1673 List the service model in SDC
1674
1675 Product: onap-amsterdam
1676 Service: sdc
1677 Author: ONAP CLI Team onap-discuss@lists.onap.org
1678
1679 Options::
1680
1681  [-h | --help] [-v | --version] [-d | --debug]
1682  [-f | --format] [-s | --long] [-t | --no-title]
1683  [-u | --host-username] [-p | --host-password] [-m | --host-url]
1684  [-a | --no-auth]
1685
1686 where::
1687
1688  -h | --help            print help message. It is of type STRING. By
1689                         default, it is false.
1690  -v | --version         print service version. It is of type STRING. By
1691                         default, it is false.
1692  -d | --debug           Enable debug output. It is of type BOOL. By
1693                         default, it is false.
1694  -f | --format          Output formats, supported formats such as table,
1695                         csv, json, yaml. It is of type STRING. By
1696                         default, it is table.
1697  -s | --long            whether to print all attributes or only short
1698                         attributes. It is of type BOOL. By default, it is
1699                         false.
1700  -t | --no-title        whether to print title or not. It is of type
1701                         BOOL. By default, it is false.
1702  -u | --host-username   Host user name. It is of type STRING. By default,
1703                         it is read from environment variable
1704                         OPEN_CLI_HOST_USERNAME.
1705  -p | --host-password   Host user password. It is of type STRING. By
1706                         default, it is read from environment variable
1707                         OPEN_CLI_HOST_PASSWORD. Secured.
1708  -m | --host-url        host url in http(s). It is of type URL. By
1709                         default, it is read from environment variable
1710                         OPEN_CLI_HOST_URL.
1711  -a | --no-auth         whether to authenticate user or not. It is of
1712                         type BOOL. By default, it is false.
1713
1714
1715 Results::
1716
1717  uuid                 UUID and is of type STRING.
1718  invariant-uuid       Invariant UUID and is of type STRING.
1719  name                 Name and is of type STRING.
1720  version              version and is of type STRING.
1721  status               status and is of type STRING.
1722  distribution-status  status and is of type STRING.
1723  description          description and is of type STRING.
1724
1725
1726 Error::
1727
1728  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
1729
1730
1731
1732 [24] service2vf-model-list
1733 -----------------------------------------------
1734
1735
1736 usage: oclip service2vf-model-list
1737
1738 List the VF in a given service model in SDC
1739
1740 Product: onap-amsterdam
1741 Service: sdc
1742 Author: ONAP CLI Team onap-discuss@lists.onap.org
1743
1744 Options::
1745
1746  [-h | --help] [-v | --version] [-d | --debug]
1747  [-f | --format] [-s | --long] [-t | --no-title]
1748  [-z | --service-model-id] [-u | --host-username] [-p | --host-password]
1749  [-m | --host-url] [-a | --no-auth]
1750
1751 where::
1752
1753  -h | --help              print help message. It is of type STRING. By
1754                           default, it is false.
1755  -v | --version           print service version. It is of type STRING. By
1756                           default, it is false.
1757  -d | --debug             Enable debug output. It is of type BOOL. By
1758                           default, it is false.
1759  -f | --format            Output formats, supported formats such as table,
1760                           csv, json, yaml. It is of type STRING. By
1761                           default, it is table.
1762  -s | --long              whether to print all attributes or only short
1763                           attributes. It is of type BOOL. By default, it is
1764                           false.
1765  -t | --no-title          whether to print title or not. It is of type
1766                           BOOL. By default, it is false.
1767  -z | --service-model-id  Service model uuid. It is of type STRING.
1768  -u | --host-username     Host user name. It is of type STRING. By default,
1769                           it is read from environment variable
1770                           OPEN_CLI_HOST_USERNAME.
1771  -p | --host-password     Host user password. It is of type STRING. By
1772                           default, it is read from environment variable
1773                           OPEN_CLI_HOST_PASSWORD. Secured.
1774  -m | --host-url          host url in http(s). It is of type URL. By
1775                           default, it is read from environment variable
1776                           OPEN_CLI_HOST_URL.
1777  -a | --no-auth           whether to authenticate user or not. It is of
1778                           type BOOL. By default, it is false.
1779
1780
1781 Results::
1782
1783  vf-uuid                UUID and is of type STRING.
1784  vf-name                name and is of type STRING.
1785  vf-customization-uuid  customization UUID and is of type STRING.
1786  vf-version             version and is of type STRING.
1787
1788
1789 Error::
1790
1791  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
1792
1793
1794
1795 [25] vf-model-certify-complete
1796 -----------------------------------------------
1797
1798
1799 usage: oclip vf-model-certify-complete
1800
1801 Complete certifying Virtual function
1802
1803 Product: onap-amsterdam
1804 Service: sdc
1805 Author: ONAP CLI Team onap-discuss@lists.onap.org
1806
1807 Options::
1808
1809  [-h | --help] [-v | --version] [-d | --debug]
1810  [-f | --format] [-s | --long] [-t | --no-title]
1811  [-b | --vf-id] [-u | --host-username] [-p | --host-password]
1812  [-m | --host-url] [-a | --no-auth]
1813
1814 where::
1815
1816  -h | --help            print help message. It is of type STRING. By
1817                         default, it is false.
1818  -v | --version         print service version. It is of type STRING. By
1819                         default, it is false.
1820  -d | --debug           Enable debug output. It is of type BOOL. By
1821                         default, it is false.
1822  -f | --format          Output formats, supported formats such as table,
1823                         csv, json, yaml. It is of type STRING. By
1824                         default, it is table.
1825  -s | --long            whether to print all attributes or only short
1826                         attributes. It is of type BOOL. By default, it is
1827                         false.
1828  -t | --no-title        whether to print title or not. It is of type
1829                         BOOL. By default, it is false.
1830  -b | --vf-id           VF ID. It is of type STRING. It is optional.
1831  -u | --host-username   Host user name. It is of type STRING. By default,
1832                         it is read from environment variable
1833                         OPEN_CLI_HOST_USERNAME.
1834  -p | --host-password   Host user password. It is of type STRING. By
1835                         default, it is read from environment variable
1836                         OPEN_CLI_HOST_PASSWORD. Secured.
1837  -m | --host-url        host url in http(s). It is of type URL. By
1838                         default, it is read from environment variable
1839                         OPEN_CLI_HOST_URL.
1840  -a | --no-auth         whether to authenticate user or not. It is of
1841                         type BOOL. By default, it is false.
1842
1843
1844 Error::
1845
1846  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
1847
1848
1849
1850 [26] vf-model-certify-request
1851 -----------------------------------------------
1852
1853
1854 usage: oclip vf-model-certify-request
1855
1856 Request for certifying Virtual function
1857
1858 Product: onap-amsterdam
1859 Service: sdc
1860 Author: ONAP CLI Team onap-discuss@lists.onap.org
1861
1862 Options::
1863
1864  [-h | --help] [-v | --version] [-d | --debug]
1865  [-f | --format] [-s | --long] [-t | --no-title]
1866  [-b | --vf-id] [-u | --host-username] [-p | --host-password]
1867  [-m | --host-url] [-a | --no-auth]
1868
1869 where::
1870
1871  -h | --help            print help message. It is of type STRING. By
1872                         default, it is false.
1873  -v | --version         print service version. It is of type STRING. By
1874                         default, it is false.
1875  -d | --debug           Enable debug output. It is of type BOOL. By
1876                         default, it is false.
1877  -f | --format          Output formats, supported formats such as table,
1878                         csv, json, yaml. It is of type STRING. By
1879                         default, it is table.
1880  -s | --long            whether to print all attributes or only short
1881                         attributes. It is of type BOOL. By default, it is
1882                         false.
1883  -t | --no-title        whether to print title or not. It is of type
1884                         BOOL. By default, it is false.
1885  -b | --vf-id           VF ID. It is of type STRING. It is optional.
1886  -u | --host-username   Host user name. It is of type STRING. By default,
1887                         it is read from environment variable
1888                         OPEN_CLI_HOST_USERNAME.
1889  -p | --host-password   Host user password. It is of type STRING. By
1890                         default, it is read from environment variable
1891                         OPEN_CLI_HOST_PASSWORD. Secured.
1892  -m | --host-url        host url in http(s). It is of type URL. By
1893                         default, it is read from environment variable
1894                         OPEN_CLI_HOST_URL.
1895  -a | --no-auth         whether to authenticate user or not. It is of
1896                         type BOOL. By default, it is false.
1897
1898
1899 Error::
1900
1901  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
1902
1903
1904
1905 [27] vf-model-certify-start
1906 -----------------------------------------------
1907
1908
1909 usage: oclip vf-model-certify-start
1910
1911 Start certifying Virtual function
1912
1913 Product: onap-amsterdam
1914 Service: sdc
1915 Author: ONAP CLI Team onap-discuss@lists.onap.org
1916
1917 Options::
1918
1919  [-h | --help] [-v | --version] [-d | --debug]
1920  [-f | --format] [-s | --long] [-t | --no-title]
1921  [-b | --vf-id] [-u | --host-username] [-p | --host-password]
1922  [-m | --host-url] [-a | --no-auth]
1923
1924 where::
1925
1926  -h | --help            print help message. It is of type STRING. By
1927                         default, it is false.
1928  -v | --version         print service version. It is of type STRING. By
1929                         default, it is false.
1930  -d | --debug           Enable debug output. It is of type BOOL. By
1931                         default, it is false.
1932  -f | --format          Output formats, supported formats such as table,
1933                         csv, json, yaml. It is of type STRING. By
1934                         default, it is table.
1935  -s | --long            whether to print all attributes or only short
1936                         attributes. It is of type BOOL. By default, it is
1937                         false.
1938  -t | --no-title        whether to print title or not. It is of type
1939                         BOOL. By default, it is false.
1940  -b | --vf-id           VF ID. It is of type STRING. It is optional.
1941  -u | --host-username   Host user name. It is of type STRING. By default,
1942                         it is read from environment variable
1943                         OPEN_CLI_HOST_USERNAME.
1944  -p | --host-password   Host user password. It is of type STRING. By
1945                         default, it is read from environment variable
1946                         OPEN_CLI_HOST_PASSWORD. Secured.
1947  -m | --host-url        host url in http(s). It is of type URL. By
1948                         default, it is read from environment variable
1949                         OPEN_CLI_HOST_URL.
1950  -a | --no-auth         whether to authenticate user or not. It is of
1951                         type BOOL. By default, it is false.
1952
1953
1954 Error::
1955
1956  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
1957
1958
1959
1960 [28] vf-model-checkin
1961 -----------------------------------------------
1962
1963
1964 usage: oclip vf-model-checkin
1965
1966 Checkin Virtual function
1967
1968 Product: onap-amsterdam
1969 Service: sdc
1970 Author: ONAP CLI Team onap-discuss@lists.onap.org
1971
1972 Options::
1973
1974  [-h | --help] [-v | --version] [-d | --debug]
1975  [-f | --format] [-s | --long] [-t | --no-title]
1976  [-b | --vf-id] [-u | --host-username] [-p | --host-password]
1977  [-m | --host-url] [-a | --no-auth]
1978
1979 where::
1980
1981  -h | --help            print help message. It is of type STRING. By
1982                         default, it is false.
1983  -v | --version         print service version. It is of type STRING. By
1984                         default, it is false.
1985  -d | --debug           Enable debug output. It is of type BOOL. By
1986                         default, it is false.
1987  -f | --format          Output formats, supported formats such as table,
1988                         csv, json, yaml. It is of type STRING. By
1989                         default, it is table.
1990  -s | --long            whether to print all attributes or only short
1991                         attributes. It is of type BOOL. By default, it is
1992                         false.
1993  -t | --no-title        whether to print title or not. It is of type
1994                         BOOL. By default, it is false.
1995  -b | --vf-id           VF ID. It is of type STRING. It is optional.
1996  -u | --host-username   Host user name. It is of type STRING. By default,
1997                         it is read from environment variable
1998                         OPEN_CLI_HOST_USERNAME.
1999  -p | --host-password   Host user password. It is of type STRING. By
2000                         default, it is read from environment variable
2001                         OPEN_CLI_HOST_PASSWORD. Secured.
2002  -m | --host-url        host url in http(s). It is of type URL. By
2003                         default, it is read from environment variable
2004                         OPEN_CLI_HOST_URL.
2005  -a | --no-auth         whether to authenticate user or not. It is of
2006                         type BOOL. By default, it is false.
2007
2008
2009 Error::
2010
2011  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
2012
2013
2014
2015 [29] vf-model-create
2016 -----------------------------------------------
2017
2018
2019 usage: oclip vf-model-create
2020
2021 Create Virtual function from Vendor Software Product
2022
2023 Product: onap-amsterdam
2024 Service: sdc
2025 Author: ONAP CLI Team onap-discuss@lists.onap.org
2026
2027 Options::
2028
2029  [-h | --help] [-v | --version] [-d | --debug]
2030  [-f | --format] [-s | --long] [-t | --no-title]
2031  [-x | --name] [-y | --description] [-z | --vendor-name]
2032  [-b | --vsp-id] [-g | --vsp-version] [-u | --host-username]
2033  [-p | --host-password] [-m | --host-url] [-a | --no-auth]
2034
2035 where::
2036
2037  -h | --help            print help message. It is of type STRING. By
2038                         default, it is false.
2039  -v | --version         print service version. It is of type STRING. By
2040                         default, it is false.
2041  -d | --debug           Enable debug output. It is of type BOOL. By
2042                         default, it is false.
2043  -f | --format          Output formats, supported formats such as table,
2044                         csv, json, yaml. It is of type STRING. By
2045                         default, it is table.
2046  -s | --long            whether to print all attributes or only short
2047                         attributes. It is of type BOOL. By default, it is
2048                         false.
2049  -t | --no-title        whether to print title or not. It is of type
2050                         BOOL. By default, it is false.
2051  -x | --name            Onap VF Name. It is of type STRING.
2052  -y | --description     Description for VF. It is of type STRING. It is
2053                         optional.
2054  -z | --vendor-name     Vendor name. It is of type STRING. It is optional.
2055  -b | --vsp-id          VSP ID. It is of type STRING. It is optional.
2056  -g | --vsp-version     VSP version. It is of type STRING. It is optional.
2057  -u | --host-username   Host user name. It is of type STRING. By default,
2058                         it is read from environment variable
2059                         OPEN_CLI_HOST_USERNAME.
2060  -p | --host-password   Host user password. It is of type STRING. By
2061                         default, it is read from environment variable
2062                         OPEN_CLI_HOST_PASSWORD. Secured.
2063  -m | --host-url        host url in http(s). It is of type URL. By
2064                         default, it is read from environment variable
2065                         OPEN_CLI_HOST_URL.
2066  -a | --no-auth         whether to authenticate user or not. It is of
2067                         type BOOL. By default, it is false.
2068
2069
2070 Results::
2071
2072  ID   VF ID and is of type STRING.
2073
2074
2075 Error::
2076
2077  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
2078
2079
2080
2081 [30] vf-model-list
2082 -----------------------------------------------
2083
2084
2085 usage: oclip vf-model-list
2086
2087 List the VF resource model in SDC
2088
2089 Product: onap-amsterdam
2090 Service: sdc
2091 Author: ONAP CLI Team onap-discuss@lists.onap.org
2092
2093 Options::
2094
2095  [-h | --help] [-v | --version] [-d | --debug]
2096  [-f | --format] [-s | --long] [-t | --no-title]
2097  [-u | --host-username] [-p | --host-password] [-m | --host-url]
2098  [-a | --no-auth]
2099
2100 where::
2101
2102  -h | --help            print help message. It is of type STRING. By
2103                         default, it is false.
2104  -v | --version         print service version. It is of type STRING. By
2105                         default, it is false.
2106  -d | --debug           Enable debug output. It is of type BOOL. By
2107                         default, it is false.
2108  -f | --format          Output formats, supported formats such as table,
2109                         csv, json, yaml. It is of type STRING. By
2110                         default, it is table.
2111  -s | --long            whether to print all attributes or only short
2112                         attributes. It is of type BOOL. By default, it is
2113                         false.
2114  -t | --no-title        whether to print title or not. It is of type
2115                         BOOL. By default, it is false.
2116  -u | --host-username   Host user name. It is of type STRING. By default,
2117                         it is read from environment variable
2118                         OPEN_CLI_HOST_USERNAME.
2119  -p | --host-password   Host user password. It is of type STRING. By
2120                         default, it is read from environment variable
2121                         OPEN_CLI_HOST_PASSWORD. Secured.
2122  -m | --host-url        host url in http(s). It is of type URL. By
2123                         default, it is read from environment variable
2124                         OPEN_CLI_HOST_URL.
2125  -a | --no-auth         whether to authenticate user or not. It is of
2126                         type BOOL. By default, it is false.
2127
2128
2129 Results::
2130
2131  uuid             UUID and is of type STRING.
2132  uniqueid         UUID and is of type STRING.
2133  invariant-uuid   Invariant UUID and is of type STRING.
2134  name             Name and is of type STRING.
2135  version          version and is of type STRING.
2136  status           status and is of type STRING.
2137  description      description and is of type STRING.
2138  vsp-uuid         VSP uuid and is of type STRING.
2139  vsp-version      VSP version and is of type STRING.
2140
2141
2142 Error::
2143
2144  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
2145
2146
2147
2148 [31] vf2vfmodule-model-list
2149 -----------------------------------------------
2150
2151
2152 usage: oclip vf2vfmodule-model-list
2153
2154 List the VF modules in a given VF model in SDC
2155
2156 Product: onap-amsterdam
2157 Service: sdc
2158 Author: ONAP CLI Team onap-discuss@lists.onap.org
2159
2160 Options::
2161
2162  [-h | --help] [-v | --version] [-d | --debug]
2163  [-f | --format] [-s | --long] [-t | --no-title]
2164  [-z | --vf-id] [-u | --host-username] [-p | --host-password]
2165  [-m | --host-url] [-a | --no-auth]
2166
2167 where::
2168
2169  -h | --help            print help message. It is of type STRING. By
2170                         default, it is false.
2171  -v | --version         print service version. It is of type STRING. By
2172                         default, it is false.
2173  -d | --debug           Enable debug output. It is of type BOOL. By
2174                         default, it is false.
2175  -f | --format          Output formats, supported formats such as table,
2176                         csv, json, yaml. It is of type STRING. By
2177                         default, it is table.
2178  -s | --long            whether to print all attributes or only short
2179                         attributes. It is of type BOOL. By default, it is
2180                         false.
2181  -t | --no-title        whether to print title or not. It is of type
2182                         BOOL. By default, it is false.
2183  -z | --vf-id           VF uuid. It is of type STRING.
2184  -u | --host-username   Host user name. It is of type STRING. By default,
2185                         it is read from environment variable
2186                         OPEN_CLI_HOST_USERNAME.
2187  -p | --host-password   Host user password. It is of type STRING. By
2188                         default, it is read from environment variable
2189                         OPEN_CLI_HOST_PASSWORD. Secured.
2190  -m | --host-url        host url in http(s). It is of type URL. By
2191                         default, it is read from environment variable
2192                         OPEN_CLI_HOST_URL.
2193  -a | --no-auth         whether to authenticate user or not. It is of
2194                         type BOOL. By default, it is false.
2195
2196
2197 Results::
2198
2199  vsp-uuid               VSP uuid and is of type STRING.
2200  vsp-version            VSP version and is of type STRING.
2201  module-uuid            UUID and is of type STRING.
2202  module-invariant-uuid  Invariant UUID and is of type STRING.
2203  module-name            name and is of type STRING.
2204  module-version         version and is of type STRING.
2205
2206
2207 Error::
2208
2209  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
2210
2211
2212
2213 [32] ep-create
2214 -----------------------------------------------
2215
2216
2217 usage: oclip ep-create
2218
2219 Create Entitlement Pool
2220
2221 Product: onap-amsterdam
2222 Service: sdc
2223 Author: ONAP CLI Team onap-discuss@lists.onap.org
2224
2225 Options::
2226
2227  [-h | --help] [-v | --version] [-d | --debug]
2228  [-f | --format] [-s | --long] [-t | --no-title]
2229  [-x | --ep-name] [-y | --license-model-id] [-z | --ep-description]
2230  [-q | --threshold-value] [-b | --threshold-unit] [-c | --entitlement-metric]
2231  [-e | --aggregation-function] [-g | --operational-scope] [-k | --reference-number]
2232  [-u | --host-username] [-p | --host-password] [-m | --host-url]
2233  [-a | --no-auth]
2234
2235 where::
2236
2237  -h | --help                  print help message. It is of type STRING. By
2238                               default, it is false.
2239  -v | --version               print service version. It is of type STRING. By
2240                               default, it is false.
2241  -d | --debug                 Enable debug output. It is of type BOOL. By
2242                               default, it is false.
2243  -f | --format                Output formats, supported formats such as table,
2244                               csv, json, yaml. It is of type STRING. By
2245                               default, it is table.
2246  -s | --long                  whether to print all attributes or only short
2247                               attributes. It is of type BOOL. By default, it is
2248                               false.
2249  -t | --no-title              whether to print title or not. It is of type
2250                               BOOL. By default, it is false.
2251  -x | --ep-name               Entitlement Pool name. It is of type STRING.
2252  -y | --license-model-id      License Model ID. It is of type STRING.
2253  -z | --ep-description        Description for Entitlement Pool. It is of type
2254                               STRING.
2255  -q | --threshold-value       threshold. It is of type STRING.
2256  -b | --threshold-unit        threshold. It is of type STRING.
2257  -c | --entitlement-metric    Entitlement Metric. It is of type STRING.
2258  -e | --aggregation-function  Aggregation Function. It is of type STRING.
2259  -g | --operational-scope     Operational Scope. It is of type STRING.
2260  -k | --reference-number      Reference Number. It is of type STRING.
2261  -u | --host-username         Host user name. It is of type STRING. By default,
2262                               it is read from environment variable
2263                               OPEN_CLI_HOST_USERNAME.
2264  -p | --host-password         Host user password. It is of type STRING. By
2265                               default, it is read from environment variable
2266                               OPEN_CLI_HOST_PASSWORD. Secured.
2267  -m | --host-url              host url in http(s). It is of type URL. By
2268                               default, it is read from environment variable
2269                               OPEN_CLI_HOST_URL.
2270  -a | --no-auth               whether to authenticate user or not. It is of
2271                               type BOOL. By default, it is false.
2272
2273
2274 Results::
2275
2276  ID   Entitlement Pool ID and is of type STRING.
2277
2278
2279 Error::
2280
2281  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
2282
2283
2284
2285 [33] ep-show
2286 -----------------------------------------------
2287
2288
2289 usage: oclip ep-show
2290
2291 Details of the Entitlement Pool
2292
2293 Product: onap-amsterdam
2294 Service: sdc
2295 Author: ONAP CLI Team onap-discuss@lists.onap.org
2296
2297 Options::
2298
2299  [-h | --help] [-v | --version] [-d | --debug]
2300  [-f | --format] [-s | --long] [-t | --no-title]
2301  [-x | --license-model-id] [-y | --pool-id] [-u | --host-username]
2302  [-p | --host-password] [-m | --host-url] [-a | --no-auth]
2303
2304 where::
2305
2306  -h | --help              print help message. It is of type STRING. By
2307                           default, it is false.
2308  -v | --version           print service version. It is of type STRING. By
2309                           default, it is false.
2310  -d | --debug             Enable debug output. It is of type BOOL. By
2311                           default, it is false.
2312  -f | --format            Output formats, supported formats such as table,
2313                           csv, json, yaml. It is of type STRING. By
2314                           default, it is table.
2315  -s | --long              whether to print all attributes or only short
2316                           attributes. It is of type BOOL. By default, it is
2317                           false.
2318  -t | --no-title          whether to print title or not. It is of type
2319                           BOOL. By default, it is false.
2320  -x | --license-model-id  Onap License Model ID. It is of type STRING.
2321  -y | --pool-id           Onap Entitlement Pool ID. It is of type STRING.
2322  -u | --host-username     Host user name. It is of type STRING. By default,
2323                           it is read from environment variable
2324                           OPEN_CLI_HOST_USERNAME.
2325  -p | --host-password     Host user password. It is of type STRING. By
2326                           default, it is read from environment variable
2327                           OPEN_CLI_HOST_PASSWORD. Secured.
2328  -m | --host-url          host url in http(s). It is of type URL. By
2329                           default, it is read from environment variable
2330                           OPEN_CLI_HOST_URL.
2331  -a | --no-auth           whether to authenticate user or not. It is of
2332                           type BOOL. By default, it is false.
2333
2334
2335 Results::
2336
2337  name         Entitlement Pool Name and is of type STRING.
2338  ID           Entitlement Pool ID and is of type STRING.
2339  description  Description for the Entitlement Pool and is of
2340               type STRING.
2341
2342
2343 Error::
2344
2345  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
2346
2347
2348
2349 [34] license-group-create
2350 -----------------------------------------------
2351
2352
2353 usage: oclip license-group-create
2354
2355 Create License Group
2356
2357 Product: onap-amsterdam
2358 Service: sdc
2359 Author: ONAP CLI Team onap-discuss@lists.onap.org
2360
2361 Options::
2362
2363  [-h | --help] [-v | --version] [-d | --debug]
2364  [-f | --format] [-s | --long] [-t | --no-title]
2365  [-x | --group-name] [-y | --license-model-id] [-z | --license-group-description]
2366  [-u | --host-username] [-p | --host-password] [-m | --host-url]
2367  [-a | --no-auth]
2368
2369 where::
2370
2371  -h | --help                        print help message. It is of type STRING. By
2372                                     default, it is false.
2373  -v | --version                     print service version. It is of type STRING. By
2374                                     default, it is false.
2375  -d | --debug                       Enable debug output. It is of type BOOL. By
2376                                     default, it is false.
2377  -f | --format                      Output formats, supported formats such as table,
2378                                     csv, json, yaml. It is of type STRING. By
2379                                     default, it is table.
2380  -s | --long                        whether to print all attributes or only short
2381                                     attributes. It is of type BOOL. By default, it is
2382                                     false.
2383  -t | --no-title                    whether to print title or not. It is of type
2384                                     BOOL. By default, it is false.
2385  -x | --group-name                  group name. It is of type STRING.
2386  -y | --license-model-id            License Model ID. It is of type STRING.
2387  -z | --license-group-description   Description for License Group. It is of type
2388                                     STRING. It is optional.
2389  -u | --host-username               Host user name. It is of type STRING. By default,
2390                                     it is read from environment variable
2391                                     OPEN_CLI_HOST_USERNAME.
2392  -p | --host-password               Host user password. It is of type STRING. By
2393                                     default, it is read from environment variable
2394                                     OPEN_CLI_HOST_PASSWORD. Secured.
2395  -m | --host-url                    host url in http(s). It is of type URL. By
2396                                     default, it is read from environment variable
2397                                     OPEN_CLI_HOST_URL.
2398  -a | --no-auth                     whether to authenticate user or not. It is of
2399                                     type BOOL. By default, it is false.
2400
2401
2402 Results::
2403
2404  ID   License Group ID and is of type STRING.
2405
2406
2407 Error::
2408
2409  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
2410
2411
2412
2413 [35] license-group-show
2414 -----------------------------------------------
2415
2416
2417 usage: oclip license-group-show
2418
2419 Details of the License Group
2420
2421 Product: onap-amsterdam
2422 Service: sdc
2423 Author: ONAP CLI Team onap-discuss@lists.onap.org
2424
2425 Options::
2426
2427  [-h | --help] [-v | --version] [-d | --debug]
2428  [-f | --format] [-s | --long] [-t | --no-title]
2429  [-x | --license-model-id] [-y | --license-group-id] [-u | --host-username]
2430  [-p | --host-password] [-m | --host-url] [-a | --no-auth]
2431
2432 where::
2433
2434  -h | --help              print help message. It is of type STRING. By
2435                           default, it is false.
2436  -v | --version           print service version. It is of type STRING. By
2437                           default, it is false.
2438  -d | --debug             Enable debug output. It is of type BOOL. By
2439                           default, it is false.
2440  -f | --format            Output formats, supported formats such as table,
2441                           csv, json, yaml. It is of type STRING. By
2442                           default, it is table.
2443  -s | --long              whether to print all attributes or only short
2444                           attributes. It is of type BOOL. By default, it is
2445                           false.
2446  -t | --no-title          whether to print title or not. It is of type
2447                           BOOL. By default, it is false.
2448  -x | --license-model-id  Onap License Model ID. It is of type STRING.
2449  -y | --license-group-id  Onap License Group ID. It is of type STRING.
2450  -u | --host-username     Host user name. It is of type STRING. By default,
2451                           it is read from environment variable
2452                           OPEN_CLI_HOST_USERNAME.
2453  -p | --host-password     Host user password. It is of type STRING. By
2454                           default, it is read from environment variable
2455                           OPEN_CLI_HOST_PASSWORD. Secured.
2456  -m | --host-url          host url in http(s). It is of type URL. By
2457                           default, it is read from environment variable
2458                           OPEN_CLI_HOST_URL.
2459  -a | --no-auth           whether to authenticate user or not. It is of
2460                           type BOOL. By default, it is false.
2461
2462
2463 Results::
2464
2465  name         License Group Name and is of type STRING.
2466  ID           License Group ID and is of type STRING.
2467  description  Description for the License Group and is of type
2468               STRING.
2469
2470
2471 Error::
2472
2473  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
2474
2475
2476
2477 [36] license-model-create
2478 -----------------------------------------------
2479
2480
2481 usage: oclip license-model-create
2482
2483 Create License Model
2484
2485 Product: onap-amsterdam
2486 Service: sdc
2487 Author: ONAP CLI Team onap-discuss@lists.onap.org
2488
2489 Options::
2490
2491  [-h | --help] [-v | --version] [-d | --debug]
2492  [-f | --format] [-s | --long] [-t | --no-title]
2493  [-x | --vendor-name] [-y | --license-model-description] [-u | --host-username]
2494  [-p | --host-password] [-m | --host-url] [-a | --no-auth]
2495
2496 where::
2497
2498  -h | --help                        print help message. It is of type STRING. By
2499                                     default, it is false.
2500  -v | --version                     print service version. It is of type STRING. By
2501                                     default, it is false.
2502  -d | --debug                       Enable debug output. It is of type BOOL. By
2503                                     default, it is false.
2504  -f | --format                      Output formats, supported formats such as table,
2505                                     csv, json, yaml. It is of type STRING. By
2506                                     default, it is table.
2507  -s | --long                        whether to print all attributes or only short
2508                                     attributes. It is of type BOOL. By default, it is
2509                                     false.
2510  -t | --no-title                    whether to print title or not. It is of type
2511                                     BOOL. By default, it is false.
2512  -x | --vendor-name                 vendor name. It is of type STRING.
2513  -y | --license-model-description   Description for License Model. It is of type
2514                                     STRING. It is optional.
2515  -u | --host-username               Host user name. It is of type STRING. By default,
2516                                     it is read from environment variable
2517                                     OPEN_CLI_HOST_USERNAME.
2518  -p | --host-password               Host user password. It is of type STRING. By
2519                                     default, it is read from environment variable
2520                                     OPEN_CLI_HOST_PASSWORD. Secured.
2521  -m | --host-url                    host url in http(s). It is of type URL. By
2522                                     default, it is read from environment variable
2523                                     OPEN_CLI_HOST_URL.
2524  -a | --no-auth                     whether to authenticate user or not. It is of
2525                                     type BOOL. By default, it is false.
2526
2527
2528 Results::
2529
2530  ID   License Model ID and is of type STRING.
2531
2532
2533 Error::
2534
2535  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
2536
2537
2538
2539 [37] vlm-aggreement-create
2540 -----------------------------------------------
2541
2542
2543 usage: oclip vlm-aggreement-create
2544
2545 Create license aggreement
2546
2547 Product: onap-amsterdam
2548 Service: sdc
2549 Author: ONAP CLI Team onap-discuss@lists.onap.org
2550
2551 Options::
2552
2553  [-h | --help] [-v | --version] [-d | --debug]
2554  [-f | --format] [-s | --long] [-t | --no-title]
2555  [-x | --name] [-y | --vlm-id] [-e | --vlm-version]
2556  [-z | --description] [-g | --vlm-feature-group-id] [-u | --host-username]
2557  [-p | --host-password] [-m | --host-url] [-a | --no-auth]
2558
2559 where::
2560
2561  -h | --help                  print help message. It is of type STRING. By
2562                               default, it is false.
2563  -v | --version               print service version. It is of type STRING. By
2564                               default, it is false.
2565  -d | --debug                 Enable debug output. It is of type BOOL. By
2566                               default, it is false.
2567  -f | --format                Output formats, supported formats such as table,
2568                               csv, json, yaml. It is of type STRING. By
2569                               default, it is table.
2570  -s | --long                  whether to print all attributes or only short
2571                               attributes. It is of type BOOL. By default, it is
2572                               false.
2573  -t | --no-title              whether to print title or not. It is of type
2574                               BOOL. By default, it is false.
2575  -x | --name                  aggreement name. It is of type STRING.
2576  -y | --vlm-id                License Model ID. It is of type STRING.
2577  -e | --vlm-version           License Model version. It is of type STRING.
2578  -z | --description           Description for aggreement. It is of type STRING.
2579  -g | --vlm-feature-group-id  VLM feature group. It is of type STRING.
2580  -u | --host-username         Host user name. It is of type STRING. By default,
2581                               it is read from environment variable
2582                               OPEN_CLI_HOST_USERNAME.
2583  -p | --host-password         Host user password. It is of type STRING. By
2584                               default, it is read from environment variable
2585                               OPEN_CLI_HOST_PASSWORD. Secured.
2586  -m | --host-url              host url in http(s). It is of type URL. By
2587                               default, it is read from environment variable
2588                               OPEN_CLI_HOST_URL.
2589  -a | --no-auth               whether to authenticate user or not. It is of
2590                               type BOOL. By default, it is false.
2591
2592
2593 Results::
2594
2595  ID   aggreement ID and is of type STRING.
2596
2597
2598 Error::
2599
2600  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
2601
2602
2603
2604 [38] vlm-checkin
2605 -----------------------------------------------
2606
2607
2608 usage: oclip vlm-checkin
2609
2610 Checkin Vendor License Model
2611
2612 Product: onap-amsterdam
2613 Service: sdc
2614 Author: ONAP CLI Team onap-discuss@lists.onap.org
2615
2616 Options::
2617
2618  [-h | --help] [-v | --version] [-d | --debug]
2619  [-f | --format] [-s | --long] [-t | --no-title]
2620  [-x | --vlm-id] [-y | --vlm-version] [-u | --host-username]
2621  [-p | --host-password] [-m | --host-url] [-a | --no-auth]
2622
2623 where::
2624
2625  -h | --help            print help message. It is of type STRING. By
2626                         default, it is false.
2627  -v | --version         print service version. It is of type STRING. By
2628                         default, it is false.
2629  -d | --debug           Enable debug output. It is of type BOOL. By
2630                         default, it is false.
2631  -f | --format          Output formats, supported formats such as table,
2632                         csv, json, yaml. It is of type STRING. By
2633                         default, it is table.
2634  -s | --long            whether to print all attributes or only short
2635                         attributes. It is of type BOOL. By default, it is
2636                         false.
2637  -t | --no-title        whether to print title or not. It is of type
2638                         BOOL. By default, it is false.
2639  -x | --vlm-id          Onap VLM ID. It is of type STRING.
2640  -y | --vlm-version     VLM version. It is of type STRING.
2641  -u | --host-username   Host user name. It is of type STRING. By default,
2642                         it is read from environment variable
2643                         OPEN_CLI_HOST_USERNAME.
2644  -p | --host-password   Host user password. It is of type STRING. By
2645                         default, it is read from environment variable
2646                         OPEN_CLI_HOST_PASSWORD. Secured.
2647  -m | --host-url        host url in http(s). It is of type URL. By
2648                         default, it is read from environment variable
2649                         OPEN_CLI_HOST_URL.
2650  -a | --no-auth         whether to authenticate user or not. It is of
2651                         type BOOL. By default, it is false.
2652
2653
2654 Error::
2655
2656  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
2657
2658
2659
2660 [39] vlm-create
2661 -----------------------------------------------
2662
2663
2664 usage: oclip vlm-create
2665
2666 Create License Model
2667
2668 Product: onap-amsterdam
2669 Service: sdc
2670 Author: ONAP CLI Team onap-discuss@lists.onap.org
2671
2672 Options::
2673
2674  [-h | --help] [-v | --version] [-d | --debug]
2675  [-f | --format] [-s | --long] [-t | --no-title]
2676  [-x | --vendor-name] [-y | --description] [-u | --host-username]
2677  [-p | --host-password] [-m | --host-url] [-a | --no-auth]
2678
2679 where::
2680
2681  -h | --help            print help message. It is of type STRING. By
2682                         default, it is false.
2683  -v | --version         print service version. It is of type STRING. By
2684                         default, it is false.
2685  -d | --debug           Enable debug output. It is of type BOOL. By
2686                         default, it is false.
2687  -f | --format          Output formats, supported formats such as table,
2688                         csv, json, yaml. It is of type STRING. By
2689                         default, it is table.
2690  -s | --long            whether to print all attributes or only short
2691                         attributes. It is of type BOOL. By default, it is
2692                         false.
2693  -t | --no-title        whether to print title or not. It is of type
2694                         BOOL. By default, it is false.
2695  -x | --vendor-name     vendor name. It is of type STRING.
2696  -y | --description     Description for License Model. It is of type
2697                         STRING. It is optional.
2698  -u | --host-username   Host user name. It is of type STRING. By default,
2699                         it is read from environment variable
2700                         OPEN_CLI_HOST_USERNAME.
2701  -p | --host-password   Host user password. It is of type STRING. By
2702                         default, it is read from environment variable
2703                         OPEN_CLI_HOST_PASSWORD. Secured.
2704  -m | --host-url        host url in http(s). It is of type URL. By
2705                         default, it is read from environment variable
2706                         OPEN_CLI_HOST_URL.
2707  -a | --no-auth         whether to authenticate user or not. It is of
2708                         type BOOL. By default, it is false.
2709
2710
2711 Results::
2712
2713  ID   License Model ID and is of type UUID.
2714
2715
2716 Error::
2717
2718  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
2719
2720
2721
2722 [40] vlm-entitlement-pool-list
2723 -----------------------------------------------
2724
2725
2726 usage: oclip vlm-entitlement-pool-list
2727
2728 entitlement pool list in a license model
2729
2730 Product: onap-amsterdam
2731 Service: sdc
2732 Author: ONAP CLI Team onap-discuss@lists.onap.org
2733
2734 Options::
2735
2736  [-h | --help] [-v | --version] [-d | --debug]
2737  [-f | --format] [-s | --long] [-t | --no-title]
2738  [-x | --vlm-id] [-y | --vlm-version] [-u | --host-username]
2739  [-p | --host-password] [-m | --host-url] [-a | --no-auth]
2740
2741 where::
2742
2743  -h | --help            print help message. It is of type STRING. By
2744                         default, it is false.
2745  -v | --version         print service version. It is of type STRING. By
2746                         default, it is false.
2747  -d | --debug           Enable debug output. It is of type BOOL. By
2748                         default, it is false.
2749  -f | --format          Output formats, supported formats such as table,
2750                         csv, json, yaml. It is of type STRING. By
2751                         default, it is table.
2752  -s | --long            whether to print all attributes or only short
2753                         attributes. It is of type BOOL. By default, it is
2754                         false.
2755  -t | --no-title        whether to print title or not. It is of type
2756                         BOOL. By default, it is false.
2757  -x | --vlm-id          License Model ID. It is of type STRING.
2758  -y | --vlm-version     License Model version. It is of type STRING.
2759  -u | --host-username   Host user name. It is of type STRING. By default,
2760                         it is read from environment variable
2761                         OPEN_CLI_HOST_USERNAME.
2762  -p | --host-password   Host user password. It is of type STRING. By
2763                         default, it is read from environment variable
2764                         OPEN_CLI_HOST_PASSWORD. Secured.
2765  -m | --host-url        host url in http(s). It is of type URL. By
2766                         default, it is read from environment variable
2767                         OPEN_CLI_HOST_URL.
2768  -a | --no-auth         whether to authenticate user or not. It is of
2769                         type BOOL. By default, it is false.
2770
2771
2772 Results::
2773
2774  ID     Feature group ID and is of type STRING.
2775  name   Feature group name and is of type STRING.
2776
2777
2778 Error::
2779
2780  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
2781
2782
2783
2784 [41] vlm-feature-group-create
2785 -----------------------------------------------
2786
2787
2788 usage: oclip vlm-feature-group-create
2789
2790 Create feature group Pool
2791
2792 Product: onap-amsterdam
2793 Service: sdc
2794 Author: ONAP CLI Team onap-discuss@lists.onap.org
2795
2796 Options::
2797
2798  [-h | --help] [-v | --version] [-d | --debug]
2799  [-f | --format] [-s | --long] [-t | --no-title]
2800  [-x | --name] [-y | --vlm-id] [-e | --vlm-version]
2801  [-z | --description] [-g | --vlm-key-group-id] [-b | --vlm-entitle-pool-id]
2802  [-c | --part-number] [-k | --manufacture-reference-number] [-u | --host-username]
2803  [-p | --host-password] [-m | --host-url] [-a | --no-auth]
2804
2805 where::
2806
2807  -h | --help                          print help message. It is of type STRING. By
2808                                       default, it is false.
2809  -v | --version                       print service version. It is of type STRING. By
2810                                       default, it is false.
2811  -d | --debug                         Enable debug output. It is of type BOOL. By
2812                                       default, it is false.
2813  -f | --format                        Output formats, supported formats such as table,
2814                                       csv, json, yaml. It is of type STRING. By
2815                                       default, it is table.
2816  -s | --long                          whether to print all attributes or only short
2817                                       attributes. It is of type BOOL. By default, it is
2818                                       false.
2819  -t | --no-title                      whether to print title or not. It is of type
2820                                       BOOL. By default, it is false.
2821  -x | --name                          Feature group name. It is of type STRING.
2822  -y | --vlm-id                        License Model ID. It is of type STRING.
2823  -e | --vlm-version                   License Model version. It is of type STRING.
2824  -z | --description                   Description for feature group. It is of type
2825                                       STRING.
2826  -g | --vlm-key-group-id              VLM keygroup. It is of type STRING.
2827  -b | --vlm-entitle-pool-id           VLM Entitlement pool. It is of type STRING.
2828  -c | --part-number                   Part number. It is of type STRING.
2829  -k | --manufacture-reference-number  Manufature Reference Number. It is of type STRING.
2830  -u | --host-username                 Host user name. It is of type STRING. By default,
2831                                       it is read from environment variable
2832                                       OPEN_CLI_HOST_USERNAME.
2833  -p | --host-password                 Host user password. It is of type STRING. By
2834                                       default, it is read from environment variable
2835                                       OPEN_CLI_HOST_PASSWORD. Secured.
2836  -m | --host-url                      host url in http(s). It is of type URL. By
2837                                       default, it is read from environment variable
2838                                       OPEN_CLI_HOST_URL.
2839  -a | --no-auth                       whether to authenticate user or not. It is of
2840                                       type BOOL. By default, it is false.
2841
2842
2843 Results::
2844
2845  ID   Feature group ID and is of type STRING.
2846
2847
2848 Error::
2849
2850  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
2851
2852
2853
2854 [42] vlm-key-group-create
2855 -----------------------------------------------
2856
2857
2858 usage: oclip vlm-key-group-create
2859
2860 Create License Key Group
2861
2862 Product: onap-amsterdam
2863 Service: sdc
2864 Author: ONAP CLI Team onap-discuss@lists.onap.org
2865
2866 Options::
2867
2868  [-h | --help] [-v | --version] [-d | --debug]
2869  [-f | --format] [-s | --long] [-t | --no-title]
2870  [-c | --vlm-id] [-e | --vlm-version] [-x | --name]
2871  [-y | --type] [-z | --description] [-u | --host-username]
2872  [-p | --host-password] [-m | --host-url] [-a | --no-auth]
2873
2874 where::
2875
2876  -h | --help            print help message. It is of type STRING. By
2877                         default, it is false.
2878  -v | --version         print service version. It is of type STRING. By
2879                         default, it is false.
2880  -d | --debug           Enable debug output. It is of type BOOL. By
2881                         default, it is false.
2882  -f | --format          Output formats, supported formats such as table,
2883                         csv, json, yaml. It is of type STRING. By
2884                         default, it is table.
2885  -s | --long            whether to print all attributes or only short
2886                         attributes. It is of type BOOL. By default, it is
2887                         false.
2888  -t | --no-title        whether to print title or not. It is of type
2889                         BOOL. By default, it is false.
2890  -c | --vlm-id          License Model Id. It is of type STRING.
2891  -e | --vlm-version     License Model version. It is of type STRING.
2892  -x | --name            name. It is of type STRING.
2893  -y | --type            type of group (Universal, unique, one-time). It
2894                         is of type STRING. By default, it is Universal.
2895  -z | --description     Description for License Key Group. It is of type
2896                         STRING. It is optional.
2897  -u | --host-username   Host user name. It is of type STRING. By default,
2898                         it is read from environment variable
2899                         OPEN_CLI_HOST_USERNAME.
2900  -p | --host-password   Host user password. It is of type STRING. By
2901                         default, it is read from environment variable
2902                         OPEN_CLI_HOST_PASSWORD. Secured.
2903  -m | --host-url        host url in http(s). It is of type URL. By
2904                         default, it is read from environment variable
2905                         OPEN_CLI_HOST_URL.
2906  -a | --no-auth         whether to authenticate user or not. It is of
2907                         type BOOL. By default, it is false.
2908
2909
2910 Results::
2911
2912  ID   License Model ID and is of type STRING.
2913
2914
2915 Error::
2916
2917  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
2918
2919
2920
2921 [43] vlm-list
2922 -----------------------------------------------
2923
2924
2925 usage: oclip vlm-list
2926
2927 List License Model
2928
2929 Product: onap-amsterdam
2930 Service: sdc
2931 Author: ONAP CLI Team onap-discuss@lists.onap.org
2932
2933 Options::
2934
2935  [-h | --help] [-v | --version] [-d | --debug]
2936  [-f | --format] [-s | --long] [-t | --no-title]
2937  [-u | --host-username] [-p | --host-password] [-m | --host-url]
2938  [-a | --no-auth]
2939
2940 where::
2941
2942  -h | --help            print help message. It is of type STRING. By
2943                         default, it is false.
2944  -v | --version         print service version. It is of type STRING. By
2945                         default, it is false.
2946  -d | --debug           Enable debug output. It is of type BOOL. By
2947                         default, it is false.
2948  -f | --format          Output formats, supported formats such as table,
2949                         csv, json, yaml. It is of type STRING. By
2950                         default, it is table.
2951  -s | --long            whether to print all attributes or only short
2952                         attributes. It is of type BOOL. By default, it is
2953                         false.
2954  -t | --no-title        whether to print title or not. It is of type
2955                         BOOL. By default, it is false.
2956  -u | --host-username   Host user name. It is of type STRING. By default,
2957                         it is read from environment variable
2958                         OPEN_CLI_HOST_USERNAME.
2959  -p | --host-password   Host user password. It is of type STRING. By
2960                         default, it is read from environment variable
2961                         OPEN_CLI_HOST_PASSWORD. Secured.
2962  -m | --host-url        host url in http(s). It is of type URL. By
2963                         default, it is read from environment variable
2964                         OPEN_CLI_HOST_URL.
2965  -a | --no-auth         whether to authenticate user or not. It is of
2966                         type BOOL. By default, it is false.
2967
2968
2969 Results::
2970
2971  id           License ID and is of type UUID.
2972  vendor-name  Vendor  Name and is of type STRING.
2973  vlm-version  VLM version and is of type STRING.
2974  status       status and is of type STRING.
2975  description  License description and is of type STRING.
2976
2977
2978 Error::
2979
2980  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
2981
2982
2983
2984 [44] vlm-submit
2985 -----------------------------------------------
2986
2987
2988 usage: oclip vlm-submit
2989
2990 Submit Vendor License Model
2991
2992 Product: onap-amsterdam
2993 Service: sdc
2994 Author: ONAP CLI Team onap-discuss@lists.onap.org
2995
2996 Options::
2997
2998  [-h | --help] [-v | --version] [-d | --debug]
2999  [-f | --format] [-s | --long] [-t | --no-title]
3000  [-x | --vlm-id] [-y | --vlm-version] [-u | --host-username]
3001  [-p | --host-password] [-m | --host-url] [-a | --no-auth]
3002
3003 where::
3004
3005  -h | --help            print help message. It is of type STRING. By
3006                         default, it is false.
3007  -v | --version         print service version. It is of type STRING. By
3008                         default, it is false.
3009  -d | --debug           Enable debug output. It is of type BOOL. By
3010                         default, it is false.
3011  -f | --format          Output formats, supported formats such as table,
3012                         csv, json, yaml. It is of type STRING. By
3013                         default, it is table.
3014  -s | --long            whether to print all attributes or only short
3015                         attributes. It is of type BOOL. By default, it is
3016                         false.
3017  -t | --no-title        whether to print title or not. It is of type
3018                         BOOL. By default, it is false.
3019  -x | --vlm-id          Onap VLM ID. It is of type STRING.
3020  -y | --vlm-version     VLM version. It is of type STRING.
3021  -u | --host-username   Host user name. It is of type STRING. By default,
3022                         it is read from environment variable
3023                         OPEN_CLI_HOST_USERNAME.
3024  -p | --host-password   Host user password. It is of type STRING. By
3025                         default, it is read from environment variable
3026                         OPEN_CLI_HOST_PASSWORD. Secured.
3027  -m | --host-url        host url in http(s). It is of type URL. By
3028                         default, it is read from environment variable
3029                         OPEN_CLI_HOST_URL.
3030  -a | --no-auth         whether to authenticate user or not. It is of
3031                         type BOOL. By default, it is false.
3032
3033
3034 Error::
3035
3036  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
3037
3038
3039
3040 [45] vsp-checkin
3041 -----------------------------------------------
3042
3043
3044 usage: oclip vsp-checkin
3045
3046 Checkin Vendor Software Product
3047
3048 Product: onap-amsterdam
3049 Service: sdc
3050 Author: ONAP CLI Team onap-discuss@lists.onap.org
3051
3052 Options::
3053
3054  [-h | --help] [-v | --version] [-d | --debug]
3055  [-f | --format] [-s | --long] [-t | --no-title]
3056  [-x | --vsp-id] [-y | --vsp-version] [-u | --host-username]
3057  [-p | --host-password] [-m | --host-url] [-a | --no-auth]
3058
3059 where::
3060
3061  -h | --help            print help message. It is of type STRING. By
3062                         default, it is false.
3063  -v | --version         print service version. It is of type STRING. By
3064                         default, it is false.
3065  -d | --debug           Enable debug output. It is of type BOOL. By
3066                         default, it is false.
3067  -f | --format          Output formats, supported formats such as table,
3068                         csv, json, yaml. It is of type STRING. By
3069                         default, it is table.
3070  -s | --long            whether to print all attributes or only short
3071                         attributes. It is of type BOOL. By default, it is
3072                         false.
3073  -t | --no-title        whether to print title or not. It is of type
3074                         BOOL. By default, it is false.
3075  -x | --vsp-id          Onap VSP ID. It is of type STRING.
3076  -y | --vsp-version     VSP version. It is of type STRING.
3077  -u | --host-username   Host user name. It is of type STRING. By default,
3078                         it is read from environment variable
3079                         OPEN_CLI_HOST_USERNAME.
3080  -p | --host-password   Host user password. It is of type STRING. By
3081                         default, it is read from environment variable
3082                         OPEN_CLI_HOST_PASSWORD. Secured.
3083  -m | --host-url        host url in http(s). It is of type URL. By
3084                         default, it is read from environment variable
3085                         OPEN_CLI_HOST_URL.
3086  -a | --no-auth         whether to authenticate user or not. It is of
3087                         type BOOL. By default, it is false.
3088
3089
3090 Error::
3091
3092  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
3093
3094
3095
3096 [46] vsp-create
3097 -----------------------------------------------
3098
3099
3100 usage: oclip vsp-create
3101
3102 Create Vendor Software Product
3103
3104 Product: onap-amsterdam
3105 Service: sdc
3106 Author: ONAP CLI Team onap-discuss@lists.onap.org
3107
3108 Options::
3109
3110  [-h | --help] [-v | --version] [-d | --debug]
3111  [-f | --format] [-s | --long] [-t | --no-title]
3112  [-x | --vsp-name] [-y | --vsp-description] [-z | --vsp-category]
3113  [-b | --vsp-subcategory] [-c | --vlm-version] [-e | --vlm-vendor]
3114  [-g | --vlm-id] [-i | --vlm-agreement-id] [-j | --vlm-feature-group-id]
3115  [-u | --host-username] [-p | --host-password] [-m | --host-url]
3116  [-a | --no-auth]
3117
3118 where::
3119
3120  -h | --help                  print help message. It is of type STRING. By
3121                               default, it is false.
3122  -v | --version               print service version. It is of type STRING. By
3123                               default, it is false.
3124  -d | --debug                 Enable debug output. It is of type BOOL. By
3125                               default, it is false.
3126  -f | --format                Output formats, supported formats such as table,
3127                               csv, json, yaml. It is of type STRING. By
3128                               default, it is table.
3129  -s | --long                  whether to print all attributes or only short
3130                               attributes. It is of type BOOL. By default, it is
3131                               false.
3132  -t | --no-title              whether to print title or not. It is of type
3133                               BOOL. By default, it is false.
3134  -x | --vsp-name              Onap VSP Name. It is of type STRING.
3135  -y | --vsp-description       Description for VSP. It is of type STRING. It is
3136                               optional.
3137  -z | --vsp-category          Category of the VSP. It is of type STRING. It is
3138                               optional. By default, it is
3139                               resourceNewCategory.generic.
3140  -b | --vsp-subcategory       Sub Category of VSP. It is of type STRING. It is
3141                               optional. By default, it is
3142                               resourceNewCategory.generic.abstract.
3143  -c | --vlm-version           License version. It is of type STRING. It is
3144                               optional. By default, it is 1.0.
3145  -e | --vlm-vendor            License Model vendor. It is of type STRING.
3146  -g | --vlm-id                License Model ID. It is of type STRING.
3147  -i | --vlm-agreement-id      License Agreement ID. It is of type STRING.
3148  -j | --vlm-feature-group-id  Feature Group ID. It is of type STRING.
3149  -u | --host-username         Host user name. It is of type STRING. By default,
3150                               it is read from environment variable
3151                               OPEN_CLI_HOST_USERNAME.
3152  -p | --host-password         Host user password. It is of type STRING. By
3153                               default, it is read from environment variable
3154                               OPEN_CLI_HOST_PASSWORD. Secured.
3155  -m | --host-url              host url in http(s). It is of type URL. By
3156                               default, it is read from environment variable
3157                               OPEN_CLI_HOST_URL.
3158  -a | --no-auth               whether to authenticate user or not. It is of
3159                               type BOOL. By default, it is false.
3160
3161
3162 Results::
3163
3164  ID   VSP ID and is of type STRING.
3165
3166
3167 Error::
3168
3169  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
3170
3171
3172
3173 [47] vsp-package
3174 -----------------------------------------------
3175
3176
3177 usage: oclip vsp-package
3178
3179 Package Vendor Software Product
3180
3181 Product: onap-amsterdam
3182 Service: sdc
3183 Author: ONAP CLI Team onap-discuss@lists.onap.org
3184
3185 Options::
3186
3187  [-h | --help] [-v | --version] [-d | --debug]
3188  [-f | --format] [-s | --long] [-t | --no-title]
3189  [-x | --vsp-id] [-y | --vsp-version] [-u | --host-username]
3190  [-p | --host-password] [-m | --host-url] [-a | --no-auth]
3191
3192 where::
3193
3194  -h | --help            print help message. It is of type STRING. By
3195                         default, it is false.
3196  -v | --version         print service version. It is of type STRING. By
3197                         default, it is false.
3198  -d | --debug           Enable debug output. It is of type BOOL. By
3199                         default, it is false.
3200  -f | --format          Output formats, supported formats such as table,
3201                         csv, json, yaml. It is of type STRING. By
3202                         default, it is table.
3203  -s | --long            whether to print all attributes or only short
3204                         attributes. It is of type BOOL. By default, it is
3205                         false.
3206  -t | --no-title        whether to print title or not. It is of type
3207                         BOOL. By default, it is false.
3208  -x | --vsp-id          Onap VSP ID. It is of type STRING.
3209  -y | --vsp-version     VSP version. It is of type STRING.
3210  -u | --host-username   Host user name. It is of type STRING. By default,
3211                         it is read from environment variable
3212                         OPEN_CLI_HOST_USERNAME.
3213  -p | --host-password   Host user password. It is of type STRING. By
3214                         default, it is read from environment variable
3215                         OPEN_CLI_HOST_PASSWORD. Secured.
3216  -m | --host-url        host url in http(s). It is of type URL. By
3217                         default, it is read from environment variable
3218                         OPEN_CLI_HOST_URL.
3219  -a | --no-auth         whether to authenticate user or not. It is of
3220                         type BOOL. By default, it is false.
3221
3222
3223 Error::
3224
3225  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
3226
3227
3228
3229 [48] vsp-submit
3230 -----------------------------------------------
3231
3232
3233 usage: oclip vsp-submit
3234
3235 Submit Vendor Software Product
3236
3237 Product: onap-amsterdam
3238 Service: sdc
3239 Author: ONAP CLI Team onap-discuss@lists.onap.org
3240
3241 Options::
3242
3243  [-h | --help] [-v | --version] [-d | --debug]
3244  [-f | --format] [-s | --long] [-t | --no-title]
3245  [-x | --vsp-id] [-y | --vsp-version] [-u | --host-username]
3246  [-p | --host-password] [-m | --host-url] [-a | --no-auth]
3247
3248 where::
3249
3250  -h | --help            print help message. It is of type STRING. By
3251                         default, it is false.
3252  -v | --version         print service version. It is of type STRING. By
3253                         default, it is false.
3254  -d | --debug           Enable debug output. It is of type BOOL. By
3255                         default, it is false.
3256  -f | --format          Output formats, supported formats such as table,
3257                         csv, json, yaml. It is of type STRING. By
3258                         default, it is table.
3259  -s | --long            whether to print all attributes or only short
3260                         attributes. It is of type BOOL. By default, it is
3261                         false.
3262  -t | --no-title        whether to print title or not. It is of type
3263                         BOOL. By default, it is false.
3264  -x | --vsp-id          Onap VSP ID. It is of type STRING.
3265  -y | --vsp-version     VSP version. It is of type STRING.
3266  -u | --host-username   Host user name. It is of type STRING. By default,
3267                         it is read from environment variable
3268                         OPEN_CLI_HOST_USERNAME.
3269  -p | --host-password   Host user password. It is of type STRING. By
3270                         default, it is read from environment variable
3271                         OPEN_CLI_HOST_PASSWORD. Secured.
3272  -m | --host-url        host url in http(s). It is of type URL. By
3273                         default, it is read from environment variable
3274                         OPEN_CLI_HOST_URL.
3275  -a | --no-auth         whether to authenticate user or not. It is of
3276                         type BOOL. By default, it is false.
3277
3278
3279 Error::
3280
3281  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
3282
3283
3284
3285 [49] service-model-certify-complete
3286 -----------------------------------------------
3287
3288
3289 usage: oclip service-model-certify-complete
3290
3291 Completes the certification of Service model in SDC
3292
3293 Product: onap-amsterdam
3294 Service: sdc
3295 Author: ONAP CLI Team onap-discuss@lists.onap.org
3296
3297 Options::
3298
3299  [-h | --help] [-v | --version] [-d | --debug]
3300  [-f | --format] [-s | --long] [-t | --no-title]
3301  [-b | --service-model-id] [-u | --host-username] [-p | --host-password]
3302  [-m | --host-url] [-a | --no-auth]
3303
3304 where::
3305
3306  -h | --help              print help message. It is of type STRING. By
3307                           default, it is false.
3308  -v | --version           print service version. It is of type STRING. By
3309                           default, it is false.
3310  -d | --debug             Enable debug output. It is of type BOOL. By
3311                           default, it is false.
3312  -f | --format            Output formats, supported formats such as table,
3313                           csv, json, yaml. It is of type STRING. By
3314                           default, it is table.
3315  -s | --long              whether to print all attributes or only short
3316                           attributes. It is of type BOOL. By default, it is
3317                           false.
3318  -t | --no-title          whether to print title or not. It is of type
3319                           BOOL. By default, it is false.
3320  -b | --service-model-id  Service model ID. It is of type STRING. It is
3321                           optional.
3322  -u | --host-username     Host user name. It is of type STRING. By default,
3323                           it is read from environment variable
3324                           OPEN_CLI_HOST_USERNAME.
3325  -p | --host-password     Host user password. It is of type STRING. By
3326                           default, it is read from environment variable
3327                           OPEN_CLI_HOST_PASSWORD. Secured.
3328  -m | --host-url          host url in http(s). It is of type URL. By
3329                           default, it is read from environment variable
3330                           OPEN_CLI_HOST_URL.
3331  -a | --no-auth           whether to authenticate user or not. It is of
3332                           type BOOL. By default, it is false.
3333
3334
3335 Error::
3336
3337  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
3338
3339
3340
3341 [50] license-model-show
3342 -----------------------------------------------
3343
3344
3345 usage: oclip license-model-show
3346
3347 Details of the License Model
3348
3349 Product: onap-amsterdam
3350 Service: sdc
3351 Author: ONAP CLI Team onap-discuss@lists.onap.org
3352
3353 Options::
3354
3355  [-h | --help] [-v | --version] [-d | --debug]
3356  [-f | --format] [-s | --long] [-t | --no-title]
3357  [-x | --license-model-id] [-u | --host-username] [-p | --host-password]
3358  [-m | --host-url] [-a | --no-auth]
3359
3360 where::
3361
3362  -h | --help              print help message. It is of type STRING. By
3363                           default, it is false.
3364  -v | --version           print service version. It is of type STRING. By
3365                           default, it is false.
3366  -d | --debug             Enable debug output. It is of type BOOL. By
3367                           default, it is false.
3368  -f | --format            Output formats, supported formats such as table,
3369                           csv, json, yaml. It is of type STRING. By
3370                           default, it is table.
3371  -s | --long              whether to print all attributes or only short
3372                           attributes. It is of type BOOL. By default, it is
3373                           false.
3374  -t | --no-title          whether to print title or not. It is of type
3375                           BOOL. By default, it is false.
3376  -x | --license-model-id  Onap License Model ID. It is of type STRING.
3377  -u | --host-username     Host user name. It is of type STRING. By default,
3378                           it is read from environment variable
3379                           OPEN_CLI_HOST_USERNAME.
3380  -p | --host-password     Host user password. It is of type STRING. By
3381                           default, it is read from environment variable
3382                           OPEN_CLI_HOST_PASSWORD. Secured.
3383  -m | --host-url          host url in http(s). It is of type URL. By
3384                           default, it is read from environment variable
3385                           OPEN_CLI_HOST_URL.
3386  -a | --no-auth           whether to authenticate user or not. It is of
3387                           type BOOL. By default, it is false.
3388
3389
3390 Results::
3391
3392  name         License Model  Name and is of type STRING.
3393  ID           License Model ID and is of type STRING.
3394  description  Description for the License Model and is of type
3395               STRING.
3396  status       Status of the License Model and is of type STRING.
3397
3398
3399 Error::
3400
3401  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
3402
3403
3404
3405 [51] vlm-aggreement-list
3406 -----------------------------------------------
3407
3408
3409 usage: oclip vlm-aggreement-list
3410
3411 List license aggreement
3412
3413 Product: onap-amsterdam
3414 Service: sdc
3415 Author: ONAP CLI Team onap-discuss@lists.onap.org
3416
3417 Options::
3418
3419  [-h | --help] [-v | --version] [-d | --debug]
3420  [-f | --format] [-s | --long] [-t | --no-title]
3421  [-x | --vlm-id] [-y | --vlm-version] [-u | --host-username]
3422  [-p | --host-password] [-m | --host-url] [-a | --no-auth]
3423
3424 where::
3425
3426  -h | --help            print help message. It is of type STRING. By
3427                         default, it is false.
3428  -v | --version         print service version. It is of type STRING. By
3429                         default, it is false.
3430  -d | --debug           Enable debug output. It is of type BOOL. By
3431                         default, it is false.
3432  -f | --format          Output formats, supported formats such as table,
3433                         csv, json, yaml. It is of type STRING. By
3434                         default, it is table.
3435  -s | --long            whether to print all attributes or only short
3436                         attributes. It is of type BOOL. By default, it is
3437                         false.
3438  -t | --no-title        whether to print title or not. It is of type
3439                         BOOL. By default, it is false.
3440  -x | --vlm-id          License Model ID. It is of type STRING.
3441  -y | --vlm-version     License Model version. It is of type STRING.
3442  -u | --host-username   Host user name. It is of type STRING. By default,
3443                         it is read from environment variable
3444                         OPEN_CLI_HOST_USERNAME.
3445  -p | --host-password   Host user password. It is of type STRING. By
3446                         default, it is read from environment variable
3447                         OPEN_CLI_HOST_PASSWORD. Secured.
3448  -m | --host-url        host url in http(s). It is of type URL. By
3449                         default, it is read from environment variable
3450                         OPEN_CLI_HOST_URL.
3451  -a | --no-auth         whether to authenticate user or not. It is of
3452                         type BOOL. By default, it is false.
3453
3454
3455 Results::
3456
3457  ID     aggreement ID and is of type STRING.
3458  name   aggreement name and is of type STRING.
3459
3460
3461 Error::
3462
3463  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
3464
3465
3466
3467 [52] vlm-checkout
3468 -----------------------------------------------
3469
3470
3471 usage: oclip vlm-checkout
3472
3473 Checkout Vendor License Model
3474
3475 Product: onap-amsterdam
3476 Service: sdc
3477 Author: ONAP CLI Team onap-discuss@lists.onap.org
3478
3479 Options::
3480
3481  [-h | --help] [-v | --version] [-d | --debug]
3482  [-f | --format] [-s | --long] [-t | --no-title]
3483  [-x | --vlm-id] [-y | --vlm-version] [-u | --host-username]
3484  [-p | --host-password] [-m | --host-url] [-a | --no-auth]
3485
3486 where::
3487
3488  -h | --help            print help message. It is of type STRING. By
3489                         default, it is false.
3490  -v | --version         print service version. It is of type STRING. By
3491                         default, it is false.
3492  -d | --debug           Enable debug output. It is of type BOOL. By
3493                         default, it is false.
3494  -f | --format          Output formats, supported formats such as table,
3495                         csv, json, yaml. It is of type STRING. By
3496                         default, it is table.
3497  -s | --long            whether to print all attributes or only short
3498                         attributes. It is of type BOOL. By default, it is
3499                         false.
3500  -t | --no-title        whether to print title or not. It is of type
3501                         BOOL. By default, it is false.
3502  -x | --vlm-id          Onap VLM ID. It is of type STRING.
3503  -y | --vlm-version     VLM version. It is of type STRING.
3504  -u | --host-username   Host user name. It is of type STRING. By default,
3505                         it is read from environment variable
3506                         OPEN_CLI_HOST_USERNAME.
3507  -p | --host-password   Host user password. It is of type STRING. By
3508                         default, it is read from environment variable
3509                         OPEN_CLI_HOST_PASSWORD. Secured.
3510  -m | --host-url        host url in http(s). It is of type URL. By
3511                         default, it is read from environment variable
3512                         OPEN_CLI_HOST_URL.
3513  -a | --no-auth         whether to authenticate user or not. It is of
3514                         type BOOL. By default, it is false.
3515
3516
3517 Error::
3518
3519  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
3520
3521
3522
3523 [53] vlm-entitlement-pool-create
3524 -----------------------------------------------
3525
3526
3527 usage: oclip vlm-entitlement-pool-create
3528
3529 Create Entitlement Pool
3530
3531 Product: onap-amsterdam
3532 Service: sdc
3533 Author: ONAP CLI Team onap-discuss@lists.onap.org
3534
3535 Options::
3536
3537  [-h | --help] [-v | --version] [-d | --debug]
3538  [-f | --format] [-s | --long] [-t | --no-title]
3539  [-x | --name] [-y | --vlm-id] [-e | --vlm-version]
3540  [-z | --description] [-g | --operational-scope] [-k | --manufacture-reference-number]
3541  [-u | --host-username] [-p | --host-password] [-m | --host-url]
3542  [-a | --no-auth]
3543
3544 where::
3545
3546  -h | --help                          print help message. It is of type STRING. By
3547                                       default, it is false.
3548  -v | --version                       print service version. It is of type STRING. By
3549                                       default, it is false.
3550  -d | --debug                         Enable debug output. It is of type BOOL. By
3551                                       default, it is false.
3552  -f | --format                        Output formats, supported formats such as table,
3553                                       csv, json, yaml. It is of type STRING. By
3554                                       default, it is table.
3555  -s | --long                          whether to print all attributes or only short
3556                                       attributes. It is of type BOOL. By default, it is
3557                                       false.
3558  -t | --no-title                      whether to print title or not. It is of type
3559                                       BOOL. By default, it is false.
3560  -x | --name                          Entitlement Pool name. It is of type STRING.
3561  -y | --vlm-id                        License Model ID. It is of type STRING.
3562  -e | --vlm-version                   License Model version. It is of type STRING.
3563  -z | --description                   Description for Entitlement Pool. It is of type
3564                                       STRING.
3565  -g | --operational-scope             Operational Scope. It is of type STRING. By
3566                                       default, it is Availability_Zone.
3567  -k | --manufacture-reference-number  Manufature Reference Number. It is of type STRING.
3568  -u | --host-username                 Host user name. It is of type STRING. By default,
3569                                       it is read from environment variable
3570                                       OPEN_CLI_HOST_USERNAME.
3571  -p | --host-password                 Host user password. It is of type STRING. By
3572                                       default, it is read from environment variable
3573                                       OPEN_CLI_HOST_PASSWORD. Secured.
3574  -m | --host-url                      host url in http(s). It is of type URL. By
3575                                       default, it is read from environment variable
3576                                       OPEN_CLI_HOST_URL.
3577  -a | --no-auth                       whether to authenticate user or not. It is of
3578                                       type BOOL. By default, it is false.
3579
3580
3581 Results::
3582
3583  ID   Entitlement Pool ID and is of type STRING.
3584
3585
3586 Error::
3587
3588  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
3589
3590
3591
3592 [54] vlm-feature-group-list
3593 -----------------------------------------------
3594
3595
3596 usage: oclip vlm-feature-group-list
3597
3598 Feature group list in a license model
3599
3600 Product: onap-amsterdam
3601 Service: sdc
3602 Author: ONAP CLI Team onap-discuss@lists.onap.org
3603
3604 Options::
3605
3606  [-h | --help] [-v | --version] [-d | --debug]
3607  [-f | --format] [-s | --long] [-t | --no-title]
3608  [-x | --vlm-id] [-y | --vlm-version] [-u | --host-username]
3609  [-p | --host-password] [-m | --host-url] [-a | --no-auth]
3610
3611 where::
3612
3613  -h | --help            print help message. It is of type STRING. By
3614                         default, it is false.
3615  -v | --version         print service version. It is of type STRING. By
3616                         default, it is false.
3617  -d | --debug           Enable debug output. It is of type BOOL. By
3618                         default, it is false.
3619  -f | --format          Output formats, supported formats such as table,
3620                         csv, json, yaml. It is of type STRING. By
3621                         default, it is table.
3622  -s | --long            whether to print all attributes or only short
3623                         attributes. It is of type BOOL. By default, it is
3624                         false.
3625  -t | --no-title        whether to print title or not. It is of type
3626                         BOOL. By default, it is false.
3627  -x | --vlm-id          License Model ID. It is of type STRING.
3628  -y | --vlm-version     License Model version. It is of type STRING.
3629  -u | --host-username   Host user name. It is of type STRING. By default,
3630                         it is read from environment variable
3631                         OPEN_CLI_HOST_USERNAME.
3632  -p | --host-password   Host user password. It is of type STRING. By
3633                         default, it is read from environment variable
3634                         OPEN_CLI_HOST_PASSWORD. Secured.
3635  -m | --host-url        host url in http(s). It is of type URL. By
3636                         default, it is read from environment variable
3637                         OPEN_CLI_HOST_URL.
3638  -a | --no-auth         whether to authenticate user or not. It is of
3639                         type BOOL. By default, it is false.
3640
3641
3642 Results::
3643
3644  ID     Feature group ID and is of type STRING.
3645  name   Feature group name and is of type STRING.
3646
3647
3648 Error::
3649
3650  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
3651
3652
3653
3654 [55] vlm-key-group-list
3655 -----------------------------------------------
3656
3657
3658 usage: oclip vlm-key-group-list
3659
3660 key group list in a license model
3661
3662 Product: onap-amsterdam
3663 Service: sdc
3664 Author: ONAP CLI Team onap-discuss@lists.onap.org
3665
3666 Options::
3667
3668  [-h | --help] [-v | --version] [-d | --debug]
3669  [-f | --format] [-s | --long] [-t | --no-title]
3670  [-x | --vlm-id] [-y | --vlm-version] [-u | --host-username]
3671  [-p | --host-password] [-m | --host-url] [-a | --no-auth]
3672
3673 where::
3674
3675  -h | --help            print help message. It is of type STRING. By
3676                         default, it is false.
3677  -v | --version         print service version. It is of type STRING. By
3678                         default, it is false.
3679  -d | --debug           Enable debug output. It is of type BOOL. By
3680                         default, it is false.
3681  -f | --format          Output formats, supported formats such as table,
3682                         csv, json, yaml. It is of type STRING. By
3683                         default, it is table.
3684  -s | --long            whether to print all attributes or only short
3685                         attributes. It is of type BOOL. By default, it is
3686                         false.
3687  -t | --no-title        whether to print title or not. It is of type
3688                         BOOL. By default, it is false.
3689  -x | --vlm-id          License Model ID. It is of type STRING.
3690  -y | --vlm-version     License Model version. It is of type STRING.
3691  -u | --host-username   Host user name. It is of type STRING. By default,
3692                         it is read from environment variable
3693                         OPEN_CLI_HOST_USERNAME.
3694  -p | --host-password   Host user password. It is of type STRING. By
3695                         default, it is read from environment variable
3696                         OPEN_CLI_HOST_PASSWORD. Secured.
3697  -m | --host-url        host url in http(s). It is of type URL. By
3698                         default, it is read from environment variable
3699                         OPEN_CLI_HOST_URL.
3700  -a | --no-auth         whether to authenticate user or not. It is of
3701                         type BOOL. By default, it is false.
3702
3703
3704 Results::
3705
3706  ID     Feature group ID and is of type STRING.
3707  name   Feature group name and is of type STRING.
3708
3709
3710 Error::
3711
3712  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
3713
3714
3715
3716 [56] vlm-revert
3717 -----------------------------------------------
3718
3719
3720 usage: oclip vlm-revert
3721
3722 Revert Vendor License Model
3723
3724 Product: onap-amsterdam
3725 Service: sdc
3726 Author: ONAP CLI Team onap-discuss@lists.onap.org
3727
3728 Options::
3729
3730  [-h | --help] [-v | --version] [-d | --debug]
3731  [-f | --format] [-s | --long] [-t | --no-title]
3732  [-x | --vlm-id] [-y | --vlm-version] [-u | --host-username]
3733  [-p | --host-password] [-m | --host-url] [-a | --no-auth]
3734
3735 where::
3736
3737  -h | --help            print help message. It is of type STRING. By
3738                         default, it is false.
3739  -v | --version         print service version. It is of type STRING. By
3740                         default, it is false.
3741  -d | --debug           Enable debug output. It is of type BOOL. By
3742                         default, it is false.
3743  -f | --format          Output formats, supported formats such as table,
3744                         csv, json, yaml. It is of type STRING. By
3745                         default, it is table.
3746  -s | --long            whether to print all attributes or only short
3747                         attributes. It is of type BOOL. By default, it is
3748                         false.
3749  -t | --no-title        whether to print title or not. It is of type
3750                         BOOL. By default, it is false.
3751  -x | --vlm-id          Onap VLM ID. It is of type STRING.
3752  -y | --vlm-version     VLM version. It is of type STRING.
3753  -u | --host-username   Host user name. It is of type STRING. By default,
3754                         it is read from environment variable
3755                         OPEN_CLI_HOST_USERNAME.
3756  -p | --host-password   Host user password. It is of type STRING. By
3757                         default, it is read from environment variable
3758                         OPEN_CLI_HOST_PASSWORD. Secured.
3759  -m | --host-url        host url in http(s). It is of type URL. By
3760                         default, it is read from environment variable
3761                         OPEN_CLI_HOST_URL.
3762  -a | --no-auth         whether to authenticate user or not. It is of
3763                         type BOOL. By default, it is false.
3764
3765
3766 Error::
3767
3768  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
3769
3770
3771
3772 [57] vsp-add-artifact
3773 -----------------------------------------------
3774
3775
3776 usage: oclip vsp-add-artifact
3777
3778 Upload the CSAR file to VSP
3779
3780 Product: onap-amsterdam
3781 Service: sdc
3782 Author: ONAP CLI Team onap-discuss@lists.onap.org
3783
3784 Options::
3785
3786  [-h | --help] [-v | --version] [-d | --debug]
3787  [-f | --format] [-s | --long] [-t | --no-title]
3788  [-x | --vsp-id] [-y | --vsp-version] [-z | --vsp-file]
3789  [-u | --host-username] [-p | --host-password] [-m | --host-url]
3790  [-a | --no-auth]
3791
3792 where::
3793
3794  -h | --help            print help message. It is of type STRING. By
3795                         default, it is false.
3796  -v | --version         print service version. It is of type STRING. By
3797                         default, it is false.
3798  -d | --debug           Enable debug output. It is of type BOOL. By
3799                         default, it is false.
3800  -f | --format          Output formats, supported formats such as table,
3801                         csv, json, yaml. It is of type STRING. By
3802                         default, it is table.
3803  -s | --long            whether to print all attributes or only short
3804                         attributes. It is of type BOOL. By default, it is
3805                         false.
3806  -t | --no-title        whether to print title or not. It is of type
3807                         BOOL. By default, it is false.
3808  -x | --vsp-id          Onap VSP ID. It is of type STRING.
3809  -y | --vsp-version     Onap VSP version. It is of type STRING.
3810  -z | --vsp-file        CSAR File path. It is of type BINARY.
3811  -u | --host-username   Host user name. It is of type STRING. By default,
3812                         it is read from environment variable
3813                         OPEN_CLI_HOST_USERNAME.
3814  -p | --host-password   Host user password. It is of type STRING. By
3815                         default, it is read from environment variable
3816                         OPEN_CLI_HOST_PASSWORD. Secured.
3817  -m | --host-url        host url in http(s). It is of type URL. By
3818                         default, it is read from environment variable
3819                         OPEN_CLI_HOST_URL.
3820  -a | --no-auth         whether to authenticate user or not. It is of
3821                         type BOOL. By default, it is false.
3822
3823
3824 Error::
3825
3826  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
3827
3828
3829
3830 [58] vsp-checkout
3831 -----------------------------------------------
3832
3833
3834 usage: oclip vsp-checkout
3835
3836 Checkout Vendor Software Product
3837
3838 Product: onap-amsterdam
3839 Service: sdc
3840 Author: ONAP CLI Team onap-discuss@lists.onap.org
3841
3842 Options::
3843
3844  [-h | --help] [-v | --version] [-d | --debug]
3845  [-f | --format] [-s | --long] [-t | --no-title]
3846  [-x | --vsp-id] [-y | --vsp-version] [-u | --host-username]
3847  [-p | --host-password] [-m | --host-url] [-a | --no-auth]
3848
3849 where::
3850
3851  -h | --help            print help message. It is of type STRING. By
3852                         default, it is false.
3853  -v | --version         print service version. It is of type STRING. By
3854                         default, it is false.
3855  -d | --debug           Enable debug output. It is of type BOOL. By
3856                         default, it is false.
3857  -f | --format          Output formats, supported formats such as table,
3858                         csv, json, yaml. It is of type STRING. By
3859                         default, it is table.
3860  -s | --long            whether to print all attributes or only short
3861                         attributes. It is of type BOOL. By default, it is
3862                         false.
3863  -t | --no-title        whether to print title or not. It is of type
3864                         BOOL. By default, it is false.
3865  -x | --vsp-id          Onap VSP ID. It is of type STRING.
3866  -y | --vsp-version     VSP version. It is of type STRING.
3867  -u | --host-username   Host user name. It is of type STRING. By default,
3868                         it is read from environment variable
3869                         OPEN_CLI_HOST_USERNAME.
3870  -p | --host-password   Host user password. It is of type STRING. By
3871                         default, it is read from environment variable
3872                         OPEN_CLI_HOST_PASSWORD. Secured.
3873  -m | --host-url        host url in http(s). It is of type URL. By
3874                         default, it is read from environment variable
3875                         OPEN_CLI_HOST_URL.
3876  -a | --no-auth         whether to authenticate user or not. It is of
3877                         type BOOL. By default, it is false.
3878
3879
3880 Error::
3881
3882  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
3883
3884
3885
3886 [59] vsp-list
3887 -----------------------------------------------
3888
3889
3890 usage: oclip vsp-list
3891
3892 List of the Vendor Software Products
3893
3894 Product: onap-amsterdam
3895 Service: sdc
3896 Author: ONAP CLI Team onap-discuss@lists.onap.org
3897
3898 Options::
3899
3900  [-h | --help] [-v | --version] [-d | --debug]
3901  [-f | --format] [-s | --long] [-t | --no-title]
3902  [-u | --host-username] [-p | --host-password] [-m | --host-url]
3903  [-a | --no-auth]
3904
3905 where::
3906
3907  -h | --help            print help message. It is of type STRING. By
3908                         default, it is false.
3909  -v | --version         print service version. It is of type STRING. By
3910                         default, it is false.
3911  -d | --debug           Enable debug output. It is of type BOOL. By
3912                         default, it is false.
3913  -f | --format          Output formats, supported formats such as table,
3914                         csv, json, yaml. It is of type STRING. By
3915                         default, it is table.
3916  -s | --long            whether to print all attributes or only short
3917                         attributes. It is of type BOOL. By default, it is
3918                         false.
3919  -t | --no-title        whether to print title or not. It is of type
3920                         BOOL. By default, it is false.
3921  -u | --host-username   Host user name. It is of type STRING. By default,
3922                         it is read from environment variable
3923                         OPEN_CLI_HOST_USERNAME.
3924  -p | --host-password   Host user password. It is of type STRING. By
3925                         default, it is read from environment variable
3926                         OPEN_CLI_HOST_PASSWORD. Secured.
3927  -m | --host-url        host url in http(s). It is of type URL. By
3928                         default, it is read from environment variable
3929                         OPEN_CLI_HOST_URL.
3930  -a | --no-auth         whether to authenticate user or not. It is of
3931                         type BOOL. By default, it is false.
3932
3933
3934 Results::
3935
3936  ID               VSP ID and is of type STRING.
3937  name             VSP Name and is of type STRING.
3938  vendor-name      Vendor name and is of type STRING.
3939  version          Version and is of type STRING.
3940  status           status and is of type STRING.
3941  license-id       license aggreement and is of type STRING.
3942  license-version  license version and is of type STRING.
3943
3944
3945 Error::
3946
3947  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
3948
3949
3950
3951 [60] vsp-show
3952 -----------------------------------------------
3953
3954
3955 usage: oclip vsp-show
3956
3957 Details of the Vendor Software Product
3958
3959 Product: onap-amsterdam
3960 Service: sdc
3961 Author: ONAP CLI Team onap-discuss@lists.onap.org
3962
3963 Options::
3964
3965  [-h | --help] [-v | --version] [-d | --debug]
3966  [-f | --format] [-s | --long] [-t | --no-title]
3967  [-x | --vsp-id] [-y | --vsp-version] [-u | --host-username]
3968  [-p | --host-password] [-m | --host-url] [-a | --no-auth]
3969
3970 where::
3971
3972  -h | --help            print help message. It is of type STRING. By
3973                         default, it is false.
3974  -v | --version         print service version. It is of type STRING. By
3975                         default, it is false.
3976  -d | --debug           Enable debug output. It is of type BOOL. By
3977                         default, it is false.
3978  -f | --format          Output formats, supported formats such as table,
3979                         csv, json, yaml. It is of type STRING. By
3980                         default, it is table.
3981  -s | --long            whether to print all attributes or only short
3982                         attributes. It is of type BOOL. By default, it is
3983                         false.
3984  -t | --no-title        whether to print title or not. It is of type
3985                         BOOL. By default, it is false.
3986  -x | --vsp-id          Onap VSP ID. It is of type STRING.
3987  -y | --vsp-version     Onap VSP version. It is of type STRING.
3988  -u | --host-username   Host user name. It is of type STRING. By default,
3989                         it is read from environment variable
3990                         OPEN_CLI_HOST_USERNAME.
3991  -p | --host-password   Host user password. It is of type STRING. By
3992                         default, it is read from environment variable
3993                         OPEN_CLI_HOST_PASSWORD. Secured.
3994  -m | --host-url        host url in http(s). It is of type URL. By
3995                         default, it is read from environment variable
3996                         OPEN_CLI_HOST_URL.
3997  -a | --no-auth         whether to authenticate user or not. It is of
3998                         type BOOL. By default, it is false.
3999
4000
4001 Results::
4002
4003  name         VSP Name and is of type STRING.
4004  ID           VSP ID and is of type STRING.
4005  description  Description for the VSP and is of type STRING.
4006  vendor-name  Vendor name and is of type STRING.
4007  vendor-id    Vendor id and is of type STRING.
4008  version      Version and is of type STRING.
4009  status       status and is of type STRING.
4010  license-id   license aggreement and is of type STRING.
4011
4012
4013 Error::
4014
4015  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
4016
4017
4018
4019 [61] microservice-create
4020 -----------------------------------------------
4021
4022
4023 usage: oclip microservice-create
4024
4025 Register microservice into Onap
4026
4027 Product: onap-amsterdam
4028 Service: msb
4029 Author: ONAP CLI Team onap-discuss@lists.onap.org
4030
4031 Options::
4032
4033  [-h | --help] [-v | --version] [-d | --debug]
4034  [-f | --format] [-s | --long] [-t | --no-title]
4035  [-x | --service-name] [-y | --service-version] [-r | --service-url]
4036  [-b | --enable-ssl] [-c | --path] <node-ip>
4037  <node-port> <create-or-update> [-m | --host-url]
4038
4039 where::
4040
4041  -h | --help              print help message. It is of type STRING. By
4042                           default, it is false.
4043  -v | --version           print service version. It is of type STRING. By
4044                           default, it is false.
4045  -d | --debug             Enable debug output. It is of type BOOL. By
4046                           default, it is false.
4047  -f | --format            Output formats, supported formats such as table,
4048                           csv, json, yaml. It is of type STRING. By
4049                           default, it is table.
4050  -s | --long              whether to print all attributes or only short
4051                           attributes. It is of type BOOL. By default, it is
4052                           false.
4053  -t | --no-title          whether to print title or not. It is of type
4054                           BOOL. By default, it is false.
4055  -x | --service-name      Onap service name. It is of type STRING.
4056  -y | --service-version   Onap service version. It is of type STRING.
4057  -r | --service-url       Onap service base url. It is of type URL.
4058  -b | --enable-ssl        Onap service is enabled with https or not. It is
4059                           of type STRING. It is optional.
4060  -c | --path              Onap service path. It is of type STRING. It is
4061                           optional.
4062  node-ip                  Onap service running node IP. It is of type
4063                           STRING.
4064  node-port                Onap service running node port. It is of type
4065                           STRING.
4066  create-or-update         Onap service create or update. It is of type
4067                           BOOL. By default, it is true.
4068  -m | --host-url          host url in http(s). It is of type URL. By
4069                           default, it is read from environment variable
4070                           OPEN_CLI_HOST_URL.
4071
4072
4073 Results::
4074
4075  name         Onap service name and is of type STRING.
4076  version      Onap service version and is of type STRING.
4077  url          Onap service base url and is of type URL.
4078  status       Onap service status and is of type DIGIT.
4079  nodes        Onap service running nodes and is of type STRING.
4080  enable-ssl   Onap service is enabled with https or not and is
4081               of type STRING.
4082  path         Onap service path and is of type STRING.
4083
4084
4085 Error::
4086
4087  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
4088
4089
4090
4091 [62] microservice-delete
4092 -----------------------------------------------
4093
4094
4095 usage: oclip microservice-delete
4096
4097 Deletes the micro service from Onap
4098
4099 Product: onap-amsterdam
4100 Service: msb
4101 Author: ONAP CLI Team onap-discuss@lists.onap.org
4102
4103 Options::
4104
4105  [-h | --help] [-v | --version] [-d | --debug]
4106  [-f | --format] [-s | --long] [-t | --no-title]
4107  [-x | --service-name] [-y | --service-version] [-i | --node-ip]
4108  [-r | --node-port] [-m | --host-url]
4109
4110 where::
4111
4112  -h | --help              print help message. It is of type STRING. By
4113                           default, it is false.
4114  -v | --version           print service version. It is of type STRING. By
4115                           default, it is false.
4116  -d | --debug             Enable debug output. It is of type BOOL. By
4117                           default, it is false.
4118  -f | --format            Output formats, supported formats such as table,
4119                           csv, json, yaml. It is of type STRING. By
4120                           default, it is table.
4121  -s | --long              whether to print all attributes or only short
4122                           attributes. It is of type BOOL. By default, it is
4123                           false.
4124  -t | --no-title          whether to print title or not. It is of type
4125                           BOOL. By default, it is false.
4126  -x | --service-name      Onap service name. It is of type STRING.
4127  -y | --service-version   Onap service version. It is of type STRING.
4128  -i | --node-ip           Onap service running node IP. It is of type
4129                           STRING.
4130  -r | --node-port         Onap service running node port. It is of type
4131                           STRING.
4132  -m | --host-url          host url in http(s). It is of type URL. By
4133                           default, it is read from environment variable
4134                           OPEN_CLI_HOST_URL.
4135
4136
4137 Error::
4138
4139  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
4140
4141
4142
4143 [63] microservice-list
4144 -----------------------------------------------
4145
4146
4147 usage: oclip microservice-list
4148
4149 Lists the registetred micro services in Onap
4150
4151 Product: onap-amsterdam
4152 Service: msb
4153 Author: ONAP CLI Team onap-discuss@lists.onap.org
4154
4155 Options::
4156
4157  [-h | --help] [-v | --version] [-d | --debug]
4158  [-f | --format] [-s | --long] [-t | --no-title]
4159  [-m | --host-url]
4160
4161 where::
4162
4163  -h | --help      print help message. It is of type STRING. By
4164                   default, it is false.
4165  -v | --version   print service version. It is of type STRING. By
4166                   default, it is false.
4167  -d | --debug     Enable debug output. It is of type BOOL. By
4168                   default, it is false.
4169  -f | --format    Output formats, supported formats such as table,
4170                   csv, json, yaml. It is of type STRING. By
4171                   default, it is table.
4172  -s | --long      whether to print all attributes or only short
4173                   attributes. It is of type BOOL. By default, it is
4174                   false.
4175  -t | --no-title  whether to print title or not. It is of type
4176                   BOOL. By default, it is false.
4177  -m | --host-url  host url in http(s). It is of type URL. By
4178                   default, it is read from environment variable
4179                   OPEN_CLI_HOST_URL.
4180
4181
4182 Results::
4183
4184  name         Onap service name and is of type STRING.
4185  version      Onap service version and is of type STRING.
4186  url          Onap service base url and is of type URL.
4187  status       Onap service status and is of type DIGIT.
4188  nodes        Onap service running nodes and is of type JSON.
4189  enable-ssl   Onap service is enabled with https or not and is
4190               of type STRING.
4191  path         Onap service path and is of type STRING.
4192
4193
4194 Error::
4195
4196  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
4197
4198
4199
4200 [64] microservice-show
4201 -----------------------------------------------
4202
4203
4204 usage: oclip microservice-show
4205
4206 Details the registered microservice in Onap
4207
4208 Product: onap-amsterdam
4209 Service: msb
4210 Author: ONAP CLI Team onap-discuss@lists.onap.org
4211
4212 Options::
4213
4214  [-h | --help] [-v | --version] [-d | --debug]
4215  [-f | --format] [-s | --long] [-t | --no-title]
4216  [-x | --service-name] [-y | --service-version] [-m | --host-url]
4217
4218 where::
4219
4220  -h | --help              print help message. It is of type STRING. By
4221                           default, it is false.
4222  -v | --version           print service version. It is of type STRING. By
4223                           default, it is false.
4224  -d | --debug             Enable debug output. It is of type BOOL. By
4225                           default, it is false.
4226  -f | --format            Output formats, supported formats such as table,
4227                           csv, json, yaml. It is of type STRING. By
4228                           default, it is table.
4229  -s | --long              whether to print all attributes or only short
4230                           attributes. It is of type BOOL. By default, it is
4231                           false.
4232  -t | --no-title          whether to print title or not. It is of type
4233                           BOOL. By default, it is false.
4234  -x | --service-name      Onap service name. It is of type STRING.
4235  -y | --service-version   Onap service version. It is of type STRING.
4236  -m | --host-url          host url in http(s). It is of type URL. By
4237                           default, it is read from environment variable
4238                           OPEN_CLI_HOST_URL.
4239
4240
4241 Results::
4242
4243  name         Onap service name and is of type STRING.
4244  version      Onap service version and is of type STRING.
4245  url          Onap service base url and is of type URL.
4246  status       Onap service status and is of type DIGIT.
4247  nodes        Onap service running nodes and is of type JSON.
4248  enable-ssl   Onap service is enabled with https or not and is
4249               of type STRING.
4250  path         Onap service path and is of type STRING.
4251
4252
4253 Error::
4254
4255  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
4256
4257
4258
4259 [65] cloud-delete
4260 -----------------------------------------------
4261
4262
4263 usage: oclip cloud-delete
4264
4265 Delete a cloud region from Onap
4266
4267 Product: onap-amsterdam
4268 Service: aai
4269 Author: ONAP CLI Team onap-discuss@lists.onap.org
4270
4271 Options::
4272
4273  [-h | --help] [-v | --version] [-d | --debug]
4274  [-f | --format] [-s | --long] [-t | --no-title]
4275  [-x | --cloud-name] [-y | --region-name] [-z | --resource-version]
4276  [-u | --host-username] [-p | --host-password] [-m | --host-url]
4277  [-a | --no-auth]
4278
4279 where::
4280
4281  -h | --help              print help message. It is of type STRING. By
4282                           default, it is false.
4283  -v | --version           print service version. It is of type STRING. By
4284                           default, it is false.
4285  -d | --debug             Enable debug output. It is of type BOOL. By
4286                           default, it is false.
4287  -f | --format            Output formats, supported formats such as table,
4288                           csv, json, yaml. It is of type STRING. By
4289                           default, it is table.
4290  -s | --long              whether to print all attributes or only short
4291                           attributes. It is of type BOOL. By default, it is
4292                           false.
4293  -t | --no-title          whether to print title or not. It is of type
4294                           BOOL. By default, it is false.
4295  -x | --cloud-name        Onap cloud name. It is of type STRING.
4296  -y | --region-name       Onap cloud region name. It is of type STRING.
4297  -z | --resource-version  Onap cloud region version. It is of type UUID. It
4298                           is optional. By default, it is
4299                           806a5679-06be-4efb-b420-b314c28efdeb.
4300  -u | --host-username     Host user name. It is of type STRING. By default,
4301                           it is read from environment variable
4302                           OPEN_CLI_HOST_USERNAME.
4303  -p | --host-password     Host user password. It is of type STRING. By
4304                           default, it is read from environment variable
4305                           OPEN_CLI_HOST_PASSWORD. Secured.
4306  -m | --host-url          host url in http(s). It is of type URL. By
4307                           default, it is read from environment variable
4308                           OPEN_CLI_HOST_URL.
4309  -a | --no-auth           whether to authenticate user or not. It is of
4310                           type BOOL. By default, it is false.
4311
4312
4313 Error::
4314
4315  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
4316
4317
4318
4319 [66] customer-delete
4320 -----------------------------------------------
4321
4322
4323 usage: oclip customer-delete
4324
4325 Delete a customer from Onap
4326
4327 Product: onap-amsterdam
4328 Service: aai
4329 Author: ONAP CLI Team onap-discuss@lists.onap.org
4330
4331 Options::
4332
4333  [-h | --help] [-v | --version] [-d | --debug]
4334  [-f | --format] [-s | --long] [-t | --no-title]
4335  [-x | --customer-name] [-y | --resource-version] [-u | --host-username]
4336  [-p | --host-password] [-m | --host-url] [-a | --no-auth]
4337
4338 where::
4339
4340  -h | --help              print help message. It is of type STRING. By
4341                           default, it is false.
4342  -v | --version           print service version. It is of type STRING. By
4343                           default, it is false.
4344  -d | --debug             Enable debug output. It is of type BOOL. By
4345                           default, it is false.
4346  -f | --format            Output formats, supported formats such as table,
4347                           csv, json, yaml. It is of type STRING. By
4348                           default, it is table.
4349  -s | --long              whether to print all attributes or only short
4350                           attributes. It is of type BOOL. By default, it is
4351                           false.
4352  -t | --no-title          whether to print title or not. It is of type
4353                           BOOL. By default, it is false.
4354  -x | --customer-name     Onap customer name. It is of type STRING.
4355  -y | --resource-version  Onap customer resource version. It is of type
4356                           UUID. It is optional. By default, it is
4357                           0c453a65-431c-48f9-ad3b-ed0b4b5859b3.
4358  -u | --host-username     Host user name. It is of type STRING. By default,
4359                           it is read from environment variable
4360                           OPEN_CLI_HOST_USERNAME.
4361  -p | --host-password     Host user password. It is of type STRING. By
4362                           default, it is read from environment variable
4363                           OPEN_CLI_HOST_PASSWORD. Secured.
4364  -m | --host-url          host url in http(s). It is of type URL. By
4365                           default, it is read from environment variable
4366                           OPEN_CLI_HOST_URL.
4367  -a | --no-auth           whether to authenticate user or not. It is of
4368                           type BOOL. By default, it is false.
4369
4370
4371 Error::
4372
4373  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
4374
4375
4376
4377 [67] customer-list
4378 -----------------------------------------------
4379
4380
4381 usage: oclip customer-list
4382
4383 Lists the registetred customers in Onap
4384
4385 Product: onap-amsterdam
4386 Service: aai
4387 Author: ONAP CLI Team onap-discuss@lists.onap.org
4388
4389 Options::
4390
4391  [-h | --help] [-v | --version] [-d | --debug]
4392  [-f | --format] [-s | --long] [-t | --no-title]
4393  [-u | --host-username] [-p | --host-password] [-m | --host-url]
4394  [-a | --no-auth]
4395
4396 where::
4397
4398  -h | --help            print help message. It is of type STRING. By
4399                         default, it is false.
4400  -v | --version         print service version. It is of type STRING. By
4401                         default, it is false.
4402  -d | --debug           Enable debug output. It is of type BOOL. By
4403                         default, it is false.
4404  -f | --format          Output formats, supported formats such as table,
4405                         csv, json, yaml. It is of type STRING. By
4406                         default, it is table.
4407  -s | --long            whether to print all attributes or only short
4408                         attributes. It is of type BOOL. By default, it is
4409                         false.
4410  -t | --no-title        whether to print title or not. It is of type
4411                         BOOL. By default, it is false.
4412  -u | --host-username   Host user name. It is of type STRING. By default,
4413                         it is read from environment variable
4414                         OPEN_CLI_HOST_USERNAME.
4415  -p | --host-password   Host user password. It is of type STRING. By
4416                         default, it is read from environment variable
4417                         OPEN_CLI_HOST_PASSWORD. Secured.
4418  -m | --host-url        host url in http(s). It is of type URL. By
4419                         default, it is read from environment variable
4420                         OPEN_CLI_HOST_URL.
4421  -a | --no-auth         whether to authenticate user or not. It is of
4422                         type BOOL. By default, it is false.
4423
4424
4425 Results::
4426
4427  name               Onap customer name and is of type STRING.
4428  resource-version   Onap customer resource version and is of type
4429                     STRING.
4430
4431
4432 Error::
4433
4434  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
4435
4436
4437
4438 [68] customer-show
4439 -----------------------------------------------
4440
4441
4442 usage: oclip customer-show
4443
4444 Lists the registetred customers in Onap
4445
4446 Product: onap-amsterdam
4447 Service: aai
4448 Author: ONAP CLI Team onap-discuss@lists.onap.org
4449
4450 Options::
4451
4452  [-h | --help] [-v | --version] [-d | --debug]
4453  [-f | --format] [-s | --long] [-t | --no-title]
4454  [-x | --customer-name] [-u | --host-username] [-p | --host-password]
4455  [-m | --host-url] [-a | --no-auth]
4456
4457 where::
4458
4459  -h | --help            print help message. It is of type STRING. By
4460                         default, it is false.
4461  -v | --version         print service version. It is of type STRING. By
4462                         default, it is false.
4463  -d | --debug           Enable debug output. It is of type BOOL. By
4464                         default, it is false.
4465  -f | --format          Output formats, supported formats such as table,
4466                         csv, json, yaml. It is of type STRING. By
4467                         default, it is table.
4468  -s | --long            whether to print all attributes or only short
4469                         attributes. It is of type BOOL. By default, it is
4470                         false.
4471  -t | --no-title        whether to print title or not. It is of type
4472                         BOOL. By default, it is false.
4473  -x | --customer-name   Onap customer name. It is of type STRING.
4474  -u | --host-username   Host user name. It is of type STRING. By default,
4475                         it is read from environment variable
4476                         OPEN_CLI_HOST_USERNAME.
4477  -p | --host-password   Host user password. It is of type STRING. By
4478                         default, it is read from environment variable
4479                         OPEN_CLI_HOST_PASSWORD. Secured.
4480  -m | --host-url        host url in http(s). It is of type URL. By
4481                         default, it is read from environment variable
4482                         OPEN_CLI_HOST_URL.
4483  -a | --no-auth         whether to authenticate user or not. It is of
4484                         type BOOL. By default, it is false.
4485
4486
4487 Results::
4488
4489  name               Onap customer name and is of type STRING.
4490  subscriber-name    Onap subscriber name and is of type STRING.
4491  resource-version   Onap subscriber resource version and is of type
4492                     STRING.
4493  subscriber-type    Onap subscriber type and is of type STRING.
4494
4495
4496 Error::
4497
4498  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
4499
4500
4501
4502 [69] ems-list
4503 -----------------------------------------------
4504
4505
4506 usage: oclip ems-list
4507
4508 List the configured ems
4509
4510 Product: onap-amsterdam
4511 Service: aai
4512 Author: ONAP CLI Team onap-discuss@lists.onap.org
4513
4514 Options::
4515
4516  [-h | --help] [-v | --version] [-d | --debug]
4517  [-f | --format] [-s | --long] [-t | --no-title]
4518  [-u | --host-username] [-p | --host-password] [-m | --host-url]
4519  [-a | --no-auth]
4520
4521 where::
4522
4523  -h | --help            print help message. It is of type STRING. By
4524                         default, it is false.
4525  -v | --version         print service version. It is of type STRING. By
4526                         default, it is false.
4527  -d | --debug           Enable debug output. It is of type BOOL. By
4528                         default, it is false.
4529  -f | --format          Output formats, supported formats such as table,
4530                         csv, json, yaml. It is of type STRING. By
4531                         default, it is table.
4532  -s | --long            whether to print all attributes or only short
4533                         attributes. It is of type BOOL. By default, it is
4534                         false.
4535  -t | --no-title        whether to print title or not. It is of type
4536                         BOOL. By default, it is false.
4537  -u | --host-username   Host user name. It is of type STRING. By default,
4538                         it is read from environment variable
4539                         OPEN_CLI_HOST_USERNAME.
4540  -p | --host-password   Host user password. It is of type STRING. By
4541                         default, it is read from environment variable
4542                         OPEN_CLI_HOST_PASSWORD. Secured.
4543  -m | --host-url        host url in http(s). It is of type URL. By
4544                         default, it is read from environment variable
4545                         OPEN_CLI_HOST_URL.
4546  -a | --no-auth         whether to authenticate user or not. It is of
4547                         type BOOL. By default, it is false.
4548
4549
4550 Results::
4551
4552  ems-id             Onap ems id and is of type STRING.
4553  resource-version   Onap ems resource version and is of type STRING.
4554
4555
4556 Error::
4557
4558  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
4559
4560
4561
4562 [70] sdnc-register
4563 -----------------------------------------------
4564
4565
4566 usage: oclip sdnc-register
4567
4568 Register a SDNC in Onap
4569
4570 Product: onap-amsterdam
4571 Service: aai
4572 Author: ONAP CLI Team onap-discuss@lists.onap.org
4573
4574 Options::
4575
4576  [-h | --help] [-v | --version] [-d | --debug]
4577  [-f | --format] [-s | --long] [-t | --no-title]
4578  [-x | --location] [-y | --sdnc-id] [-b | --name]
4579  [-c | --type] [-e | --vendor] [-q | --sdnc-version]
4580  [-g | --ip-address] [-k | --port] [-r | --protocal]
4581  [-i | --username] [-j | --password] [-z | --product-name]
4582  [-u | --host-username] [-p | --host-password] [-m | --host-url]
4583  [-a | --no-auth]
4584
4585 where::
4586
4587  -h | --help            print help message. It is of type STRING. By
4588                         default, it is false.
4589  -v | --version         print service version. It is of type STRING. By
4590                         default, it is false.
4591  -d | --debug           Enable debug output. It is of type BOOL. By
4592                         default, it is false.
4593  -f | --format          Output formats, supported formats such as table,
4594                         csv, json, yaml. It is of type STRING. By
4595                         default, it is table.
4596  -s | --long            whether to print all attributes or only short
4597                         attributes. It is of type BOOL. By default, it is
4598                         false.
4599  -t | --no-title        whether to print title or not. It is of type
4600                         BOOL. By default, it is false.
4601  -x | --location        Onap VIM unique id. It is of type UUID. By
4602                         default, it is
4603                         32df2939-2901-4908-ba4c-5ddaabf719c5.
4604  -y | --sdnc-id         Onap SDNC unique id. It is of type UUID. By
4605                         default, it is
4606                         ea5db6b0-e8e8-44a9-ae2a-fb9b0d5ab26d.
4607  -b | --name            Onap SDNC name. It is of type STRING.
4608  -c | --type            Onap SDNC type. It is of type STRING.
4609  -e | --vendor          Onap SDNC vendor. It is of type STRING.
4610  -q | --sdnc-version    Onap SDNC version. It is of type STRING.
4611  -g | --ip-address      Onap SDNC ip address. It is of type STRING.
4612  -k | --port            Onap SDNC port. It is of type STRING.
4613  -r | --protocal        Onap SDNC protocal. It is of type STRING.
4614  -i | --username        Onap SDNC username. It is of type STRING.
4615  -j | --password        Onap SDNC password. It is of type STRING.
4616  -z | --product-name    Onap SDNC product-name. It is of type STRING.
4617  -u | --host-username   Host user name. It is of type STRING. By default,
4618                         it is read from environment variable
4619                         OPEN_CLI_HOST_USERNAME.
4620  -p | --host-password   Host user password. It is of type STRING. By
4621                         default, it is read from environment variable
4622                         OPEN_CLI_HOST_PASSWORD. Secured.
4623  -m | --host-url        host url in http(s). It is of type URL. By
4624                         default, it is read from environment variable
4625                         OPEN_CLI_HOST_URL.
4626  -a | --no-auth         whether to authenticate user or not. It is of
4627                         type BOOL. By default, it is false.
4628
4629
4630 Error::
4631
4632  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
4633
4634
4635
4636 [71] sdnc-list
4637 -----------------------------------------------
4638
4639
4640 usage: oclip sdnc-list
4641
4642 List the configured sdnc
4643
4644 Product: onap-amsterdam
4645 Service: aai
4646 Author: ONAP CLI Team onap-discuss@lists.onap.org
4647
4648 Options::
4649
4650  [-h | --help] [-v | --version] [-d | --debug]
4651  [-f | --format] [-s | --long] [-t | --no-title]
4652  [-u | --host-username] [-p | --host-password] [-m | --host-url]
4653  [-a | --no-auth]
4654
4655 where::
4656
4657  -h | --help            print help message. It is of type STRING. By
4658                         default, it is false.
4659  -v | --version         print service version. It is of type STRING. By
4660                         default, it is false.
4661  -d | --debug           Enable debug output. It is of type BOOL. By
4662                         default, it is false.
4663  -f | --format          Output formats, supported formats such as table,
4664                         csv, json, yaml. It is of type STRING. By
4665                         default, it is table.
4666  -s | --long            whether to print all attributes or only short
4667                         attributes. It is of type BOOL. By default, it is
4668                         false.
4669  -t | --no-title        whether to print title or not. It is of type
4670                         BOOL. By default, it is false.
4671  -u | --host-username   Host user name. It is of type STRING. By default,
4672                         it is read from environment variable
4673                         OPEN_CLI_HOST_USERNAME.
4674  -p | --host-password   Host user password. It is of type STRING. By
4675                         default, it is read from environment variable
4676                         OPEN_CLI_HOST_PASSWORD. Secured.
4677  -m | --host-url        host url in http(s). It is of type URL. By
4678                         default, it is read from environment variable
4679                         OPEN_CLI_HOST_URL.
4680  -a | --no-auth         whether to authenticate user or not. It is of
4681                         type BOOL. By default, it is false.
4682
4683
4684 Results::
4685
4686  sdnc-id            Onap sdnc id and is of type STRING.
4687  resource-version   Onap sdnc resource version and is of type STRING.
4688
4689
4690 Error::
4691
4692  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
4693
4694
4695
4696 [72] cloud-create
4697 -----------------------------------------------
4698
4699
4700 usage: oclip cloud-create
4701
4702 Create a cloud region in Onap
4703
4704 Product: onap-amsterdam
4705 Service: aai
4706 Author: ONAP CLI Team onap-discuss@lists.onap.org
4707
4708 Options::
4709
4710  [-h | --help] [-v | --version] [-d | --debug]
4711  [-f | --format] [-s | --long] [-t | --no-title]
4712  [-x | --cloud-name] [-y | --region-name] [-u | --host-username]
4713  [-p | --host-password] [-m | --host-url] [-a | --no-auth]
4714
4715 where::
4716
4717  -h | --help            print help message. It is of type STRING. By
4718                         default, it is false.
4719  -v | --version         print service version. It is of type STRING. By
4720                         default, it is false.
4721  -d | --debug           Enable debug output. It is of type BOOL. By
4722                         default, it is false.
4723  -f | --format          Output formats, supported formats such as table,
4724                         csv, json, yaml. It is of type STRING. By
4725                         default, it is table.
4726  -s | --long            whether to print all attributes or only short
4727                         attributes. It is of type BOOL. By default, it is
4728                         false.
4729  -t | --no-title        whether to print title or not. It is of type
4730                         BOOL. By default, it is false.
4731  -x | --cloud-name      Onap cloud name. It is of type STRING.
4732  -y | --region-name     Onap  region name. It is of type STRING.
4733  -u | --host-username   Host user name. It is of type STRING. By default,
4734                         it is read from environment variable
4735                         OPEN_CLI_HOST_USERNAME.
4736  -p | --host-password   Host user password. It is of type STRING. By
4737                         default, it is read from environment variable
4738                         OPEN_CLI_HOST_PASSWORD. Secured.
4739  -m | --host-url        host url in http(s). It is of type URL. By
4740                         default, it is read from environment variable
4741                         OPEN_CLI_HOST_URL.
4742  -a | --no-auth         whether to authenticate user or not. It is of
4743                         type BOOL. By default, it is false.
4744
4745
4746 Error::
4747
4748  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
4749
4750
4751
4752 [73] ems-register
4753 -----------------------------------------------
4754
4755
4756 usage: oclip ems-register
4757
4758 Register a EMS in Onap
4759
4760 Product: onap-amsterdam
4761 Service: aai
4762 Author: ONAP CLI Team onap-discuss@lists.onap.org
4763
4764 Options::
4765
4766  [-h | --help] [-v | --version] [-d | --debug]
4767  [-f | --format] [-s | --long] [-t | --no-title]
4768  [-z | --ems-id] [-b | --name] [-c | --type]
4769  [-e | --vendor] [-q | --ems-version] [-g | --url]
4770  [-i | --username] [-j | --password] [-x | --remote-path]
4771  [-u | --host-username] [-p | --host-password] [-m | --host-url]
4772  [-a | --no-auth]
4773
4774 where::
4775
4776  -h | --help            print help message. It is of type STRING. By
4777                         default, it is false.
4778  -v | --version         print service version. It is of type STRING. By
4779                         default, it is false.
4780  -d | --debug           Enable debug output. It is of type BOOL. By
4781                         default, it is false.
4782  -f | --format          Output formats, supported formats such as table,
4783                         csv, json, yaml. It is of type STRING. By
4784                         default, it is table.
4785  -s | --long            whether to print all attributes or only short
4786                         attributes. It is of type BOOL. By default, it is
4787                         false.
4788  -t | --no-title        whether to print title or not. It is of type
4789                         BOOL. By default, it is false.
4790  -z | --ems-id          Onap EMS unique id. It is of type UUID. By
4791                         default, it is
4792                         5888ad8e-c90c-4120-8a7e-dbdfe567db1c.
4793  -b | --name            Onap EMS name. It is of type STRING.
4794  -c | --type            Onap EMS type. It is of type STRING.
4795  -e | --vendor          Onap EMS vendor. It is of type STRING.
4796  -q | --ems-version     Onap EMS version. It is of type STRING.
4797  -g | --url             Onap EMS URL. It is of type STRING.
4798  -i | --username        Onap EMS username. It is of type STRING.
4799  -j | --password        Onap EMS password. It is of type STRING.
4800  -x | --remote-path     Onap EMS remote-path. It is of type STRING.
4801  -u | --host-username   Host user name. It is of type STRING. By default,
4802                         it is read from environment variable
4803                         OPEN_CLI_HOST_USERNAME.
4804  -p | --host-password   Host user password. It is of type STRING. By
4805                         default, it is read from environment variable
4806                         OPEN_CLI_HOST_PASSWORD. Secured.
4807  -m | --host-url        host url in http(s). It is of type URL. By
4808                         default, it is read from environment variable
4809                         OPEN_CLI_HOST_URL.
4810  -a | --no-auth         whether to authenticate user or not. It is of
4811                         type BOOL. By default, it is false.
4812
4813
4814 Error::
4815
4816  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
4817
4818
4819
4820 [74] ems-unregister
4821 -----------------------------------------------
4822
4823
4824 usage: oclip ems-unregister
4825
4826 Un-register a EMS in Onap
4827
4828 Product: onap-amsterdam
4829 Service: aai
4830 Author: ONAP CLI Team onap-discuss@lists.onap.org
4831
4832 Options::
4833
4834  [-h | --help] [-v | --version] [-d | --debug]
4835  [-f | --format] [-s | --long] [-t | --no-title]
4836  [-x | --ems-id] [-y | --resource-version] [-u | --host-username]
4837  [-p | --host-password] [-m | --host-url] [-a | --no-auth]
4838
4839 where::
4840
4841  -h | --help              print help message. It is of type STRING. By
4842                           default, it is false.
4843  -v | --version           print service version. It is of type STRING. By
4844                           default, it is false.
4845  -d | --debug             Enable debug output. It is of type BOOL. By
4846                           default, it is false.
4847  -f | --format            Output formats, supported formats such as table,
4848                           csv, json, yaml. It is of type STRING. By
4849                           default, it is table.
4850  -s | --long              whether to print all attributes or only short
4851                           attributes. It is of type BOOL. By default, it is
4852                           false.
4853  -t | --no-title          whether to print title or not. It is of type
4854                           BOOL. By default, it is false.
4855  -x | --ems-id            Onap EMS unique id. It is of type UUID. By
4856                           default, it is
4857                           34953098-9d3f-4438-95e8-9d9ce430d7d3.
4858  -y | --resource-version  Onap vim resource version. It is of type STRING.
4859                           It is optional.
4860  -u | --host-username     Host user name. It is of type STRING. By default,
4861                           it is read from environment variable
4862                           OPEN_CLI_HOST_USERNAME.
4863  -p | --host-password     Host user password. It is of type STRING. By
4864                           default, it is read from environment variable
4865                           OPEN_CLI_HOST_PASSWORD. Secured.
4866  -m | --host-url          host url in http(s). It is of type URL. By
4867                           default, it is read from environment variable
4868                           OPEN_CLI_HOST_URL.
4869  -a | --no-auth           whether to authenticate user or not. It is of
4870                           type BOOL. By default, it is false.
4871
4872
4873 Error::
4874
4875  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
4876
4877
4878
4879 [75] ems-show
4880 -----------------------------------------------
4881
4882
4883 usage: oclip ems-show
4884
4885 Show the details of configured ems
4886
4887 Product: onap-amsterdam
4888 Service: aai
4889 Author: ONAP CLI Team onap-discuss@lists.onap.org
4890
4891 Options::
4892
4893  [-h | --help] [-v | --version] [-d | --debug]
4894  [-f | --format] [-s | --long] [-t | --no-title]
4895  [-x | --ems-id] [-u | --host-username] [-p | --host-password]
4896  [-m | --host-url] [-a | --no-auth]
4897
4898 where::
4899
4900  -h | --help            print help message. It is of type STRING. By
4901                         default, it is false.
4902  -v | --version         print service version. It is of type STRING. By
4903                         default, it is false.
4904  -d | --debug           Enable debug output. It is of type BOOL. By
4905                         default, it is false.
4906  -f | --format          Output formats, supported formats such as table,
4907                         csv, json, yaml. It is of type STRING. By
4908                         default, it is table.
4909  -s | --long            whether to print all attributes or only short
4910                         attributes. It is of type BOOL. By default, it is
4911                         false.
4912  -t | --no-title        whether to print title or not. It is of type
4913                         BOOL. By default, it is false.
4914  -x | --ems-id          Onap EMS unique id. It is of type UUID. By
4915                         default, it is
4916                         44b59f48-34cb-4f07-84fb-b8b1033570df.
4917  -u | --host-username   Host user name. It is of type STRING. By default,
4918                         it is read from environment variable
4919                         OPEN_CLI_HOST_USERNAME.
4920  -p | --host-password   Host user password. It is of type STRING. By
4921                         default, it is read from environment variable
4922                         OPEN_CLI_HOST_PASSWORD. Secured.
4923  -m | --host-url        host url in http(s). It is of type URL. By
4924                         default, it is read from environment variable
4925                         OPEN_CLI_HOST_URL.
4926  -a | --no-auth         whether to authenticate user or not. It is of
4927                         type BOOL. By default, it is false.
4928
4929
4930 Results::
4931
4932  name       Onap ems name and is of type STRING.
4933  type       Onap ems type and is of type STRING.
4934  vendor     Onap ems vendor and is of type STRING.
4935  version    Onap ems version and is of type STRING.
4936  url        Onap ems url and is of type STRING.
4937  username   Onap ems username and is of type STRING.
4938
4939
4940 Error::
4941
4942  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
4943
4944
4945
4946 [76] sdnc-unregister
4947 -----------------------------------------------
4948
4949
4950 usage: oclip sdnc-unregister
4951
4952 Un-register a VNFM in Onap
4953
4954 Product: onap-amsterdam
4955 Service: aai
4956 Author: ONAP CLI Team onap-discuss@lists.onap.org
4957
4958 Options::
4959
4960  [-h | --help] [-v | --version] [-d | --debug]
4961  [-f | --format] [-s | --long] [-t | --no-title]
4962  [-x | --sdnc-id] [-u | --host-username] [-p | --host-password]
4963  [-m | --host-url] [-a | --no-auth]
4964
4965 where::
4966
4967  -h | --help            print help message. It is of type STRING. By
4968                         default, it is false.
4969  -v | --version         print service version. It is of type STRING. By
4970                         default, it is false.
4971  -d | --debug           Enable debug output. It is of type BOOL. By
4972                         default, it is false.
4973  -f | --format          Output formats, supported formats such as table,
4974                         csv, json, yaml. It is of type STRING. By
4975                         default, it is table.
4976  -s | --long            whether to print all attributes or only short
4977                         attributes. It is of type BOOL. By default, it is
4978                         false.
4979  -t | --no-title        whether to print title or not. It is of type
4980                         BOOL. By default, it is false.
4981  -x | --sdnc-id         Onap VNFM unique id. It is of type STRING.
4982  -u | --host-username   Host user name. It is of type STRING. By default,
4983                         it is read from environment variable
4984                         OPEN_CLI_HOST_USERNAME.
4985  -p | --host-password   Host user password. It is of type STRING. By
4986                         default, it is read from environment variable
4987                         OPEN_CLI_HOST_PASSWORD. Secured.
4988  -m | --host-url        host url in http(s). It is of type URL. By
4989                         default, it is read from environment variable
4990                         OPEN_CLI_HOST_URL.
4991  -a | --no-auth         whether to authenticate user or not. It is of
4992                         type BOOL. By default, it is false.
4993
4994
4995 Error::
4996
4997  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
4998
4999
5000
5001 [77] vim-register
5002 -----------------------------------------------
5003
5004
5005 usage: oclip vim-register
5006
5007 Register a VIM under a given cloud region in Onap
5008
5009 Product: onap-amsterdam
5010 Service: aai
5011 Author: ONAP CLI Team onap-discuss@lists.onap.org
5012
5013 Options::
5014
5015  [-h | --help] [-v | --version] [-d | --debug]
5016  [-f | --format] [-s | --long] [-t | --no-title]
5017  [-x | --cloud-name] [-y | --region-name] [-z | --vim-id]
5018  [-b | --name] [-c | --type] [-e | --vendor]
5019  [-q | --vim-version] [-g | --url] [-i | --username]
5020  [-j | --password] [-k | --ssl-cacert] [-l | --ssl-insecure]
5021  [-n | --cloud-domain] [-o | --default-tenant] [-u | --host-username]
5022  [-p | --host-password] [-m | --host-url] [-a | --no-auth]
5023
5024 where::
5025
5026  -h | --help            print help message. It is of type STRING. By
5027                         default, it is false.
5028  -v | --version         print service version. It is of type STRING. By
5029                         default, it is false.
5030  -d | --debug           Enable debug output. It is of type BOOL. By
5031                         default, it is false.
5032  -f | --format          Output formats, supported formats such as table,
5033                         csv, json, yaml. It is of type STRING. By
5034                         default, it is table.
5035  -s | --long            whether to print all attributes or only short
5036                         attributes. It is of type BOOL. By default, it is
5037                         false.
5038  -t | --no-title        whether to print title or not. It is of type
5039                         BOOL. By default, it is false.
5040  -x | --cloud-name      Onap cloud name. It is of type STRING.
5041  -y | --region-name     Onap  region name. It is of type STRING.
5042  -z | --vim-id          Onap VIM unique id. It is of type UUID. By
5043                         default, it is
5044                         b7eae86a-0e63-4804-93a9-4127a7c1d747.
5045  -b | --name            Onap VIM name. It is of type STRING.
5046  -c | --type            Onap VIM type. It is of type STRING.
5047  -e | --vendor          Onap VIM vendor. It is of type STRING.
5048  -q | --vim-version     Onap VIM version. It is of type STRING.
5049  -g | --url             Onap VIM URL. It is of type STRING.
5050  -i | --username        Onap VIM username. It is of type STRING.
5051  -j | --password        Onap VIM password. It is of type STRING.
5052  -k | --ssl-cacert      Onap VIM SSL certificate. It is of type TEXT. It
5053                         is optional.
5054  -l | --ssl-insecure    Onap VIM insecure. It is of type BOOL. It is
5055                         optional. By default, it is false.
5056  -n | --cloud-domain    Onap VIM cloud domain. It is of type STRING.
5057  -o | --default-tenant  Onap VIM default tenant. It is of type STRING.
5058  -u | --host-username   Host user name. It is of type STRING. By default,
5059                         it is read from environment variable
5060                         OPEN_CLI_HOST_USERNAME.
5061  -p | --host-password   Host user password. It is of type STRING. By
5062                         default, it is read from environment variable
5063                         OPEN_CLI_HOST_PASSWORD. Secured.
5064  -m | --host-url        host url in http(s). It is of type URL. By
5065                         default, it is read from environment variable
5066                         OPEN_CLI_HOST_URL.
5067  -a | --no-auth         whether to authenticate user or not. It is of
5068                         type BOOL. By default, it is false.
5069
5070
5071 Error::
5072
5073  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
5074
5075
5076
5077 [78] vim-unregister
5078 -----------------------------------------------
5079
5080
5081 usage: oclip vim-unregister
5082
5083 Un-register a VIM under from cloud region in Onap
5084
5085 Product: onap-amsterdam
5086 Service: aai
5087 Author: ONAP CLI Team onap-discuss@lists.onap.org
5088
5089 Options::
5090
5091  [-h | --help] [-v | --version] [-d | --debug]
5092  [-f | --format] [-s | --long] [-t | --no-title]
5093  [-x | --cloud-name] [-y | --region-name] [-z | --vim-id]
5094  [-b | --resource-version] [-u | --host-username] [-p | --host-password]
5095  [-m | --host-url] [-a | --no-auth]
5096
5097 where::
5098
5099  -h | --help              print help message. It is of type STRING. By
5100                           default, it is false.
5101  -v | --version           print service version. It is of type STRING. By
5102                           default, it is false.
5103  -d | --debug             Enable debug output. It is of type BOOL. By
5104                           default, it is false.
5105  -f | --format            Output formats, supported formats such as table,
5106                           csv, json, yaml. It is of type STRING. By
5107                           default, it is table.
5108  -s | --long              whether to print all attributes or only short
5109                           attributes. It is of type BOOL. By default, it is
5110                           false.
5111  -t | --no-title          whether to print title or not. It is of type
5112                           BOOL. By default, it is false.
5113  -x | --cloud-name        Onap cloud name. It is of type STRING.
5114  -y | --region-name       Onap  region name. It is of type STRING.
5115  -z | --vim-id            Onap VIM unique id. It is of type UUID. By
5116                           default, it is
5117                           98319f86-9d39-4d59-8a89-7902f2214056.
5118  -b | --resource-version  Onap vim resource version. It is of type STRING.
5119                           It is optional.
5120  -u | --host-username     Host user name. It is of type STRING. By default,
5121                           it is read from environment variable
5122                           OPEN_CLI_HOST_USERNAME.
5123  -p | --host-password     Host user password. It is of type STRING. By
5124                           default, it is read from environment variable
5125                           OPEN_CLI_HOST_PASSWORD. Secured.
5126  -m | --host-url          host url in http(s). It is of type URL. By
5127                           default, it is read from environment variable
5128                           OPEN_CLI_HOST_URL.
5129  -a | --no-auth           whether to authenticate user or not. It is of
5130                           type BOOL. By default, it is false.
5131
5132
5133 Error::
5134
5135  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
5136
5137
5138
5139 [79] vim-list
5140 -----------------------------------------------
5141
5142
5143 usage: oclip vim-list
5144
5145 List the configured vims
5146
5147 Product: onap-amsterdam
5148 Service: aai
5149 Author: ONAP CLI Team onap-discuss@lists.onap.org
5150
5151 Options::
5152
5153  [-h | --help] [-v | --version] [-d | --debug]
5154  [-f | --format] [-s | --long] [-t | --no-title]
5155  [-x | --cloud-name] [-y | --region-name] [-u | --host-username]
5156  [-p | --host-password] [-m | --host-url] [-a | --no-auth]
5157
5158 where::
5159
5160  -h | --help            print help message. It is of type STRING. By
5161                         default, it is false.
5162  -v | --version         print service version. It is of type STRING. By
5163                         default, it is false.
5164  -d | --debug           Enable debug output. It is of type BOOL. By
5165                         default, it is false.
5166  -f | --format          Output formats, supported formats such as table,
5167                         csv, json, yaml. It is of type STRING. By
5168                         default, it is table.
5169  -s | --long            whether to print all attributes or only short
5170                         attributes. It is of type BOOL. By default, it is
5171                         false.
5172  -t | --no-title        whether to print title or not. It is of type
5173                         BOOL. By default, it is false.
5174  -x | --cloud-name      Onap cloud name. It is of type STRING.
5175  -y | --region-name     Onap  region name. It is of type STRING.
5176  -u | --host-username   Host user name. It is of type STRING. By default,
5177                         it is read from environment variable
5178                         OPEN_CLI_HOST_USERNAME.
5179  -p | --host-password   Host user password. It is of type STRING. By
5180                         default, it is read from environment variable
5181                         OPEN_CLI_HOST_PASSWORD. Secured.
5182  -m | --host-url        host url in http(s). It is of type URL. By
5183                         default, it is read from environment variable
5184                         OPEN_CLI_HOST_URL.
5185  -a | --no-auth         whether to authenticate user or not. It is of
5186                         type BOOL. By default, it is false.
5187
5188
5189 Results::
5190
5191  vim-id             Onap vim id and is of type STRING.
5192  name               Onap vim name and is of type STRING.
5193  type               Onap vim type and is of type STRING.
5194  vendor             Onap vim vendor and is of type STRING.
5195  version            Onap vim version and is of type STRING.
5196  url                Onap vim url and is of type STRING.
5197  username           Onap vim username and is of type STRING.
5198  cloud-domain       Onap vim cloud domain and is of type STRING.
5199  default-tenant     Onap vim tenant and is of type STRING.
5200  resource-version   Onap vim resource version and is of type STRING.
5201
5202
5203 Error::
5204
5205  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
5206
5207
5208
5209 [80] vnfm-register
5210 -----------------------------------------------
5211
5212
5213 usage: oclip vnfm-register
5214
5215 Register a VNFM in Onap
5216
5217 Product: onap-amsterdam
5218 Service: aai
5219 Author: ONAP CLI Team onap-discuss@lists.onap.org
5220
5221 Options::
5222
5223  [-h | --help] [-v | --version] [-d | --debug]
5224  [-f | --format] [-s | --long] [-t | --no-title]
5225  [-x | --vim-id] [-y | --vnfm-id] [-b | --name]
5226  [-c | --type] [-e | --vendor] [-q | --vnfm-version]
5227  [-g | --url] [-i | --username] [-j | --password]
5228  [-z | --certificate-url] [-u | --host-username] [-p | --host-password]
5229  [-m | --host-url] [-a | --no-auth]
5230
5231 where::
5232
5233  -h | --help              print help message. It is of type STRING. By
5234                           default, it is false.
5235  -v | --version           print service version. It is of type STRING. By
5236                           default, it is false.
5237  -d | --debug             Enable debug output. It is of type BOOL. By
5238                           default, it is false.
5239  -f | --format            Output formats, supported formats such as table,
5240                           csv, json, yaml. It is of type STRING. By
5241                           default, it is table.
5242  -s | --long              whether to print all attributes or only short
5243                           attributes. It is of type BOOL. By default, it is
5244                           false.
5245  -t | --no-title          whether to print title or not. It is of type
5246                           BOOL. By default, it is false.
5247  -x | --vim-id            Onap VIM unique id. It is of type UUID. By
5248                           default, it is
5249                           f3e8293e-7315-4945-8f8e-a0dd13a880cc.
5250  -y | --vnfm-id           Onap VNFM unique id. It is of type UUID. By
5251                           default, it is
5252                           c35aee19-2416-4f13-9fd2-bc76e70db99c.
5253  -b | --name              Onap VNFM name. It is of type STRING.
5254  -c | --type              Onap VNFM type. It is of type STRING.
5255  -e | --vendor            Onap VNFM vendor. It is of type STRING.
5256  -q | --vnfm-version      Onap VNFM version. It is of type STRING.
5257  -g | --url               Onap VNFM URL. It is of type STRING.
5258  -i | --username          Onap VNFM username. It is of type STRING.
5259  -j | --password          Onap VNFM password. It is of type STRING.
5260  -z | --certificate-url   Onap VNFM certificate-url. It is of type STRING.
5261                           It is optional.
5262  -u | --host-username     Host user name. It is of type STRING. By default,
5263                           it is read from environment variable
5264                           OPEN_CLI_HOST_USERNAME.
5265  -p | --host-password     Host user password. It is of type STRING. By
5266                           default, it is read from environment variable
5267                           OPEN_CLI_HOST_PASSWORD. Secured.
5268  -m | --host-url          host url in http(s). It is of type URL. By
5269                           default, it is read from environment variable
5270                           OPEN_CLI_HOST_URL.
5271  -a | --no-auth           whether to authenticate user or not. It is of
5272                           type BOOL. By default, it is false.
5273
5274
5275 Error::
5276
5277  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
5278
5279
5280
5281 [81] vnfm-unregister
5282 -----------------------------------------------
5283
5284
5285 usage: oclip vnfm-unregister
5286
5287 Un-register a VNFM in Onap
5288
5289 Product: onap-amsterdam
5290 Service: aai
5291 Author: ONAP CLI Team onap-discuss@lists.onap.org
5292
5293 Options::
5294
5295  [-h | --help] [-v | --version] [-d | --debug]
5296  [-f | --format] [-s | --long] [-t | --no-title]
5297  [-x | --vnfm-id] [-y | --resource-version] [-u | --host-username]
5298  [-p | --host-password] [-m | --host-url] [-a | --no-auth]
5299
5300 where::
5301
5302  -h | --help              print help message. It is of type STRING. By
5303                           default, it is false.
5304  -v | --version           print service version. It is of type STRING. By
5305                           default, it is false.
5306  -d | --debug             Enable debug output. It is of type BOOL. By
5307                           default, it is false.
5308  -f | --format            Output formats, supported formats such as table,
5309                           csv, json, yaml. It is of type STRING. By
5310                           default, it is table.
5311  -s | --long              whether to print all attributes or only short
5312                           attributes. It is of type BOOL. By default, it is
5313                           false.
5314  -t | --no-title          whether to print title or not. It is of type
5315                           BOOL. By default, it is false.
5316  -x | --vnfm-id           Onap VNFM unique id. It is of type UUID. By
5317                           default, it is
5318                           2cbe3dc0-97cb-41e9-b8db-411e6a0975e6.
5319  -y | --resource-version  Onap vim resource version. It is of type STRING.
5320                           It is optional.
5321  -u | --host-username     Host user name. It is of type STRING. By default,
5322                           it is read from environment variable
5323                           OPEN_CLI_HOST_USERNAME.
5324  -p | --host-password     Host user password. It is of type STRING. By
5325                           default, it is read from environment variable
5326                           OPEN_CLI_HOST_PASSWORD. Secured.
5327  -m | --host-url          host url in http(s). It is of type URL. By
5328                           default, it is read from environment variable
5329                           OPEN_CLI_HOST_URL.
5330  -a | --no-auth           whether to authenticate user or not. It is of
5331                           type BOOL. By default, it is false.
5332
5333
5334 Error::
5335
5336  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
5337
5338
5339
5340 [82] vnfm-list
5341 -----------------------------------------------
5342
5343
5344 usage: oclip vnfm-list
5345
5346 List the configured vnfm
5347
5348 Product: onap-amsterdam
5349 Service: aai
5350 Author: ONAP CLI Team onap-discuss@lists.onap.org
5351
5352 Options::
5353
5354  [-h | --help] [-v | --version] [-d | --debug]
5355  [-f | --format] [-s | --long] [-t | --no-title]
5356  [-u | --host-username] [-p | --host-password] [-m | --host-url]
5357  [-a | --no-auth]
5358
5359 where::
5360
5361  -h | --help            print help message. It is of type STRING. By
5362                         default, it is false.
5363  -v | --version         print service version. It is of type STRING. By
5364                         default, it is false.
5365  -d | --debug           Enable debug output. It is of type BOOL. By
5366                         default, it is false.
5367  -f | --format          Output formats, supported formats such as table,
5368                         csv, json, yaml. It is of type STRING. By
5369                         default, it is table.
5370  -s | --long            whether to print all attributes or only short
5371                         attributes. It is of type BOOL. By default, it is
5372                         false.
5373  -t | --no-title        whether to print title or not. It is of type
5374                         BOOL. By default, it is false.
5375  -u | --host-username   Host user name. It is of type STRING. By default,
5376                         it is read from environment variable
5377                         OPEN_CLI_HOST_USERNAME.
5378  -p | --host-password   Host user password. It is of type STRING. By
5379                         default, it is read from environment variable
5380                         OPEN_CLI_HOST_PASSWORD. Secured.
5381  -m | --host-url        host url in http(s). It is of type URL. By
5382                         default, it is read from environment variable
5383                         OPEN_CLI_HOST_URL.
5384  -a | --no-auth         whether to authenticate user or not. It is of
5385                         type BOOL. By default, it is false.
5386
5387
5388 Results::
5389
5390  vnfm-id            Onap vnfm id and is of type STRING.
5391  vim-id             Onap vnfm id and is of type STRING.
5392  certificate-url    Onap vnfm certificate-url and is of type STRING.
5393  resource-version   Onap vnfm resource version and is of type STRING.
5394
5395
5396 Error::
5397
5398  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
5399
5400
5401
5402 [83] vnfm-show
5403 -----------------------------------------------
5404
5405
5406 usage: oclip vnfm-show
5407
5408 Show the VNFM in Onap
5409
5410 Product: onap-amsterdam
5411 Service: aai
5412 Author: ONAP CLI Team onap-discuss@lists.onap.org
5413
5414 Options::
5415
5416  [-h | --help] [-v | --version] [-d | --debug]
5417  [-f | --format] [-s | --long] [-t | --no-title]
5418  [-x | --vnfm-id] [-u | --host-username] [-p | --host-password]
5419  [-m | --host-url] [-a | --no-auth]
5420
5421 where::
5422
5423  -h | --help            print help message. It is of type STRING. By
5424                         default, it is false.
5425  -v | --version         print service version. It is of type STRING. By
5426                         default, it is false.
5427  -d | --debug           Enable debug output. It is of type BOOL. By
5428                         default, it is false.
5429  -f | --format          Output formats, supported formats such as table,
5430                         csv, json, yaml. It is of type STRING. By
5431                         default, it is table.
5432  -s | --long            whether to print all attributes or only short
5433                         attributes. It is of type BOOL. By default, it is
5434                         false.
5435  -t | --no-title        whether to print title or not. It is of type
5436                         BOOL. By default, it is false.
5437  -x | --vnfm-id         Onap VNFM unique id. It is of type UUID. By
5438                         default, it is
5439                         472dea25-b892-4b6f-912f-e61430d258da.
5440  -u | --host-username   Host user name. It is of type STRING. By default,
5441                         it is read from environment variable
5442                         OPEN_CLI_HOST_USERNAME.
5443  -p | --host-password   Host user password. It is of type STRING. By
5444                         default, it is read from environment variable
5445                         OPEN_CLI_HOST_PASSWORD. Secured.
5446  -m | --host-url        host url in http(s). It is of type URL. By
5447                         default, it is read from environment variable
5448                         OPEN_CLI_HOST_URL.
5449  -a | --no-auth         whether to authenticate user or not. It is of
5450                         type BOOL. By default, it is false.
5451
5452
5453 Results::
5454
5455  name       Onap vnfm name and is of type STRING.
5456  type       Onap vnfm type and is of type STRING.
5457  vendor     Onap vnfm vendor and is of type STRING.
5458  version    Onap vnfm version and is of type STRING.
5459  url        Onap vnfm url and is of type STRING.
5460  username   Onap vnfm username and is of type STRING.
5461
5462
5463 Error::
5464
5465  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
5466
5467
5468
5469 [84] service-list
5470 -----------------------------------------------
5471
5472
5473 usage: oclip service-list
5474
5475 List created service instance
5476
5477 Product: onap-amsterdam
5478 Service: aai
5479 Author: ONAP CLI Team onap-discuss@lists.onap.org
5480
5481 Options::
5482
5483  [-h | --help] [-v | --version] [-d | --debug]
5484  [-f | --format] [-s | --long] [-t | --no-title]
5485  [-x | --customer-name] [-y | --service-type] [-u | --host-username]
5486  [-p | --host-password] [-m | --host-url] [-a | --no-auth]
5487
5488 where::
5489
5490  -h | --help            print help message. It is of type STRING. By
5491                         default, it is false.
5492  -v | --version         print service version. It is of type STRING. By
5493                         default, it is false.
5494  -d | --debug           Enable debug output. It is of type BOOL. By
5495                         default, it is false.
5496  -f | --format          Output formats, supported formats such as table,
5497                         csv, json, yaml. It is of type STRING. By
5498                         default, it is table.
5499  -s | --long            whether to print all attributes or only short
5500                         attributes. It is of type BOOL. By default, it is
5501                         false.
5502  -t | --no-title        whether to print title or not. It is of type
5503                         BOOL. By default, it is false.
5504  -x | --customer-name   customer name. It is of type STRING.
5505  -y | --service-type    service subscription type. It is of type STRING.
5506  -u | --host-username   Host user name. It is of type STRING. By default,
5507                         it is read from environment variable
5508                         OPEN_CLI_HOST_USERNAME.
5509  -p | --host-password   Host user password. It is of type STRING. By
5510                         default, it is read from environment variable
5511                         OPEN_CLI_HOST_PASSWORD. Secured.
5512  -m | --host-url        host url in http(s). It is of type URL. By
5513                         default, it is read from environment variable
5514                         OPEN_CLI_HOST_URL.
5515  -a | --no-auth         whether to authenticate user or not. It is of
5516                         type BOOL. By default, it is false.
5517
5518
5519 Results::
5520
5521  service-id           instance id of service and is of type STRING.
5522  service-name         Service name and is of type STRING.
5523  model-invariant-id   Model invariant id of service model and is of
5524                       type STRING.
5525  model-uuid           Model uuid for service model and is of type
5526                       STRING.
5527  description          service description and is of type STRING.
5528
5529
5530 Error::
5531
5532  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
5533
5534
5535
5536 [85] vf-list
5537 -----------------------------------------------
5538
5539
5540 usage: oclip vf-list
5541
5542 List created VF instances for a service instance
5543
5544 Product: onap-amsterdam
5545 Service: aai
5546 Author: ONAP CLI Team onap-discuss@lists.onap.org
5547
5548 Options::
5549
5550  [-h | --help] [-v | --version] [-d | --debug]
5551  [-f | --format] [-s | --long] [-t | --no-title]
5552  [-x | --customer-name] [-y | --service-type] [-z | --service-id]
5553  [-u | --host-username] [-p | --host-password] [-m | --host-url]
5554  [-a | --no-auth]
5555
5556 where::
5557
5558  -h | --help            print help message. It is of type STRING. By
5559                         default, it is false.
5560  -v | --version         print service version. It is of type STRING. By
5561                         default, it is false.
5562  -d | --debug           Enable debug output. It is of type BOOL. By
5563                         default, it is false.
5564  -f | --format          Output formats, supported formats such as table,
5565                         csv, json, yaml. It is of type STRING. By
5566                         default, it is table.
5567  -s | --long            whether to print all attributes or only short
5568                         attributes. It is of type BOOL. By default, it is
5569                         false.
5570  -t | --no-title        whether to print title or not. It is of type
5571                         BOOL. By default, it is false.
5572  -x | --customer-name   customer name. It is of type STRING.
5573  -y | --service-type    service subscription type. It is of type STRING.
5574  -z | --service-id      service ID. It is of type STRING.
5575  -u | --host-username   Host user name. It is of type STRING. By default,
5576                         it is read from environment variable
5577                         OPEN_CLI_HOST_USERNAME.
5578  -p | --host-password   Host user password. It is of type STRING. By
5579                         default, it is read from environment variable
5580                         OPEN_CLI_HOST_PASSWORD. Secured.
5581  -m | --host-url        host url in http(s). It is of type URL. By
5582                         default, it is read from environment variable
5583                         OPEN_CLI_HOST_URL.
5584  -a | --no-auth         whether to authenticate user or not. It is of
5585                         type BOOL. By default, it is false.
5586
5587
5588 Results::
5589
5590  vf-id    VF ID for the given service and is of type STRING.
5591  vf-name  VF name and is of type STRING.
5592
5593
5594 Error::
5595
5596  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
5597
5598
5599
5600 [86] vf-show
5601 -----------------------------------------------
5602
5603
5604 usage: oclip vf-show
5605
5606 Show details for VF
5607
5608 Product: onap-amsterdam
5609 Service: aai
5610 Author: ONAP CLI Team onap-discuss@lists.onap.org
5611
5612 Options::
5613
5614  [-h | --help] [-v | --version] [-d | --debug]
5615  [-f | --format] [-s | --long] [-t | --no-title]
5616  [-x | --vf-id] [-u | --host-username] [-p | --host-password]
5617  [-m | --host-url] [-a | --no-auth]
5618
5619 where::
5620
5621  -h | --help            print help message. It is of type STRING. By
5622                         default, it is false.
5623  -v | --version         print service version. It is of type STRING. By
5624                         default, it is false.
5625  -d | --debug           Enable debug output. It is of type BOOL. By
5626                         default, it is false.
5627  -f | --format          Output formats, supported formats such as table,
5628                         csv, json, yaml. It is of type STRING. By
5629                         default, it is table.
5630  -s | --long            whether to print all attributes or only short
5631                         attributes. It is of type BOOL. By default, it is
5632                         false.
5633  -t | --no-title        whether to print title or not. It is of type
5634                         BOOL. By default, it is false.
5635  -x | --vf-id           VF identifier. It is of type STRING.
5636  -u | --host-username   Host user name. It is of type STRING. By default,
5637                         it is read from environment variable
5638                         OPEN_CLI_HOST_USERNAME.
5639  -p | --host-password   Host user password. It is of type STRING. By
5640                         default, it is read from environment variable
5641                         OPEN_CLI_HOST_PASSWORD. Secured.
5642  -m | --host-url        host url in http(s). It is of type URL. By
5643                         default, it is read from environment variable
5644                         OPEN_CLI_HOST_URL.
5645  -a | --no-auth         whether to authenticate user or not. It is of
5646                         type BOOL. By default, it is false.
5647
5648
5649 Results::
5650
5651  vf-id                    VF ID for the given service and is of type STRING.
5652  vf-name                  VF name and is of type STRING.
5653  vf-type                  VF name and is of type STRING.
5654  model-invariant-id       VF name and is of type STRING.
5655  model-uuid               model uuid and is of type STRING.
5656  model-customization-id   Model customization id and is of type STRING.
5657  service-id               Service ID of parent service and is of type
5658                           STRING.
5659
5660
5661 Error::
5662
5663  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
5664
5665
5666
5667 [87] service-type-create
5668 -----------------------------------------------
5669
5670
5671 usage: oclip service-type-create
5672
5673 Add a service type in Onap
5674
5675 Product: onap-amsterdam
5676 Service: aai
5677 Author: ONAP CLI Team onap-discuss@lists.onap.org
5678
5679 Options::
5680
5681  [-h | --help] [-v | --version] [-d | --debug]
5682  [-f | --format] [-s | --long] [-t | --no-title]
5683  [-x | --service-type] [-y | --service-type-id] [-u | --host-username]
5684  [-p | --host-password] [-m | --host-url] [-a | --no-auth]
5685
5686 where::
5687
5688  -h | --help              print help message. It is of type STRING. By
5689                           default, it is false.
5690  -v | --version           print service version. It is of type STRING. By
5691                           default, it is false.
5692  -d | --debug             Enable debug output. It is of type BOOL. By
5693                           default, it is false.
5694  -f | --format            Output formats, supported formats such as table,
5695                           csv, json, yaml. It is of type STRING. By
5696                           default, it is table.
5697  -s | --long              whether to print all attributes or only short
5698                           attributes. It is of type BOOL. By default, it is
5699                           false.
5700  -t | --no-title          whether to print title or not. It is of type
5701                           BOOL. By default, it is false.
5702  -x | --service-type      Onap service type. It is of type STRING.
5703  -y | --service-type-id   Onap service type uuid. It is of type UUID. It is
5704                           optional. By default, it is
5705                           a6c6f62a-19a3-4b7c-9add-e31ccd337510.
5706  -u | --host-username     Host user name. It is of type STRING. By default,
5707                           it is read from environment variable
5708                           OPEN_CLI_HOST_USERNAME.
5709  -p | --host-password     Host user password. It is of type STRING. By
5710                           default, it is read from environment variable
5711                           OPEN_CLI_HOST_PASSWORD. Secured.
5712  -m | --host-url          host url in http(s). It is of type URL. By
5713                           default, it is read from environment variable
5714                           OPEN_CLI_HOST_URL.
5715  -a | --no-auth           whether to authenticate user or not. It is of
5716                           type BOOL. By default, it is false.
5717
5718
5719 Error::
5720
5721  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
5722
5723
5724
5725 [88] service-type-delete
5726 -----------------------------------------------
5727
5728
5729 usage: oclip service-type-delete
5730
5731 Delete a service type from Onap
5732
5733 Product: onap-amsterdam
5734 Service: aai
5735 Author: ONAP CLI Team onap-discuss@lists.onap.org
5736
5737 Options::
5738
5739  [-h | --help] [-v | --version] [-d | --debug]
5740  [-f | --format] [-s | --long] [-t | --no-title]
5741  [-x | --service-type-id] [-y | --resource-version] [-u | --host-username]
5742  [-p | --host-password] [-m | --host-url] [-a | --no-auth]
5743
5744 where::
5745
5746  -h | --help              print help message. It is of type STRING. By
5747                           default, it is false.
5748  -v | --version           print service version. It is of type STRING. By
5749                           default, it is false.
5750  -d | --debug             Enable debug output. It is of type BOOL. By
5751                           default, it is false.
5752  -f | --format            Output formats, supported formats such as table,
5753                           csv, json, yaml. It is of type STRING. By
5754                           default, it is table.
5755  -s | --long              whether to print all attributes or only short
5756                           attributes. It is of type BOOL. By default, it is
5757                           false.
5758  -t | --no-title          whether to print title or not. It is of type
5759                           BOOL. By default, it is false.
5760  -x | --service-type-id   Onap service type uuid. It is of type UUID. It is
5761                           optional. By default, it is
5762                           f610d2cb-710a-4603-9aed-b66db1675d20.
5763  -y | --resource-version  Onap service resource version. It is of type
5764                           UUID. It is optional. By default, it is
5765                           0d1f018e-6e47-48c7-95af-5d15d8a6e8ea.
5766  -u | --host-username     Host user name. It is of type STRING. By default,
5767                           it is read from environment variable
5768                           OPEN_CLI_HOST_USERNAME.
5769  -p | --host-password     Host user password. It is of type STRING. By
5770                           default, it is read from environment variable
5771                           OPEN_CLI_HOST_PASSWORD. Secured.
5772  -m | --host-url          host url in http(s). It is of type URL. By
5773                           default, it is read from environment variable
5774                           OPEN_CLI_HOST_URL.
5775  -a | --no-auth           whether to authenticate user or not. It is of
5776                           type BOOL. By default, it is false.
5777
5778
5779 Error::
5780
5781  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
5782
5783
5784
5785 [89] service-type-list
5786 -----------------------------------------------
5787
5788
5789 usage: oclip service-type-list
5790
5791 List the service types configured in Onap
5792
5793 Product: onap-amsterdam
5794 Service: aai
5795 Author: ONAP CLI Team onap-discuss@lists.onap.org
5796
5797 Options::
5798
5799  [-h | --help] [-v | --version] [-d | --debug]
5800  [-f | --format] [-s | --long] [-t | --no-title]
5801  [-u | --host-username] [-p | --host-password] [-m | --host-url]
5802  [-a | --no-auth]
5803
5804 where::
5805
5806  -h | --help            print help message. It is of type STRING. By
5807                         default, it is false.
5808  -v | --version         print service version. It is of type STRING. By
5809                         default, it is false.
5810  -d | --debug           Enable debug output. It is of type BOOL. By
5811                         default, it is false.
5812  -f | --format          Output formats, supported formats such as table,
5813                         csv, json, yaml. It is of type STRING. By
5814                         default, it is table.
5815  -s | --long            whether to print all attributes or only short
5816                         attributes. It is of type BOOL. By default, it is
5817                         false.
5818  -t | --no-title        whether to print title or not. It is of type
5819                         BOOL. By default, it is false.
5820  -u | --host-username   Host user name. It is of type STRING. By default,
5821                         it is read from environment variable
5822                         OPEN_CLI_HOST_USERNAME.
5823  -p | --host-password   Host user password. It is of type STRING. By
5824                         default, it is read from environment variable
5825                         OPEN_CLI_HOST_PASSWORD. Secured.
5826  -m | --host-url        host url in http(s). It is of type URL. By
5827                         default, it is read from environment variable
5828                         OPEN_CLI_HOST_URL.
5829  -a | --no-auth         whether to authenticate user or not. It is of
5830                         type BOOL. By default, it is false.
5831
5832
5833 Results::
5834
5835  service-type-id    Onap cloud service and is of type STRING.
5836  service-type       Onap cloud service and is of type STRING.
5837  resource-version   Onap cloud service resource version and is of
5838                     type STRING.
5839
5840
5841 Error::
5842
5843  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
5844
5845
5846
5847 [90] subscription-create
5848 -----------------------------------------------
5849
5850
5851 usage: oclip subscription-create
5852
5853 Create a subscription of a customer for given service in specific cloud region in Onap
5854
5855 Product: onap-amsterdam
5856 Service: aai
5857 Author: ONAP CLI Team onap-discuss@lists.onap.org
5858
5859 Options::
5860
5861  [-h | --help] [-v | --version] [-d | --debug]
5862  [-f | --format] [-s | --long] [-t | --no-title]
5863  [-x | --customer-name] [-z | --cloud-name] [-r | --cloud-region]
5864  [-c | --cloud-tenant-id] [-e | --service-type] [-u | --host-username]
5865  [-p | --host-password] [-m | --host-url] [-a | --no-auth]
5866
5867 where::
5868
5869  -h | --help              print help message. It is of type STRING. By
5870                           default, it is false.
5871  -v | --version           print service version. It is of type STRING. By
5872                           default, it is false.
5873  -d | --debug             Enable debug output. It is of type BOOL. By
5874                           default, it is false.
5875  -f | --format            Output formats, supported formats such as table,
5876                           csv, json, yaml. It is of type STRING. By
5877                           default, it is table.
5878  -s | --long              whether to print all attributes or only short
5879                           attributes. It is of type BOOL. By default, it is
5880                           false.
5881  -t | --no-title          whether to print title or not. It is of type
5882                           BOOL. By default, it is false.
5883  -x | --customer-name     Onap customer name. It is of type STRING.
5884  -z | --cloud-name        Onap cloud name. It is of type STRING.
5885  -r | --cloud-region      Onap cloud region. It is of type STRING.
5886  -c | --cloud-tenant-id   Onap cloud tenant id. It is of type STRING.
5887  -e | --service-type      Onap service type. It is of type STRING.
5888  -u | --host-username     Host user name. It is of type STRING. By default,
5889                           it is read from environment variable
5890                           OPEN_CLI_HOST_USERNAME.
5891  -p | --host-password     Host user password. It is of type STRING. By
5892                           default, it is read from environment variable
5893                           OPEN_CLI_HOST_PASSWORD. Secured.
5894  -m | --host-url          host url in http(s). It is of type URL. By
5895                           default, it is read from environment variable
5896                           OPEN_CLI_HOST_URL.
5897  -a | --no-auth           whether to authenticate user or not. It is of
5898                           type BOOL. By default, it is false.
5899
5900
5901 Error::
5902
5903  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
5904
5905
5906
5907 [91] subscription-delete
5908 -----------------------------------------------
5909
5910
5911 usage: oclip subscription-delete
5912
5913 Delete the subscription for a given customer in Onap
5914
5915 Product: onap-amsterdam
5916 Service: aai
5917 Author: ONAP CLI Team onap-discuss@lists.onap.org
5918
5919 Options::
5920
5921  [-h | --help] [-v | --version] [-d | --debug]
5922  [-f | --format] [-s | --long] [-t | --no-title]
5923  [-x | --customer-name] [-y | --service-type] [-g | --resource-version]
5924  [-u | --host-username] [-p | --host-password] [-m | --host-url]
5925  [-a | --no-auth]
5926
5927 where::
5928
5929  -h | --help              print help message. It is of type STRING. By
5930                           default, it is false.
5931  -v | --version           print service version. It is of type STRING. By
5932                           default, it is false.
5933  -d | --debug             Enable debug output. It is of type BOOL. By
5934                           default, it is false.
5935  -f | --format            Output formats, supported formats such as table,
5936                           csv, json, yaml. It is of type STRING. By
5937                           default, it is table.
5938  -s | --long              whether to print all attributes or only short
5939                           attributes. It is of type BOOL. By default, it is
5940                           false.
5941  -t | --no-title          whether to print title or not. It is of type
5942                           BOOL. By default, it is false.
5943  -x | --customer-name     Onap customer name. It is of type STRING.
5944  -y | --service-type      Onap subscribtion id. It is of type STRING.
5945  -g | --resource-version  Onap subscription resource version. It is of type
5946                           STRING. It is optional.
5947  -u | --host-username     Host user name. It is of type STRING. By default,
5948                           it is read from environment variable
5949                           OPEN_CLI_HOST_USERNAME.
5950  -p | --host-password     Host user password. It is of type STRING. By
5951                           default, it is read from environment variable
5952                           OPEN_CLI_HOST_PASSWORD. Secured.
5953  -m | --host-url          host url in http(s). It is of type URL. By
5954                           default, it is read from environment variable
5955                           OPEN_CLI_HOST_URL.
5956  -a | --no-auth           whether to authenticate user or not. It is of
5957                           type BOOL. By default, it is false.
5958
5959
5960 Error::
5961
5962  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
5963
5964
5965
5966 [92] subscription-list
5967 -----------------------------------------------
5968
5969
5970 usage: oclip subscription-list
5971
5972 Lists the subscription for a given customer in Onap
5973
5974 Product: onap-amsterdam
5975 Service: aai
5976 Author: ONAP CLI Team onap-discuss@lists.onap.org
5977
5978 Options::
5979
5980  [-h | --help] [-v | --version] [-d | --debug]
5981  [-f | --format] [-s | --long] [-t | --no-title]
5982  [-x | --customer-name] [-u | --host-username] [-p | --host-password]
5983  [-m | --host-url] [-a | --no-auth]
5984
5985 where::
5986
5987  -h | --help            print help message. It is of type STRING. By
5988                         default, it is false.
5989  -v | --version         print service version. It is of type STRING. By
5990                         default, it is false.
5991  -d | --debug           Enable debug output. It is of type BOOL. By
5992                         default, it is false.
5993  -f | --format          Output formats, supported formats such as table,
5994                         csv, json, yaml. It is of type STRING. By
5995                         default, it is table.
5996  -s | --long            whether to print all attributes or only short
5997                         attributes. It is of type BOOL. By default, it is
5998                         false.
5999  -t | --no-title        whether to print title or not. It is of type
6000                         BOOL. By default, it is false.
6001  -x | --customer-name   Onap customer name. It is of type STRING.
6002  -u | --host-username   Host user name. It is of type STRING. By default,
6003                         it is read from environment variable
6004                         OPEN_CLI_HOST_USERNAME.
6005  -p | --host-password   Host user password. It is of type STRING. By
6006                         default, it is read from environment variable
6007                         OPEN_CLI_HOST_PASSWORD. Secured.
6008  -m | --host-url        host url in http(s). It is of type URL. By
6009                         default, it is read from environment variable
6010                         OPEN_CLI_HOST_URL.
6011  -a | --no-auth         whether to authenticate user or not. It is of
6012                         type BOOL. By default, it is false.
6013
6014
6015 Results::
6016
6017  service-type       Onap service type and is of type STRING.
6018  resource-version   Onap subscription resource version and is of type
6019                     STRING.
6020  tenant             Onap tenant name and is of type STRING.
6021  region             Onap region name and is of type STRING.
6022  cloud              Onap cloud name and is of type STRING.
6023
6024
6025 Error::
6026
6027  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
6028
6029
6030
6031 [93] tenant-create
6032 -----------------------------------------------
6033
6034
6035 usage: oclip tenant-create
6036
6037 Create a tenant under given cloud region in Onap
6038
6039 Product: onap-amsterdam
6040 Service: aai
6041 Author: ONAP CLI Team onap-discuss@lists.onap.org
6042
6043 Options::
6044
6045  [-h | --help] [-v | --version] [-d | --debug]
6046  [-f | --format] [-s | --long] [-t | --no-title]
6047  [-x | --cloud] [-y | --region] [-z | --tenant-id]
6048  [-r | --tenant-name] [-u | --host-username] [-p | --host-password]
6049  [-m | --host-url] [-a | --no-auth]
6050
6051 where::
6052
6053  -h | --help            print help message. It is of type STRING. By
6054                         default, it is false.
6055  -v | --version         print service version. It is of type STRING. By
6056                         default, it is false.
6057  -d | --debug           Enable debug output. It is of type BOOL. By
6058                         default, it is false.
6059  -f | --format          Output formats, supported formats such as table,
6060                         csv, json, yaml. It is of type STRING. By
6061                         default, it is table.
6062  -s | --long            whether to print all attributes or only short
6063                         attributes. It is of type BOOL. By default, it is
6064                         false.
6065  -t | --no-title        whether to print title or not. It is of type
6066                         BOOL. By default, it is false.
6067  -x | --cloud           Onap cloud. It is of type STRING.
6068  -y | --region          Onap cloud region. It is of type STRING.
6069  -z | --tenant-id       Onap cloud tenant id. It is of type STRING.
6070  -r | --tenant-name     Onap cloud tenant name. It is of type STRING.
6071  -u | --host-username   Host user name. It is of type STRING. By default,
6072                         it is read from environment variable
6073                         OPEN_CLI_HOST_USERNAME.
6074  -p | --host-password   Host user password. It is of type STRING. By
6075                         default, it is read from environment variable
6076                         OPEN_CLI_HOST_PASSWORD. Secured.
6077  -m | --host-url        host url in http(s). It is of type URL. By
6078                         default, it is read from environment variable
6079                         OPEN_CLI_HOST_URL.
6080  -a | --no-auth         whether to authenticate user or not. It is of
6081                         type BOOL. By default, it is false.
6082
6083
6084 Error::
6085
6086  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
6087
6088
6089
6090 [94] tenant-delete
6091 -----------------------------------------------
6092
6093
6094 usage: oclip tenant-delete
6095
6096 Delete tenant under given cloud region in Onap
6097
6098 Product: onap-amsterdam
6099 Service: aai
6100 Author: ONAP CLI Team onap-discuss@lists.onap.org
6101
6102 Options::
6103
6104  [-h | --help] [-v | --version] [-d | --debug]
6105  [-f | --format] [-s | --long] [-t | --no-title]
6106  [-x | --cloud] [-y | --region] [-z | --tenant-id]
6107  [-r | --resource-version] [-u | --host-username] [-p | --host-password]
6108  [-m | --host-url] [-a | --no-auth]
6109
6110 where::
6111
6112  -h | --help              print help message. It is of type STRING. By
6113                           default, it is false.
6114  -v | --version           print service version. It is of type STRING. By
6115                           default, it is false.
6116  -d | --debug             Enable debug output. It is of type BOOL. By
6117                           default, it is false.
6118  -f | --format            Output formats, supported formats such as table,
6119                           csv, json, yaml. It is of type STRING. By
6120                           default, it is table.
6121  -s | --long              whether to print all attributes or only short
6122                           attributes. It is of type BOOL. By default, it is
6123                           false.
6124  -t | --no-title          whether to print title or not. It is of type
6125                           BOOL. By default, it is false.
6126  -x | --cloud             Onap cloud. It is of type STRING.
6127  -y | --region            Onap cloud region. It is of type STRING.
6128  -z | --tenant-id         Onap cloud tenant id. It is of type STRING.
6129  -r | --resource-version  Onap cloud tenant version. It is of type UUID. It
6130                           is optional. By default, it is
6131                           b9ea4541-bff0-419b-80cb-0cabad805aad.
6132  -u | --host-username     Host user name. It is of type STRING. By default,
6133                           it is read from environment variable
6134                           OPEN_CLI_HOST_USERNAME.
6135  -p | --host-password     Host user password. It is of type STRING. By
6136                           default, it is read from environment variable
6137                           OPEN_CLI_HOST_PASSWORD. Secured.
6138  -m | --host-url          host url in http(s). It is of type URL. By
6139                           default, it is read from environment variable
6140                           OPEN_CLI_HOST_URL.
6141  -a | --no-auth           whether to authenticate user or not. It is of
6142                           type BOOL. By default, it is false.
6143
6144
6145 Error::
6146
6147  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
6148
6149
6150
6151 [95] tenant-list
6152 -----------------------------------------------
6153
6154
6155 usage: oclip tenant-list
6156
6157 Lists the tenants under given cloud region in Onap
6158
6159 Product: onap-amsterdam
6160 Service: aai
6161 Author: ONAP CLI Team onap-discuss@lists.onap.org
6162
6163 Options::
6164
6165  [-h | --help] [-v | --version] [-d | --debug]
6166  [-f | --format] [-s | --long] [-t | --no-title]
6167  [-x | --cloud] [-y | --region] [-u | --host-username]
6168  [-p | --host-password] [-m | --host-url] [-a | --no-auth]
6169
6170 where::
6171
6172  -h | --help            print help message. It is of type STRING. By
6173                         default, it is false.
6174  -v | --version         print service version. It is of type STRING. By
6175                         default, it is false.
6176  -d | --debug           Enable debug output. It is of type BOOL. By
6177                         default, it is false.
6178  -f | --format          Output formats, supported formats such as table,
6179                         csv, json, yaml. It is of type STRING. By
6180                         default, it is table.
6181  -s | --long            whether to print all attributes or only short
6182                         attributes. It is of type BOOL. By default, it is
6183                         false.
6184  -t | --no-title        whether to print title or not. It is of type
6185                         BOOL. By default, it is false.
6186  -x | --cloud           Onap cloud. It is of type STRING.
6187  -y | --region          Onap cloud region. It is of type STRING.
6188  -u | --host-username   Host user name. It is of type STRING. By default,
6189                         it is read from environment variable
6190                         OPEN_CLI_HOST_USERNAME.
6191  -p | --host-password   Host user password. It is of type STRING. By
6192                         default, it is read from environment variable
6193                         OPEN_CLI_HOST_PASSWORD. Secured.
6194  -m | --host-url        host url in http(s). It is of type URL. By
6195                         default, it is read from environment variable
6196                         OPEN_CLI_HOST_URL.
6197  -a | --no-auth         whether to authenticate user or not. It is of
6198                         type BOOL. By default, it is false.
6199
6200
6201 Results::
6202
6203  tenant-id          Onap tenant-id and is of type STRING.
6204  tenant-name        Onap tenant name and is of type STRING.
6205  resource-version   Onap tenant resource version and is of type
6206                     STRING.
6207
6208
6209 Error::
6210
6211  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
6212
6213
6214
6215 [96] cloud-list
6216 -----------------------------------------------
6217
6218
6219 usage: oclip cloud-list
6220
6221 List the configured clouds and Onap service subscriptions
6222
6223 Product: onap-amsterdam
6224 Service: aai
6225 Author: ONAP CLI Team onap-discuss@lists.onap.org
6226
6227 Options::
6228
6229  [-h | --help] [-v | --version] [-d | --debug]
6230  [-f | --format] [-s | --long] [-t | --no-title]
6231  [-u | --host-username] [-p | --host-password] [-m | --host-url]
6232  [-a | --no-auth]
6233
6234 where::
6235
6236  -h | --help            print help message. It is of type STRING. By
6237                         default, it is false.
6238  -v | --version         print service version. It is of type STRING. By
6239                         default, it is false.
6240  -d | --debug           Enable debug output. It is of type BOOL. By
6241                         default, it is false.
6242  -f | --format          Output formats, supported formats such as table,
6243                         csv, json, yaml. It is of type STRING. By
6244                         default, it is table.
6245  -s | --long            whether to print all attributes or only short
6246                         attributes. It is of type BOOL. By default, it is
6247                         false.
6248  -t | --no-title        whether to print title or not. It is of type
6249                         BOOL. By default, it is false.
6250  -u | --host-username   Host user name. It is of type STRING. By default,
6251                         it is read from environment variable
6252                         OPEN_CLI_HOST_USERNAME.
6253  -p | --host-password   Host user password. It is of type STRING. By
6254                         default, it is read from environment variable
6255                         OPEN_CLI_HOST_PASSWORD. Secured.
6256  -m | --host-url        host url in http(s). It is of type URL. By
6257                         default, it is read from environment variable
6258                         OPEN_CLI_HOST_URL.
6259  -a | --no-auth         whether to authenticate user or not. It is of
6260                         type BOOL. By default, it is false.
6261
6262
6263 Results::
6264
6265  cloud              Onap cloud and is of type STRING.
6266  region             Onap cloud region and is of type STRING.
6267  tenant             Onap cloud tenat and is of type STRING.
6268  tenant-id          Onap cloud tenat id and is of type STRING.
6269  customer           Onap cloud customer and is of type STRING.
6270  service            Onap cloud service and is of type STRING.
6271  resource-version   Onap cloud resource version and is of type STRING.
6272
6273
6274 Error::
6275
6276  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
6277
6278
6279
6280 [97] customer-create
6281 -----------------------------------------------
6282
6283
6284 usage: oclip customer-create
6285
6286 Create a customer in Onap
6287
6288 Product: onap-amsterdam
6289 Service: aai
6290 Author: ONAP CLI Team onap-discuss@lists.onap.org
6291
6292 Options::
6293
6294  [-h | --help] [-v | --version] [-d | --debug]
6295  [-f | --format] [-s | --long] [-t | --no-title]
6296  [-x | --customer-name] [-y | --subscriber-name] [-u | --host-username]
6297  [-p | --host-password] [-m | --host-url] [-a | --no-auth]
6298
6299 where::
6300
6301  -h | --help              print help message. It is of type STRING. By
6302                           default, it is false.
6303  -v | --version           print service version. It is of type STRING. By
6304                           default, it is false.
6305  -d | --debug             Enable debug output. It is of type BOOL. By
6306                           default, it is false.
6307  -f | --format            Output formats, supported formats such as table,
6308                           csv, json, yaml. It is of type STRING. By
6309                           default, it is table.
6310  -s | --long              whether to print all attributes or only short
6311                           attributes. It is of type BOOL. By default, it is
6312                           false.
6313  -t | --no-title          whether to print title or not. It is of type
6314                           BOOL. By default, it is false.
6315  -x | --customer-name     Onap customer name. It is of type STRING.
6316  -y | --subscriber-name   Onap subscriber name. It is of type STRING.
6317  -u | --host-username     Host user name. It is of type STRING. By default,
6318                           it is read from environment variable
6319                           OPEN_CLI_HOST_USERNAME.
6320  -p | --host-password     Host user password. It is of type STRING. By
6321                           default, it is read from environment variable
6322                           OPEN_CLI_HOST_PASSWORD. Secured.
6323  -m | --host-url          host url in http(s). It is of type URL. By
6324                           default, it is read from environment variable
6325                           OPEN_CLI_HOST_URL.
6326  -a | --no-auth           whether to authenticate user or not. It is of
6327                           type BOOL. By default, it is false.
6328
6329
6330 Error::
6331
6332  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
6333
6334
6335
6336 sample-helloworld
6337 ==========================
6338
6339
6340 [1] hello-world-http
6341 -----------------------------------------------
6342
6343
6344 usage: oclip hello-world-http
6345
6346 First cmd hello world using http runing under
6347 lighttpd in cli at http://<cli-ip>:8080/version.json
6348
6349
6350 Product: sample-helloworld
6351 Service: hello-world
6352 Author: ONAP CLI Team onap-discuss@lists.onap.org
6353
6354 Options::
6355
6356  [-h | --help] [-v | --version] [-d | --debug]
6357  [-f | --format] [-s | --long] [-t | --no-title]
6358  [-b | --name] [-m | --host-url]
6359
6360 where::
6361
6362  -h | --help      print help message. It is of type STRING. By
6363                   default, it is false.
6364  -v | --version   print service version. It is of type STRING. By
6365                   default, it is false.
6366  -d | --debug     Enable debug output. It is of type BOOL. By
6367                   default, it is false.
6368  -f | --format    Output formats, supported formats such as table,
6369                   csv, json, yaml. It is of type STRING. By
6370                   default, it is table.
6371  -s | --long      whether to print all attributes or only short
6372                   attributes. It is of type BOOL. By default, it is
6373                   false.
6374  -t | --no-title  whether to print title or not. It is of type
6375                   BOOL. By default, it is false.
6376  -b | --name      name of the person. It is of type STRING. By
6377                   default, it is ${DEMO_NAME}.
6378  -m | --host-url  host url in http(s). It is of type URL. By
6379                   default, it is read from environment variable
6380                   OPEN_CLI_HOST_URL.
6381
6382
6383 Results::
6384
6385  output   hello world output and is of type STRING.
6386
6387
6388 Error::
6389
6390  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
6391
6392
6393
6394 [2] hello-world
6395 -----------------------------------------------
6396
6397
6398 usage: oclip hello-world
6399
6400 First cmd hello world
6401
6402 Product: sample-helloworld
6403 Service: hello-world
6404 Author: ONAP CLI Team onap-discuss@lists.onap.org
6405
6406 Options::
6407
6408  [-h | --help] [-v | --version] [-d | --debug]
6409  [-f | --format] [-s | --long] [-t | --no-title]
6410  [-b | --name]
6411
6412 where::
6413
6414  -h | --help      print help message. It is of type STRING. By
6415                   default, it is false.
6416  -v | --version   print service version. It is of type STRING. By
6417                   default, it is false.
6418  -d | --debug     Enable debug output. It is of type BOOL. By
6419                   default, it is false.
6420  -f | --format    Output formats, supported formats such as table,
6421                   csv, json, yaml. It is of type STRING. By
6422                   default, it is table.
6423  -s | --long      whether to print all attributes or only short
6424                   attributes. It is of type BOOL. By default, it is
6425                   false.
6426  -t | --no-title  whether to print title or not. It is of type
6427                   BOOL. By default, it is false.
6428  -b | --name      name of the person. It is of type STRING. By
6429                   default, it is ${env:DEMO_NAME}.
6430
6431
6432 Results::
6433
6434  output   hello world output and is of type STRING.
6435
6436
6437 Error::
6438
6439  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>