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