Migrate docs to use OPEN_ instead of ONAP_
[cli.git] / docs / cmd_help.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. Copyright 2017 Huawei Technologies Co., Ltd.
4
5
6 .. toctree::
7    :maxdepth: 2
8
9
10 .. _cli_cmd_help:
11
12 onap-1.1
13 ==========================
14
15
16 <<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
17 [1] microservice-delete
18 =======
19 [1] microservice-show
20 -----------------------------------------------
21
22
23 usage: onap microservice-show
24
25 Details the registered microservice in Onap
26
27 Onap service: msb v1
28
29 Options::
30
31  [-x | --service-name] [-y | --service-version] [-m | --host-url]
32  [-h | --help] [-v | --version] [-d | --debug]
33  [-f | --format] [-s | --long] [-t | --no-title]
34
35 where::
36
37  -x | --service-name      Onap service name. It is of type STRING.
38  -y | --service-version   Onap service version. It is of type STRING.
39  -m | --host-url          Onap host url. It is of type URL. By default, it
40                           is read from environment variable ONAP_HOST_URL.
41  -h | --help              Onap command help message. It is of type STRING.
42                           By default, it is false.
43  -v | --version           Onap command service version. It is of type
44                           STRING. By default, it is false.
45  -d | --debug             Enable debug output. It is of type BOOL. By
46                           default, it is false.
47  -f | --format            Output formats, supported formats such as table,
48                           csv, json, yaml. It is of type STRING. By
49                           default, it is table.
50  -s | --long              whether to print all attributes or only short
51                           attributes. It is of type BOOL. By default, it is
52                           false.
53  -t | --no-title          whether to print title or not. It is of type
54                           BOOL. By default, it is false.
55
56
57 Results::
58
59  name         Onap service name and is of type STRING.
60  version      Onap service version and is of type STRING.
61  url          Onap service base url and is of type URL.
62  status       Onap service status and is of type DIGIT.
63  nodes        Onap service running nodes and is of type JSON.
64  enable-ssl   Onap service is enabled with https or not and is
65               of type STRING.
66  path         Onap service path and is of type STRING.
67
68
69 Error::
70
71  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
72
73
74
75 [2] microservice-create
76 -----------------------------------------------
77
78
79 usage: onap microservice-create
80
81 Register microservice into Onap
82
83 Onap service: msb v1
84
85 Options::
86
87  [-x | --service-name] [-y | --service-version] [-r | --service-url]
88  [-b | --enable-ssl] [-c | --path] <node-ip>
89  <node-port> <create-or-update> [-m | --host-url]
90  [-h | --help] [-v | --version] [-d | --debug]
91  [-f | --format] [-s | --long] [-t | --no-title]
92
93 where::
94
95  -x | --service-name      Onap service name. It is of type STRING.
96  -y | --service-version   Onap service version. It is of type STRING.
97  -r | --service-url       Onap service base url. It is of type URL.
98  -b | --enable-ssl        Onap service is enabled with https or not. It is
99                           of type STRING. It is optional.
100  -c | --path              Onap service path. It is of type STRING. It is
101                           optional.
102  node-ip                  Onap service running node IP. It is of type
103                           STRING.
104  node-port                Onap service running node port. It is of type
105                           STRING.
106  create-or-update         Onap service create or update. It is of type
107                           BOOL. By default, it is false.
108  -m | --host-url          Onap host url. It is of type URL. By default, it
109                           is read from environment variable OPEN_HOST_URL.
110  -h | --help              Onap command help message. It is of type STRING.
111                           By default, it is false.
112  -v | --version           Onap command service version. It is of type
113                           STRING. By default, it is false.
114  -d | --debug             Enable debug output. It is of type BOOL. By
115                           default, it is false.
116  -f | --format            Output formats, supported formats such as table,
117                           csv, json, yaml. It is of type STRING. By
118                           default, it is table.
119  -s | --long              whether to print all attributes or only short
120                           attributes. It is of type BOOL. By default, it is
121                           false.
122  -t | --no-title          whether to print title or not. It is of type
123                           BOOL. By default, it is false.
124
125
126 Results::
127
128  name         Onap service name and is of type STRING.
129  version      Onap service version and is of type STRING.
130  url          Onap service base url and is of type URL.
131  status       Onap service status and is of type DIGIT.
132  nodes        Onap service running nodes and is of type STRING.
133  enable-ssl   Onap service is enabled with https or not and is
134               of type STRING.
135  path         Onap service path and is of type STRING.
136
137
138 Error::
139
140  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
141
142
143
144 [3] microservice-delete
145 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
146 -----------------------------------------------
147
148
149 usage: onap microservice-delete
150
151 Deletes the micro service from Onap
152
153 Onap service: msb v1
154
155 Options::
156
157  [-x | --service-name] [-y | --service-version] [-i | --node-ip]
158  [-r | --node-port] [-m | --host-url] [-h | --help]
159  [-v | --version] [-d | --debug] [-f | --format]
160  [-s | --long] [-t | --no-title]
161
162 where::
163
164  -x | --service-name      Onap service name. It is of type STRING.
165  -y | --service-version   Onap service version. It is of type STRING.
166  -i | --node-ip           Onap service running node IP. It is of type
167                           STRING.
168  -r | --node-port         Onap service running node port. It is of type
169                           STRING.
170  -m | --host-url          Onap host url. It is of type URL. By default, it
171                           is read from environment variable OPEN_HOST_URL.
172  -h | --help              Onap command help message. It is of type STRING.
173                           By default, it is false.
174  -v | --version           Onap command service version. It is of type
175                           STRING. By default, it is false.
176  -d | --debug             Enable debug output. It is of type BOOL. By
177                           default, it is false.
178  -f | --format            Output formats, supported formats such as table,
179                           csv, json, yaml. It is of type STRING. By
180                           default, it is table.
181  -s | --long              whether to print all attributes or only short
182                           attributes. It is of type BOOL. By default, it is
183                           false.
184  -t | --no-title          whether to print title or not. It is of type
185                           BOOL. By default, it is false.
186
187
188 Error::
189
190  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
191
192
193
194 [2] microservice-list
195 -----------------------------------------------
196
197
198 usage: onap microservice-list
199
200 Lists the registetred micro services in Onap
201
202 Onap service: msb v1
203
204 Options::
205
206  [-m | --host-url] [-h | --help] [-v | --version]
207  [-d | --debug] [-f | --format] [-s | --long]
208  [-t | --no-title]
209
210 where::
211
212  -m | --host-url  Onap host url. It is of type URL. By default, it
213                   is read from environment variable OPEN_HOST_URL.
214  -h | --help      Onap command help message. It is of type STRING.
215                   By default, it is false.
216  -v | --version   Onap command service version. It is of type
217                   STRING. By default, it is false.
218  -d | --debug     Enable debug output. It is of type BOOL. By
219                   default, it is false.
220  -f | --format    Output formats, supported formats such as table,
221                   csv, json, yaml. It is of type STRING. By
222                   default, it is table.
223  -s | --long      whether to print all attributes or only short
224                   attributes. It is of type BOOL. By default, it is
225                   false.
226  -t | --no-title  whether to print title or not. It is of type
227                   BOOL. By default, it is false.
228
229
230 Results::
231
232  name         Onap service name and is of type STRING.
233  version      Onap service version and is of type STRING.
234  url          Onap service base url and is of type URL.
235  status       Onap service status and is of type DIGIT.
236  nodes        Onap service running nodes and is of type JSON.
237  enable-ssl   Onap service is enabled with https or not and is
238               of type STRING.
239  path         Onap service path and is of type STRING.
240
241
242 Error::
243
244  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
245
246
247
248 [3] microservice-show
249 -----------------------------------------------
250
251
252 usage: onap microservice-show
253
254 Details the registered microservice in Onap
255
256 Onap service: msb v1
257
258 Options::
259
260  [-x | --service-name] [-y | --service-version] [-m | --host-url]
261  [-h | --help] [-v | --version] [-d | --debug]
262  [-f | --format] [-s | --long] [-t | --no-title]
263
264 where::
265
266  -x | --service-name      Onap service name. It is of type STRING.
267  -y | --service-version   Onap service version. It is of type STRING.
268  -m | --host-url          Onap host url. It is of type URL. By default, it
269                           is read from environment variable OPEN_HOST_URL.
270  -h | --help              Onap command help message. It is of type STRING.
271                           By default, it is false.
272  -v | --version           Onap command service version. It is of type
273                           STRING. By default, it is false.
274  -d | --debug             Enable debug output. It is of type BOOL. By
275                           default, it is false.
276  -f | --format            Output formats, supported formats such as table,
277                           csv, json, yaml. It is of type STRING. By
278                           default, it is table.
279  -s | --long              whether to print all attributes or only short
280                           attributes. It is of type BOOL. By default, it is
281                           false.
282  -t | --no-title          whether to print title or not. It is of type
283                           BOOL. By default, it is false.
284
285
286 Results::
287
288  name         Onap service name and is of type STRING.
289  version      Onap service version and is of type STRING.
290  url          Onap service base url and is of type URL.
291  status       Onap service status and is of type DIGIT.
292  nodes        Onap service running nodes and is of type JSON.
293  enable-ssl   Onap service is enabled with https or not and is
294               of type STRING.
295  path         Onap service path and is of type STRING.
296
297
298 Error::
299
300  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
301
302
303
304 [4] microservice-create
305 -----------------------------------------------
306
307
308 usage: onap microservice-create
309
310 Register microservice into Onap
311
312 Onap service: msb v1
313
314 Options::
315
316  [-x | --service-name] [-y | --service-version] [-r | --service-url]
317  [-b | --enable-ssl] [-c | --path] <node-ip>
318  <node-port> <create-or-update> [-m | --host-url]
319  [-h | --help] [-v | --version] [-d | --debug]
320  [-f | --format] [-s | --long] [-t | --no-title]
321
322 where::
323
324 <<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
325  -x | --service-name      Onap service name. It is of type STRING.
326  -y | --service-version   Onap service version. It is of type STRING.
327  -r | --service-url       Onap service base url. It is of type URL.
328  -b | --enable-ssl        Onap service is enabled with https or not. It is
329                           of type STRING. It is optional.
330  -c | --path              Onap service path. It is of type STRING. It is
331 =======
332 <<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
333  -b | --service-model-id  Service model ID. It is of type STRING. It is
334 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
335                           optional.
336  node-ip                  Onap service running node IP. It is of type
337                           STRING.
338  node-port                Onap service running node port. It is of type
339                           STRING.
340  create-or-update         Onap service create or update. It is of type
341                           BOOL. By default, it is false.
342  -m | --host-url          Onap host url. It is of type URL. By default, it
343                           is read from environment variable ONAP_HOST_URL.
344  -h | --help              Onap command help message. It is of type STRING.
345                           By default, it is false.
346  -v | --version           Onap command service version. It is of type
347                           STRING. By default, it is false.
348  -d | --debug             Enable debug output. It is of type BOOL. By
349                           default, it is false.
350  -f | --format            Output formats, supported formats such as table,
351                           csv, json, yaml. It is of type STRING. By
352                           default, it is table.
353  -s | --long              whether to print all attributes or only short
354                           attributes. It is of type BOOL. By default, it is
355                           false.
356  -t | --no-title          whether to print title or not. It is of type
357                           BOOL. By default, it is false.
358 <<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
359
360
361 Results::
362
363  name         Onap service name and is of type STRING.
364  version      Onap service version and is of type STRING.
365  url          Onap service base url and is of type URL.
366  status       Onap service status and is of type DIGIT.
367  nodes        Onap service running nodes and is of type STRING.
368  enable-ssl   Onap service is enabled with https or not and is
369               of type STRING.
370  path         Onap service path and is of type STRING.
371 =======
372  -a | --no-auth           whether to authenticate user or not. It is of
373                           type BOOL. By default, it is false.
374 =======
375  -x | --vsp-id          Onap VSP ID. It is of type STRING.
376  -u | --onap-username   Onap user name. It is of type STRING. By default,
377                         it is read from environment variable
378                         OPEN_USERNAME.
379  -p | --onap-password   Onap user password. It is of type STRING. By
380                         default, it is read from environment variable
381                         OPEN_PASSWORD. Secured.
382  -m | --host-url        Onap host url. It is of type URL. By default, it
383                         is read from environment variable OPEN_HOST_URL.
384  -h | --help            Onap command help message. It is of type STRING.
385                         By default, it is false.
386  -v | --version         Onap command service version. It is of type
387                         STRING. By default, it is false.
388  -d | --debug           Enable debug output. It is of type BOOL. By
389                         default, it is false.
390  -f | --format          Output formats, supported formats such as table,
391                         csv, json, yaml. It is of type STRING. By
392                         default, it is table.
393  -s | --long            whether to print all attributes or only short
394                         attributes. It is of type BOOL. By default, it is
395                         false.
396  -t | --no-title        whether to print title or not. It is of type
397                         BOOL. By default, it is false.
398  -a | --no-auth         whether to authenticate user or not. It is of
399                         type BOOL. By default, it is false.
400 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
401 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
402
403
404 Error::
405
406  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
407
408
409
410 [5] vlm-checkin
411 -----------------------------------------------
412
413
414 usage: onap vlm-checkin
415
416 Checkin Vendor License Model
417
418 Onap service: sdc v1.0
419
420 Options::
421
422  [-x | --vlm-id] [-y | --vlm-version] [-u | --onap-username]
423  [-p | --onap-password] [-m | --host-url] [-h | --help]
424  [-v | --version] [-d | --debug] [-f | --format]
425  [-s | --long] [-t | --no-title] [-a | --no-auth]
426
427 where::
428
429  -x | --vlm-id          Onap VLM ID. It is of type STRING.
430  -y | --vlm-version     VLM version. It is of type STRING.
431  -u | --onap-username   Onap user name. It is of type STRING. By default,
432                         it is read from environment variable
433                         OPEN_USERNAME.
434  -p | --onap-password   Onap user password. It is of type STRING. By
435                         default, it is read from environment variable
436                         OPEN_PASSWORD. Secured.
437  -m | --host-url        Onap host url. It is of type URL. By default, it
438                         is read from environment variable OPEN_HOST_URL.
439  -h | --help            Onap command help message. It is of type STRING.
440                         By default, it is false.
441  -v | --version         Onap command service version. It is of type
442                         STRING. By default, it is false.
443  -d | --debug           Enable debug output. It is of type BOOL. By
444                         default, it is false.
445  -f | --format          Output formats, supported formats such as table,
446                         csv, json, yaml. It is of type STRING. By
447                         default, it is table.
448  -s | --long            whether to print all attributes or only short
449                         attributes. It is of type BOOL. By default, it is
450                         false.
451  -t | --no-title        whether to print title or not. It is of type
452                         BOOL. By default, it is false.
453  -a | --no-auth         whether to authenticate user or not. It is of
454                         type BOOL. By default, it is false.
455
456
457 Error::
458
459  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
460
461
462
463 [6] vlm-key-group-create
464 -----------------------------------------------
465
466
467 usage: onap vlm-key-group-create
468
469 Create License Key Group
470
471 Onap service: sdc v1.0
472
473 Options::
474
475  [-c | --vlm-id] [-e | --vlm-version] [-x | --name]
476  [-y | --type] [-z | --description] [-u | --onap-username]
477  [-p | --onap-password] [-m | --host-url] [-h | --help]
478  [-v | --version] [-d | --debug] [-f | --format]
479  [-s | --long] [-t | --no-title] [-a | --no-auth]
480
481 where::
482
483 <<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
484  -c | --vlm-id          License Model Id. It is of type STRING.
485  -e | --vlm-version     License Model version. It is of type STRING.
486  -x | --name            name. It is of type STRING.
487  -y | --type            type of group (Universal, unique, one-time). It
488                         is of type STRING. By default, it is Universal.
489  -z | --description     Description for License Key Group. It is of type
490                         STRING. It is optional.
491 =======
492  -b | --service-model-id  Service model ID. It is of type STRING. It is
493                           optional.
494  -u | --onap-username     Onap user name. It is of type STRING. By default,
495                           it is read from environment variable
496                           OPEN_USERNAME.
497  -p | --onap-password     Onap user password. It is of type STRING. By
498                           default, it is read from environment variable
499                           OPEN_PASSWORD. Secured.
500  -m | --host-url          Onap host url. It is of type URL. By default, it
501                           is read from environment variable OPEN_HOST_URL.
502  -h | --help              Onap command help message. It is of type STRING.
503                           By default, it is false.
504  -v | --version           Onap command service version. It is of type
505                           STRING. By default, it is false.
506  -d | --debug             Enable debug output. It is of type BOOL. By
507                           default, it is false.
508  -f | --format            Output formats, supported formats such as table,
509                           csv, json, yaml. It is of type STRING. By
510                           default, it is table.
511  -s | --long              whether to print all attributes or only short
512                           attributes. It is of type BOOL. By default, it is
513                           false.
514  -t | --no-title          whether to print title or not. It is of type
515                           BOOL. By default, it is false.
516  -a | --no-auth           whether to authenticate user or not. It is of
517                           type BOOL. By default, it is false.
518
519
520 Error::
521
522  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
523
524
525
526 [9] vlm-checkout
527 -----------------------------------------------
528
529
530 usage: onap vlm-checkout
531
532 Checkout Vendor License Model
533
534 Onap service: sdc v1.0
535
536 Options::
537
538  [-x | --vlm-id] [-y | --vlm-version] [-u | --onap-username]
539  [-p | --onap-password] [-m | --host-url] [-h | --help]
540  [-v | --version] [-d | --debug] [-f | --format]
541  [-s | --long] [-t | --no-title] [-a | --no-auth]
542
543 where::
544
545 <<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
546  -x | --vlm-id          Onap VLM ID. It is of type STRING.
547  -y | --vlm-version     VLM version. It is of type STRING.
548 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
549  -u | --onap-username   Onap user name. It is of type STRING. By default,
550                         it is read from environment variable
551                         ONAP_USERNAME.
552  -p | --onap-password   Onap user password. It is of type STRING. By
553                         default, it is read from environment variable
554                         ONAP_PASSWORD. Secured.
555  -m | --host-url        Onap host url. It is of type URL. By default, it
556                         is read from environment variable ONAP_HOST_URL.
557  -h | --help            Onap command help message. It is of type STRING.
558                         By default, it is false.
559  -v | --version         Onap command service version. It is of type
560                         STRING. By default, it is false.
561  -d | --debug           Enable debug output. It is of type BOOL. By
562                         default, it is false.
563  -f | --format          Output formats, supported formats such as table,
564                         csv, json, yaml. It is of type STRING. By
565                         default, it is table.
566  -s | --long            whether to print all attributes or only short
567                         attributes. It is of type BOOL. By default, it is
568                         false.
569  -t | --no-title        whether to print title or not. It is of type
570                         BOOL. By default, it is false.
571  -a | --no-auth         whether to authenticate user or not. It is of
572                         type BOOL. By default, it is false.
573 =======
574  -x | --customer-name     Onap customer name. It is of type STRING.
575  -y | --resource-version  Onap customer resource version. It is of type
576                           UUID. It is optional. By default, it is
577                           0f4899c3-771c-462e-9dc8-ffa2de5532f6.
578  -u | --onap-username     Onap user name. It is of type STRING. By default,
579                           it is read from environment variable
580                           OPEN_USERNAME.
581  -p | --onap-password     Onap user password. It is of type STRING. By
582                           default, it is read from environment variable
583                           OPEN_PASSWORD. Secured.
584  -m | --host-url          Onap host url. It is of type URL. By default, it
585                           is read from environment variable OPEN_HOST_URL.
586  -h | --help              Onap command help message. It is of type STRING.
587                           By default, it is false.
588  -v | --version           Onap command service version. It is of type
589                           STRING. By default, it is false.
590  -d | --debug             Enable debug output. It is of type BOOL. By
591                           default, it is false.
592  -f | --format            Output formats, supported formats such as table,
593                           csv, json, yaml. It is of type STRING. By
594                           default, it is table.
595  -s | --long              whether to print all attributes or only short
596                           attributes. It is of type BOOL. By default, it is
597                           false.
598  -t | --no-title          whether to print title or not. It is of type
599                           BOOL. By default, it is false.
600  -a | --no-auth           whether to authenticate user or not. It is of
601                           type BOOL. By default, it is false.
602 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
603
604
605 Results::
606
607  ID   License Model ID and is of type STRING.
608
609
610 Error::
611
612  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
613
614
615
616 [7] vlm-aggreement-list
617 -----------------------------------------------
618
619
620 usage: onap vlm-aggreement-list
621
622 List license aggreement
623
624 Onap service: sdc v1.0
625
626 Options::
627
628 <<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
629  [-x | --vlm-id] [-y | --vlm-version] [-u | --onap-username]
630 =======
631 <<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
632  [-x | --vendor-name] [-y | --description] [-u | --onap-username]
633 =======
634  [-x | --cloud] [-y | --region] [-z | --tenant-id]
635  [-r | --resource-version] [-u | --onap-username] [-p | --onap-password]
636  [-m | --host-url] [-h | --help] [-v | --version]
637  [-d | --debug] [-f | --format] [-s | --long]
638  [-t | --no-title] [-a | --no-auth]
639
640 where::
641
642  -x | --cloud             Onap cloud. It is of type STRING.
643  -y | --region            Onap cloud region. It is of type STRING.
644  -z | --tenant-id         Onap cloud tenant id. It is of type STRING.
645  -r | --resource-version  Onap cloud tenant version. It is of type UUID. It
646                           is optional. By default, it is
647                           adbbea15-de1a-442a-a0e3-793779ea25bb.
648  -u | --onap-username     Onap user name. It is of type STRING. By default,
649                           it is read from environment variable
650                           OPEN_USERNAME.
651  -p | --onap-password     Onap user password. It is of type STRING. By
652                           default, it is read from environment variable
653                           OPEN_PASSWORD. Secured.
654  -m | --host-url          Onap host url. It is of type URL. By default, it
655                           is read from environment variable OPEN_HOST_URL.
656  -h | --help              Onap command help message. It is of type STRING.
657                           By default, it is false.
658  -v | --version           Onap command service version. It is of type
659                           STRING. By default, it is false.
660  -d | --debug             Enable debug output. It is of type BOOL. By
661                           default, it is false.
662  -f | --format            Output formats, supported formats such as table,
663                           csv, json, yaml. It is of type STRING. By
664                           default, it is table.
665  -s | --long              whether to print all attributes or only short
666                           attributes. It is of type BOOL. By default, it is
667                           false.
668  -t | --no-title          whether to print title or not. It is of type
669                           BOOL. By default, it is false.
670  -a | --no-auth           whether to authenticate user or not. It is of
671                           type BOOL. By default, it is false.
672
673
674 Error::
675
676  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
677
678
679
680 tenant-list
681 -----------------------------------------------
682
683
684 usage: onap tenant-list
685
686 Lists the tenants under given cloud region in Onap
687
688 Onap service: aai v11
689
690 Options::
691
692  [-x | --cloud] [-y | --region] [-u | --onap-username]
693 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
694 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
695  [-p | --onap-password] [-m | --host-url] [-h | --help]
696  [-v | --version] [-d | --debug] [-f | --format]
697  [-s | --long] [-t | --no-title] [-a | --no-auth]
698
699 where::
700
701  -x | --vlm-id          License Model ID. It is of type STRING.
702  -y | --vlm-version     License Model version. It is of type STRING.
703  -u | --onap-username   Onap user name. It is of type STRING. By default,
704                         it is read from environment variable
705                         OPEN_USERNAME.
706  -p | --onap-password   Onap user password. It is of type STRING. By
707                         default, it is read from environment variable
708                         OPEN_PASSWORD. Secured.
709  -m | --host-url        Onap host url. It is of type URL. By default, it
710                         is read from environment variable OPEN_HOST_URL.
711  -h | --help            Onap command help message. It is of type STRING.
712                         By default, it is false.
713  -v | --version         Onap command service version. It is of type
714                         STRING. By default, it is false.
715  -d | --debug           Enable debug output. It is of type BOOL. By
716                         default, it is false.
717  -f | --format          Output formats, supported formats such as table,
718                         csv, json, yaml. It is of type STRING. By
719                         default, it is table.
720  -s | --long            whether to print all attributes or only short
721                         attributes. It is of type BOOL. By default, it is
722                         false.
723  -t | --no-title        whether to print title or not. It is of type
724                         BOOL. By default, it is false.
725  -a | --no-auth         whether to authenticate user or not. It is of
726                         type BOOL. By default, it is false.
727
728
729 Results::
730
731  ID     aggreement ID and is of type STRING.
732  name   aggreement name and is of type STRING.
733
734
735 Error::
736
737  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
738
739
740
741 [8] vlm-key-group-list
742 -----------------------------------------------
743
744
745 usage: onap vlm-key-group-list
746
747 key group list in a license model
748
749 Onap service: sdc v1.0
750
751 Options::
752
753  [-x | --vlm-id] [-y | --vlm-version] [-u | --onap-username]
754  [-p | --onap-password] [-m | --host-url] [-h | --help]
755  [-v | --version] [-d | --debug] [-f | --format]
756  [-s | --long] [-t | --no-title] [-a | --no-auth]
757
758 where::
759
760 <<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
761  -x | --vlm-id          License Model ID. It is of type STRING.
762  -y | --vlm-version     License Model version. It is of type STRING.
763  -u | --onap-username   Onap user name. It is of type STRING. By default,
764                         it is read from environment variable
765                         ONAP_USERNAME.
766  -p | --onap-password   Onap user password. It is of type STRING. By
767                         default, it is read from environment variable
768                         ONAP_PASSWORD. Secured.
769  -m | --host-url        Onap host url. It is of type URL. By default, it
770                         is read from environment variable ONAP_HOST_URL.
771  -h | --help            Onap command help message. It is of type STRING.
772                         By default, it is false.
773  -v | --version         Onap command service version. It is of type
774                         STRING. By default, it is false.
775  -d | --debug           Enable debug output. It is of type BOOL. By
776                         default, it is false.
777  -f | --format          Output formats, supported formats such as table,
778                         csv, json, yaml. It is of type STRING. By
779                         default, it is table.
780  -s | --long            whether to print all attributes or only short
781                         attributes. It is of type BOOL. By default, it is
782                         false.
783  -t | --no-title        whether to print title or not. It is of type
784                         BOOL. By default, it is false.
785  -a | --no-auth         whether to authenticate user or not. It is of
786                         type BOOL. By default, it is false.
787 =======
788 <<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
789  -x | --name                          Entitlement Pool name. It is of type STRING.
790  -y | --vlm-id                        License Model ID. It is of type STRING.
791  -e | --vlm-version                   License Model version. It is of type STRING.
792  -z | --description                   Description for Entitlement Pool. It is of type
793                                       STRING.
794  -g | --operational-scope             Operational Scope. It is of type STRING. By
795                                       default, it is Availability_Zone.
796  -k | --manufacture-reference-number  Manufature Reference Number. It is of type STRING.
797  -u | --onap-username                 Onap user name. It is of type STRING. By default,
798                                       it is read from environment variable
799                                       ONAP_USERNAME.
800  -p | --onap-password                 Onap user password. It is of type STRING. By
801                                       default, it is read from environment variable
802                                       ONAP_PASSWORD. Secured.
803  -m | --host-url                      Onap host url. It is of type URL. By default, it
804                                       is read from environment variable ONAP_HOST_URL.
805  -h | --help                          Onap command help message. It is of type STRING.
806                                       By default, it is false.
807  -v | --version                       Onap command service version. It is of type
808                                       STRING. By default, it is false.
809  -d | --debug                         Enable debug output. It is of type BOOL. By
810                                       default, it is false.
811  -f | --format                        Output formats, supported formats such as table,
812                                       csv, json, yaml. It is of type STRING. By
813                                       default, it is table.
814  -s | --long                          whether to print all attributes or only short
815                                       attributes. It is of type BOOL. By default, it is
816                                       false.
817  -t | --no-title                      whether to print title or not. It is of type
818                                       BOOL. By default, it is false.
819  -a | --no-auth                       whether to authenticate user or not. It is of
820                                       type BOOL. By default, it is false.
821 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
822
823
824 Results::
825
826 <<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
827  ID     Feature group ID and is of type STRING.
828  name   Feature group name and is of type STRING.
829 =======
830  ID   Entitlement Pool ID and is of type STRING.
831 =======
832  -x | --cloud-name        Onap cloud name. It is of type STRING.
833  -y | --region-name       Onap cloud region name. It is of type STRING.
834  -z | --resource-version  Onap cloud region version. It is of type UUID. It
835                           is optional. By default, it is
836                           93230cdb-aae3-4b87-a38a-fc4529e8aac9.
837  -u | --onap-username     Onap user name. It is of type STRING. By default,
838                           it is read from environment variable
839                           OPEN_USERNAME.
840  -p | --onap-password     Onap user password. It is of type STRING. By
841                           default, it is read from environment variable
842                           OPEN_PASSWORD. Secured.
843  -m | --host-url          Onap host url. It is of type URL. By default, it
844                           is read from environment variable OPEN_HOST_URL.
845  -h | --help              Onap command help message. It is of type STRING.
846                           By default, it is false.
847  -v | --version           Onap command service version. It is of type
848                           STRING. By default, it is false.
849  -d | --debug             Enable debug output. It is of type BOOL. By
850                           default, it is false.
851  -f | --format            Output formats, supported formats such as table,
852                           csv, json, yaml. It is of type STRING. By
853                           default, it is table.
854  -s | --long              whether to print all attributes or only short
855                           attributes. It is of type BOOL. By default, it is
856                           false.
857  -t | --no-title          whether to print title or not. It is of type
858                           BOOL. By default, it is false.
859  -a | --no-auth           whether to authenticate user or not. It is of
860                           type BOOL. By default, it is false.
861 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
862 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
863
864
865 Error::
866
867  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
868
869
870
871 [9] vlm-create
872 -----------------------------------------------
873
874
875 usage: onap vlm-create
876
877 Create License Model
878
879 Onap service: sdc v1.0
880
881 Options::
882
883  [-x | --vendor-name] [-y | --description] [-u | --onap-username]
884  [-p | --onap-password] [-m | --host-url] [-h | --help]
885  [-v | --version] [-d | --debug] [-f | --format]
886  [-s | --long] [-t | --no-title] [-a | --no-auth]
887
888 where::
889
890  -x | --vendor-name     vendor name. It is of type STRING.
891  -y | --description     Description for License Model. It is of type
892                         STRING. It is optional.
893  -u | --onap-username   Onap user name. It is of type STRING. By default,
894                         it is read from environment variable
895                         OPEN_USERNAME.
896  -p | --onap-password   Onap user password. It is of type STRING. By
897                         default, it is read from environment variable
898                         OPEN_PASSWORD. Secured.
899  -m | --host-url        Onap host url. It is of type URL. By default, it
900                         is read from environment variable OPEN_HOST_URL.
901  -h | --help            Onap command help message. It is of type STRING.
902                         By default, it is false.
903  -v | --version         Onap command service version. It is of type
904                         STRING. By default, it is false.
905  -d | --debug           Enable debug output. It is of type BOOL. By
906                         default, it is false.
907  -f | --format          Output formats, supported formats such as table,
908                         csv, json, yaml. It is of type STRING. By
909                         default, it is table.
910  -s | --long            whether to print all attributes or only short
911                         attributes. It is of type BOOL. By default, it is
912                         false.
913  -t | --no-title        whether to print title or not. It is of type
914                         BOOL. By default, it is false.
915  -a | --no-auth         whether to authenticate user or not. It is of
916                         type BOOL. By default, it is false.
917
918
919 Results::
920
921  ID   License Model ID and is of type UUID.
922
923
924 Error::
925
926  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
927
928
929
930 [10] vlm-entitlement-pool-create
931 -----------------------------------------------
932
933
934 usage: onap vlm-entitlement-pool-create
935
936 Create Entitlement Pool
937
938 Onap service: sdc v1.0
939
940 Options::
941
942  [-x | --name] [-y | --vlm-id] [-e | --vlm-version]
943  [-z | --description] [-g | --operational-scope] [-k | --manufacture-reference-number]
944  [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
945  [-h | --help] [-v | --version] [-d | --debug]
946  [-f | --format] [-s | --long] [-t | --no-title]
947  [-a | --no-auth]
948
949 where::
950
951  -x | --name                          Entitlement Pool name. It is of type STRING.
952  -y | --vlm-id                        License Model ID. It is of type STRING.
953  -e | --vlm-version                   License Model version. It is of type STRING.
954  -z | --description                   Description for Entitlement Pool. It is of type
955                                       STRING.
956  -g | --operational-scope             Operational Scope. It is of type STRING. By
957                                       default, it is Availability_Zone.
958  -k | --manufacture-reference-number  Manufature Reference Number. It is of type STRING.
959  -u | --onap-username                 Onap user name. It is of type STRING. By default,
960                                       it is read from environment variable
961                                       ONAP_USERNAME.
962  -p | --onap-password                 Onap user password. It is of type STRING. By
963                                       default, it is read from environment variable
964                                       ONAP_PASSWORD. Secured.
965  -m | --host-url                      Onap host url. It is of type URL. By default, it
966                                       is read from environment variable ONAP_HOST_URL.
967  -h | --help                          Onap command help message. It is of type STRING.
968                                       By default, it is false.
969  -v | --version                       Onap command service version. It is of type
970                                       STRING. By default, it is false.
971  -d | --debug                         Enable debug output. It is of type BOOL. By
972                                       default, it is false.
973  -f | --format                        Output formats, supported formats such as table,
974                                       csv, json, yaml. It is of type STRING. By
975                                       default, it is table.
976  -s | --long                          whether to print all attributes or only short
977                                       attributes. It is of type BOOL. By default, it is
978                                       false.
979  -t | --no-title                      whether to print title or not. It is of type
980                                       BOOL. By default, it is false.
981  -a | --no-auth                       whether to authenticate user or not. It is of
982                                       type BOOL. By default, it is false.
983
984
985 Results::
986
987  ID   Entitlement Pool ID and is of type STRING.
988
989
990 Error::
991
992  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
993
994
995
996 [11] vsp-package
997 -----------------------------------------------
998
999
1000 usage: onap vsp-package
1001
1002 Package Vendor Software Product
1003
1004 Onap service: sdc v1.0
1005
1006 Options::
1007
1008  [-x | --vsp-id] [-y | --vsp-version] [-u | --onap-username]
1009  [-p | --onap-password] [-m | --host-url] [-h | --help]
1010  [-v | --version] [-d | --debug] [-f | --format]
1011  [-s | --long] [-t | --no-title] [-a | --no-auth]
1012
1013 where::
1014
1015  -x | --vsp-id          Onap VSP ID. It is of type STRING.
1016  -y | --vsp-version     VSP version. It is of type STRING.
1017  -u | --onap-username   Onap user name. It is of type STRING. By default,
1018                         it is read from environment variable
1019                         OPEN_USERNAME.
1020  -p | --onap-password   Onap user password. It is of type STRING. By
1021                         default, it is read from environment variable
1022                         OPEN_PASSWORD. Secured.
1023  -m | --host-url        Onap host url. It is of type URL. By default, it
1024                         is read from environment variable OPEN_HOST_URL.
1025  -h | --help            Onap command help message. It is of type STRING.
1026                         By default, it is false.
1027  -v | --version         Onap command service version. It is of type
1028                         STRING. By default, it is false.
1029  -d | --debug           Enable debug output. It is of type BOOL. By
1030                         default, it is false.
1031  -f | --format          Output formats, supported formats such as table,
1032                         csv, json, yaml. It is of type STRING. By
1033                         default, it is table.
1034  -s | --long            whether to print all attributes or only short
1035                         attributes. It is of type BOOL. By default, it is
1036                         false.
1037  -t | --no-title        whether to print title or not. It is of type
1038                         BOOL. By default, it is false.
1039  -a | --no-auth         whether to authenticate user or not. It is of
1040                         type BOOL. By default, it is false.
1041
1042
1043 Error::
1044
1045  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
1046
1047
1048
1049 [12] vsp-submit
1050 -----------------------------------------------
1051
1052
1053 usage: onap vsp-submit
1054
1055 Submit Vendor Software Product
1056
1057 Onap service: sdc v1.0
1058
1059 Options::
1060
1061  [-x | --vsp-id] [-y | --vsp-version] [-u | --onap-username]
1062  [-p | --onap-password] [-m | --host-url] [-h | --help]
1063  [-v | --version] [-d | --debug] [-f | --format]
1064  [-s | --long] [-t | --no-title] [-a | --no-auth]
1065
1066 where::
1067
1068  -x | --vsp-id          Onap VSP ID. It is of type STRING.
1069  -y | --vsp-version     VSP version. It is of type STRING.
1070  -u | --onap-username   Onap user name. It is of type STRING. By default,
1071                         it is read from environment variable
1072                         OPEN_USERNAME.
1073  -p | --onap-password   Onap user password. It is of type STRING. By
1074                         default, it is read from environment variable
1075                         OPEN_PASSWORD. Secured.
1076  -m | --host-url        Onap host url. It is of type URL. By default, it
1077                         is read from environment variable OPEN_HOST_URL.
1078  -h | --help            Onap command help message. It is of type STRING.
1079                         By default, it is false.
1080  -v | --version         Onap command service version. It is of type
1081                         STRING. By default, it is false.
1082  -d | --debug           Enable debug output. It is of type BOOL. By
1083                         default, it is false.
1084  -f | --format          Output formats, supported formats such as table,
1085                         csv, json, yaml. It is of type STRING. By
1086                         default, it is table.
1087  -s | --long            whether to print all attributes or only short
1088                         attributes. It is of type BOOL. By default, it is
1089                         false.
1090  -t | --no-title        whether to print title or not. It is of type
1091                         BOOL. By default, it is false.
1092  -a | --no-auth         whether to authenticate user or not. It is of
1093                         type BOOL. By default, it is false.
1094
1095
1096 Error::
1097
1098  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
1099
1100
1101
1102 [13] vsp-checkout
1103 -----------------------------------------------
1104
1105
1106 usage: onap vsp-checkout
1107
1108 Checkout Vendor Software Product
1109
1110 Onap service: sdc v1.0
1111
1112 Options::
1113
1114  [-x | --vsp-id] [-y | --vsp-version] [-u | --onap-username]
1115  [-p | --onap-password] [-m | --host-url] [-h | --help]
1116  [-v | --version] [-d | --debug] [-f | --format]
1117  [-s | --long] [-t | --no-title] [-a | --no-auth]
1118
1119 where::
1120
1121 <<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
1122  -x | --vsp-id          Onap VSP ID. It is of type STRING.
1123  -y | --vsp-version     VSP version. It is of type STRING.
1124 =======
1125 <<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
1126  -x | --vlm-id          License Model ID. It is of type STRING.
1127  -y | --vlm-version     License Model version. It is of type STRING.
1128 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
1129  -u | --onap-username   Onap user name. It is of type STRING. By default,
1130                         it is read from environment variable
1131                         ONAP_USERNAME.
1132  -p | --onap-password   Onap user password. It is of type STRING. By
1133                         default, it is read from environment variable
1134                         ONAP_PASSWORD. Secured.
1135  -m | --host-url        Onap host url. It is of type URL. By default, it
1136                         is read from environment variable ONAP_HOST_URL.
1137  -h | --help            Onap command help message. It is of type STRING.
1138                         By default, it is false.
1139  -v | --version         Onap command service version. It is of type
1140                         STRING. By default, it is false.
1141  -d | --debug           Enable debug output. It is of type BOOL. By
1142                         default, it is false.
1143  -f | --format          Output formats, supported formats such as table,
1144                         csv, json, yaml. It is of type STRING. By
1145                         default, it is table.
1146  -s | --long            whether to print all attributes or only short
1147                         attributes. It is of type BOOL. By default, it is
1148                         false.
1149  -t | --no-title        whether to print title or not. It is of type
1150                         BOOL. By default, it is false.
1151  -a | --no-auth         whether to authenticate user or not. It is of
1152                         type BOOL. By default, it is false.
1153
1154
1155 <<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
1156 =======
1157 Results::
1158
1159  ID     Feature group ID and is of type STRING.
1160  name   Feature group name and is of type STRING.
1161 =======
1162  -x | --cloud-name        Onap cloud name. It is of type STRING.
1163  -y | --region-name       Onap  region name. It is of type STRING.
1164  -z | --vim-id            Onap VIM unique id. It is of type UUID. By
1165                           default, it is
1166                           65c6f4af-893f-4130-aa79-9158fcaed040.
1167  -b | --resource-version  Onap vim resource version. It is of type STRING.
1168                           It is optional.
1169  -u | --onap-username     Onap user name. It is of type STRING. By default,
1170                           it is read from environment variable
1171                           OPEN_USERNAME.
1172  -p | --onap-password     Onap user password. It is of type STRING. By
1173                           default, it is read from environment variable
1174                           OPEN_PASSWORD. Secured.
1175  -m | --host-url          Onap host url. It is of type URL. By default, it
1176                           is read from environment variable OPEN_HOST_URL.
1177  -h | --help              Onap command help message. It is of type STRING.
1178                           By default, it is false.
1179  -v | --version           Onap command service version. It is of type
1180                           STRING. By default, it is false.
1181  -d | --debug             Enable debug output. It is of type BOOL. By
1182                           default, it is false.
1183  -f | --format            Output formats, supported formats such as table,
1184                           csv, json, yaml. It is of type STRING. By
1185                           default, it is table.
1186  -s | --long              whether to print all attributes or only short
1187                           attributes. It is of type BOOL. By default, it is
1188                           false.
1189  -t | --no-title          whether to print title or not. It is of type
1190                           BOOL. By default, it is false.
1191  -a | --no-auth           whether to authenticate user or not. It is of
1192                           type BOOL. By default, it is false.
1193 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
1194
1195
1196 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
1197 Error::
1198
1199  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
1200
1201
1202
1203 [14] vsp-show
1204 -----------------------------------------------
1205
1206
1207 usage: onap vsp-show
1208
1209 Details of the Vendor Software Product
1210
1211 Onap service: sdc v1.0
1212
1213 Options::
1214
1215 <<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
1216  [-x | --vsp-id] [-y | --vsp-version] [-u | --onap-username]
1217  [-p | --onap-password] [-m | --host-url] [-h | --help]
1218  [-v | --version] [-d | --debug] [-f | --format]
1219  [-s | --long] [-t | --no-title] [-a | --no-auth]
1220 =======
1221 <<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
1222 =======
1223  [-x | --vim-id] [-y | --vnfm-id] [-b | --name]
1224  [-c | --type] [-e | --vendor] [-q | --vnfm-version]
1225  [-g | --url] [-i | --username] [-j | --password]
1226  [-z | --certificate-url] [-u | --onap-username] [-p | --onap-password]
1227  [-m | --host-url] [-h | --help] [-v | --version]
1228  [-d | --debug] [-f | --format] [-s | --long]
1229  [-t | --no-title] [-a | --no-auth]
1230
1231 where::
1232
1233  -x | --vim-id            Onap VIM unique id. It is of type UUID. By
1234                           default, it is
1235                           e74f4b44-28ee-45e4-a1ac-7c3a0ed4a0b7.
1236  -y | --vnfm-id           Onap VNFM unique id. It is of type UUID. By
1237                           default, it is
1238                           7a74f262-5b96-4445-8a56-2d43b73f6f6c.
1239  -b | --name              Onap VNFM name. It is of type STRING.
1240  -c | --type              Onap VNFM type. It is of type STRING.
1241  -e | --vendor            Onap VNFM vendor. It is of type STRING.
1242  -q | --vnfm-version      Onap VNFM version. It is of type STRING.
1243  -g | --url               Onap VNFM URL. It is of type STRING.
1244  -i | --username          Onap VNFM username. It is of type STRING.
1245  -j | --password          Onap VNFM password. It is of type STRING.
1246  -z | --certificate-url   Onap VNFM certificate-url. It is of type STRING.
1247                           It is optional.
1248  -u | --onap-username     Onap user name. It is of type STRING. By default,
1249                           it is read from environment variable
1250                           OPEN_USERNAME.
1251  -p | --onap-password     Onap user password. It is of type STRING. By
1252                           default, it is read from environment variable
1253                           OPEN_PASSWORD. Secured.
1254  -m | --host-url          Onap host url. It is of type URL. By default, it
1255                           is read from environment variable OPEN_HOST_URL.
1256  -h | --help              Onap command help message. It is of type STRING.
1257                           By default, it is false.
1258  -v | --version           Onap command service version. It is of type
1259                           STRING. By default, it is false.
1260  -d | --debug             Enable debug output. It is of type BOOL. By
1261                           default, it is false.
1262  -f | --format            Output formats, supported formats such as table,
1263                           csv, json, yaml. It is of type STRING. By
1264                           default, it is table.
1265  -s | --long              whether to print all attributes or only short
1266                           attributes. It is of type BOOL. By default, it is
1267                           false.
1268  -t | --no-title          whether to print title or not. It is of type
1269                           BOOL. By default, it is false.
1270  -a | --no-auth           whether to authenticate user or not. It is of
1271                           type BOOL. By default, it is false.
1272
1273
1274 Error::
1275
1276  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
1277
1278
1279
1280 vnfm-list
1281 -----------------------------------------------
1282
1283
1284 usage: onap vnfm-list
1285
1286 List the configured vnfm
1287
1288 Onap service: aai v11
1289
1290 Options::
1291
1292 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
1293  [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
1294  [-h | --help] [-v | --version] [-d | --debug]
1295  [-f | --format] [-s | --long] [-t | --no-title]
1296  [-a | --no-auth]
1297 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
1298
1299 where::
1300
1301  -x | --vsp-id          Onap VSP ID. It is of type STRING.
1302  -y | --vsp-version     Onap VSP version. It is of type STRING.
1303  -u | --onap-username   Onap user name. It is of type STRING. By default,
1304                         it is read from environment variable
1305                         OPEN_USERNAME.
1306  -p | --onap-password   Onap user password. It is of type STRING. By
1307                         default, it is read from environment variable
1308                         OPEN_PASSWORD. Secured.
1309  -m | --host-url        Onap host url. It is of type URL. By default, it
1310                         is read from environment variable OPEN_HOST_URL.
1311  -h | --help            Onap command help message. It is of type STRING.
1312                         By default, it is false.
1313  -v | --version         Onap command service version. It is of type
1314                         STRING. By default, it is false.
1315  -d | --debug           Enable debug output. It is of type BOOL. By
1316                         default, it is false.
1317  -f | --format          Output formats, supported formats such as table,
1318                         csv, json, yaml. It is of type STRING. By
1319                         default, it is table.
1320  -s | --long            whether to print all attributes or only short
1321                         attributes. It is of type BOOL. By default, it is
1322                         false.
1323  -t | --no-title        whether to print title or not. It is of type
1324                         BOOL. By default, it is false.
1325  -a | --no-auth         whether to authenticate user or not. It is of
1326                         type BOOL. By default, it is false.
1327
1328
1329 Results::
1330
1331  name         VSP Name and is of type STRING.
1332  ID           VSP ID and is of type STRING.
1333  description  Description for the VSP and is of type STRING.
1334  vendor-name  Vendor name and is of type STRING.
1335  vendor-id    Vendor id and is of type STRING.
1336  version      Version and is of type STRING.
1337  status       status and is of type STRING.
1338  license-id   license aggreement and is of type STRING.
1339
1340
1341 Error::
1342
1343  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
1344
1345
1346
1347 [15] vsp-create
1348 -----------------------------------------------
1349
1350
1351 usage: onap vsp-create
1352
1353 Create Vendor Software Product
1354
1355 Onap service: sdc v1.0
1356
1357 Options::
1358
1359  [-x | --vsp-name] [-y | --vsp-description] [-z | --vsp-category]
1360  [-b | --vsp-subcategory] [-c | --vlm-version] [-e | --vlm-vendor]
1361  [-g | --vlm-id] [-i | --vlm-agreement-id] [-j | --vlm-feature-group-id]
1362  [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
1363  [-h | --help] [-v | --version] [-d | --debug]
1364  [-f | --format] [-s | --long] [-t | --no-title]
1365  [-a | --no-auth]
1366
1367 where::
1368
1369 <<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
1370  -x | --vsp-name              Onap VSP Name. It is of type STRING.
1371  -y | --vsp-description       Description for VSP. It is of type STRING. It is
1372                               optional.
1373  -z | --vsp-category          Category of the VSP. It is of type STRING. It is
1374                               optional. By default, it is
1375                               resourceNewCategory.generic.
1376  -b | --vsp-subcategory       Sub Category of VSP. It is of type STRING. It is
1377                               optional. By default, it is
1378                               resourceNewCategory.generic.abstract.
1379  -c | --vlm-version           License version. It is of type STRING. It is
1380                               optional. By default, it is 1.0.
1381  -e | --vlm-vendor            License Model vendor. It is of type STRING.
1382  -g | --vlm-id                License Model ID. It is of type STRING.
1383  -i | --vlm-agreement-id      License Agreement ID. It is of type STRING.
1384  -j | --vlm-feature-group-id  Feature Group ID. It is of type STRING.
1385  -u | --onap-username         Onap user name. It is of type STRING. By default,
1386                               it is read from environment variable
1387                               ONAP_USERNAME.
1388  -p | --onap-password         Onap user password. It is of type STRING. By
1389                               default, it is read from environment variable
1390                               ONAP_PASSWORD. Secured.
1391  -m | --host-url              Onap host url. It is of type URL. By default, it
1392                               is read from environment variable ONAP_HOST_URL.
1393  -h | --help                  Onap command help message. It is of type STRING.
1394                               By default, it is false.
1395  -v | --version               Onap command service version. It is of type
1396                               STRING. By default, it is false.
1397  -d | --debug                 Enable debug output. It is of type BOOL. By
1398                               default, it is false.
1399  -f | --format                Output formats, supported formats such as table,
1400                               csv, json, yaml. It is of type STRING. By
1401                               default, it is table.
1402  -s | --long                  whether to print all attributes or only short
1403                               attributes. It is of type BOOL. By default, it is
1404                               false.
1405  -t | --no-title              whether to print title or not. It is of type
1406                               BOOL. By default, it is false.
1407  -a | --no-auth               whether to authenticate user or not. It is of
1408                               type BOOL. By default, it is false.
1409 =======
1410 <<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
1411  -x | --vlm-id          Onap VLM ID. It is of type STRING.
1412  -y | --vlm-version     VLM version. It is of type STRING.
1413  -u | --onap-username   Onap user name. It is of type STRING. By default,
1414                         it is read from environment variable
1415                         ONAP_USERNAME.
1416  -p | --onap-password   Onap user password. It is of type STRING. By
1417                         default, it is read from environment variable
1418                         ONAP_PASSWORD. Secured.
1419  -m | --host-url        Onap host url. It is of type URL. By default, it
1420                         is read from environment variable ONAP_HOST_URL.
1421  -h | --help            Onap command help message. It is of type STRING.
1422                         By default, it is false.
1423  -v | --version         Onap command service version. It is of type
1424                         STRING. By default, it is false.
1425  -d | --debug           Enable debug output. It is of type BOOL. By
1426                         default, it is false.
1427  -f | --format          Output formats, supported formats such as table,
1428                         csv, json, yaml. It is of type STRING. By
1429                         default, it is table.
1430  -s | --long            whether to print all attributes or only short
1431                         attributes. It is of type BOOL. By default, it is
1432                         false.
1433  -t | --no-title        whether to print title or not. It is of type
1434                         BOOL. By default, it is false.
1435  -a | --no-auth         whether to authenticate user or not. It is of
1436                         type BOOL. By default, it is false.
1437 =======
1438  -x | --service-type      Onap service type. It is of type STRING.
1439  -y | --service-type-id   Onap service type uuid. It is of type UUID. It is
1440                           optional. By default, it is
1441                           3def24ae-701e-4c98-91a6-859c0f206759.
1442  -u | --onap-username     Onap user name. It is of type STRING. By default,
1443                           it is read from environment variable
1444                           OPEN_USERNAME.
1445  -p | --onap-password     Onap user password. It is of type STRING. By
1446                           default, it is read from environment variable
1447                           OPEN_PASSWORD. Secured.
1448  -m | --host-url          Onap host url. It is of type URL. By default, it
1449                           is read from environment variable OPEN_HOST_URL.
1450  -h | --help              Onap command help message. It is of type STRING.
1451                           By default, it is false.
1452  -v | --version           Onap command service version. It is of type
1453                           STRING. By default, it is false.
1454  -d | --debug             Enable debug output. It is of type BOOL. By
1455                           default, it is false.
1456  -f | --format            Output formats, supported formats such as table,
1457                           csv, json, yaml. It is of type STRING. By
1458                           default, it is table.
1459  -s | --long              whether to print all attributes or only short
1460                           attributes. It is of type BOOL. By default, it is
1461                           false.
1462  -t | --no-title          whether to print title or not. It is of type
1463                           BOOL. By default, it is false.
1464  -a | --no-auth           whether to authenticate user or not. It is of
1465                           type BOOL. By default, it is false.
1466 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
1467
1468
1469 Error::
1470
1471  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
1472
1473
1474
1475 [19] vlm-submit
1476 -----------------------------------------------
1477
1478
1479 usage: onap vlm-submit
1480
1481 Submit Vendor License Model
1482
1483 Onap service: sdc v1.0
1484
1485 Options::
1486 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
1487
1488
1489 Results::
1490
1491 <<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
1492  ID   VSP ID and is of type STRING.
1493 =======
1494 <<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
1495  -x | --vlm-id          Onap VLM ID. It is of type STRING.
1496  -y | --vlm-version     VLM version. It is of type STRING.
1497  -u | --onap-username   Onap user name. It is of type STRING. By default,
1498                         it is read from environment variable
1499                         ONAP_USERNAME.
1500  -p | --onap-password   Onap user password. It is of type STRING. By
1501                         default, it is read from environment variable
1502                         ONAP_PASSWORD. Secured.
1503  -m | --host-url        Onap host url. It is of type URL. By default, it
1504                         is read from environment variable ONAP_HOST_URL.
1505  -h | --help            Onap command help message. It is of type STRING.
1506                         By default, it is false.
1507  -v | --version         Onap command service version. It is of type
1508                         STRING. By default, it is false.
1509  -d | --debug           Enable debug output. It is of type BOOL. By
1510                         default, it is false.
1511  -f | --format          Output formats, supported formats such as table,
1512                         csv, json, yaml. It is of type STRING. By
1513                         default, it is table.
1514  -s | --long            whether to print all attributes or only short
1515                         attributes. It is of type BOOL. By default, it is
1516                         false.
1517  -t | --no-title        whether to print title or not. It is of type
1518                         BOOL. By default, it is false.
1519  -a | --no-auth         whether to authenticate user or not. It is of
1520                         type BOOL. By default, it is false.
1521 =======
1522  -x | --service-type-id   Onap service type uuid. It is of type UUID. It is
1523                           optional. By default, it is
1524                           04ebd209-7800-43f4-bca4-aaf61e15783e.
1525  -y | --resource-version  Onap service resource version. It is of type
1526                           UUID. It is optional. By default, it is
1527                           7b301a17-5eb2-413b-b214-fd1659fdf049.
1528  -u | --onap-username     Onap user name. It is of type STRING. By default,
1529                           it is read from environment variable
1530                           OPEN_USERNAME.
1531  -p | --onap-password     Onap user password. It is of type STRING. By
1532                           default, it is read from environment variable
1533                           OPEN_PASSWORD. Secured.
1534  -m | --host-url          Onap host url. It is of type URL. By default, it
1535                           is read from environment variable OPEN_HOST_URL.
1536  -h | --help              Onap command help message. It is of type STRING.
1537                           By default, it is false.
1538  -v | --version           Onap command service version. It is of type
1539                           STRING. By default, it is false.
1540  -d | --debug             Enable debug output. It is of type BOOL. By
1541                           default, it is false.
1542  -f | --format            Output formats, supported formats such as table,
1543                           csv, json, yaml. It is of type STRING. By
1544                           default, it is table.
1545  -s | --long              whether to print all attributes or only short
1546                           attributes. It is of type BOOL. By default, it is
1547                           false.
1548  -t | --no-title          whether to print title or not. It is of type
1549                           BOOL. By default, it is false.
1550  -a | --no-auth           whether to authenticate user or not. It is of
1551                           type BOOL. By default, it is false.
1552 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
1553 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
1554
1555
1556 Error::
1557
1558  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
1559
1560
1561
1562 [16] vsp-add-artifact
1563 -----------------------------------------------
1564
1565
1566 usage: onap vsp-add-artifact
1567
1568 Upload the CSAR file to VSP
1569
1570 Onap service: sdc v1.0
1571
1572 Options::
1573
1574  [-x | --vsp-id] [-y | --vsp-version] [-z | --vsp-file]
1575  [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
1576  [-h | --help] [-v | --version] [-d | --debug]
1577  [-f | --format] [-s | --long] [-t | --no-title]
1578  [-a | --no-auth]
1579
1580 where::
1581
1582  -x | --vsp-id          Onap VSP ID. It is of type STRING.
1583  -y | --vsp-version     Onap VSP version. It is of type STRING.
1584  -z | --vsp-file        CSAR File path. It is of type BINARY.
1585  -u | --onap-username   Onap user name. It is of type STRING. By default,
1586                         it is read from environment variable
1587                         OPEN_USERNAME.
1588  -p | --onap-password   Onap user password. It is of type STRING. By
1589                         default, it is read from environment variable
1590                         OPEN_PASSWORD. Secured.
1591  -m | --host-url        Onap host url. It is of type URL. By default, it
1592                         is read from environment variable OPEN_HOST_URL.
1593  -h | --help            Onap command help message. It is of type STRING.
1594                         By default, it is false.
1595  -v | --version         Onap command service version. It is of type
1596                         STRING. By default, it is false.
1597  -d | --debug           Enable debug output. It is of type BOOL. By
1598                         default, it is false.
1599  -f | --format          Output formats, supported formats such as table,
1600                         csv, json, yaml. It is of type STRING. By
1601                         default, it is table.
1602  -s | --long            whether to print all attributes or only short
1603                         attributes. It is of type BOOL. By default, it is
1604                         false.
1605  -t | --no-title        whether to print title or not. It is of type
1606                         BOOL. By default, it is false.
1607  -a | --no-auth         whether to authenticate user or not. It is of
1608                         type BOOL. By default, it is false.
1609
1610
1611 Error::
1612
1613  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
1614
1615
1616
1617 [17] vsp-revert
1618 -----------------------------------------------
1619
1620
1621 usage: onap vsp-revert
1622
1623 Revert Vendor Software Product
1624
1625 Onap service: sdc v1.0
1626
1627 Options::
1628
1629  [-x | --vsp-id] [-y | --vsp-version] [-u | --onap-username]
1630  [-p | --onap-password] [-m | --host-url] [-h | --help]
1631  [-v | --version] [-d | --debug] [-f | --format]
1632  [-s | --long] [-t | --no-title] [-a | --no-auth]
1633
1634 where::
1635
1636 <<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
1637  -x | --vsp-id          Onap VSP ID. It is of type STRING.
1638  -y | --vsp-version     VSP version. It is of type STRING.
1639 =======
1640  -x | --customer-name     Onap customer name. It is of type STRING.
1641  -z | --cloud-name        Onap cloud name. It is of type STRING.
1642  -r | --cloud-region      Onap cloud region. It is of type STRING.
1643  -c | --cloud-tenant-id   Onap cloud tenant id. It is of type STRING.
1644  -e | --service-type      Onap service type. It is of type STRING.
1645  -u | --onap-username     Onap user name. It is of type STRING. By default,
1646                           it is read from environment variable
1647                           OPEN_USERNAME.
1648  -p | --onap-password     Onap user password. It is of type STRING. By
1649                           default, it is read from environment variable
1650                           OPEN_PASSWORD. Secured.
1651  -m | --host-url          Onap host url. It is of type URL. By default, it
1652                           is read from environment variable OPEN_HOST_URL.
1653  -h | --help              Onap command help message. It is of type STRING.
1654                           By default, it is false.
1655  -v | --version           Onap command service version. It is of type
1656                           STRING. By default, it is false.
1657  -d | --debug             Enable debug output. It is of type BOOL. By
1658                           default, it is false.
1659  -f | --format            Output formats, supported formats such as table,
1660                           csv, json, yaml. It is of type STRING. By
1661                           default, it is table.
1662  -s | --long              whether to print all attributes or only short
1663                           attributes. It is of type BOOL. By default, it is
1664                           false.
1665  -t | --no-title          whether to print title or not. It is of type
1666                           BOOL. By default, it is false.
1667  -a | --no-auth           whether to authenticate user or not. It is of
1668                           type BOOL. By default, it is false.
1669
1670
1671 Error::
1672
1673  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
1674
1675
1676
1677 cloud-list
1678 -----------------------------------------------
1679
1680
1681 usage: onap cloud-list
1682
1683 List the configured clouds and Onap service subscriptions
1684
1685 Onap service: aai v11
1686
1687 Options::
1688
1689  [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
1690  [-h | --help] [-v | --version] [-d | --debug]
1691  [-f | --format] [-s | --long] [-t | --no-title]
1692  [-a | --no-auth]
1693
1694 where::
1695
1696 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
1697  -u | --onap-username   Onap user name. It is of type STRING. By default,
1698                         it is read from environment variable
1699                         OPEN_USERNAME.
1700  -p | --onap-password   Onap user password. It is of type STRING. By
1701                         default, it is read from environment variable
1702                         OPEN_PASSWORD. Secured.
1703  -m | --host-url        Onap host url. It is of type URL. By default, it
1704                         is read from environment variable OPEN_HOST_URL.
1705  -h | --help            Onap command help message. It is of type STRING.
1706                         By default, it is false.
1707  -v | --version         Onap command service version. It is of type
1708                         STRING. By default, it is false.
1709  -d | --debug           Enable debug output. It is of type BOOL. By
1710                         default, it is false.
1711  -f | --format          Output formats, supported formats such as table,
1712                         csv, json, yaml. It is of type STRING. By
1713                         default, it is table.
1714  -s | --long            whether to print all attributes or only short
1715                         attributes. It is of type BOOL. By default, it is
1716                         false.
1717  -t | --no-title        whether to print title or not. It is of type
1718                         BOOL. By default, it is false.
1719  -a | --no-auth         whether to authenticate user or not. It is of
1720                         type BOOL. By default, it is false.
1721
1722
1723 Error::
1724
1725  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
1726
1727
1728
1729 [18] vsp-checkout
1730 -----------------------------------------------
1731
1732
1733 usage: onap vsp-checkout
1734
1735 Checkout Vendor Software Product
1736
1737 Onap service: sdc v1.0
1738
1739 Options::
1740
1741  [-x | --vsp-id] [-y | --vsp-version] [-u | --onap-username]
1742  [-p | --onap-password] [-m | --host-url] [-h | --help]
1743  [-v | --version] [-d | --debug] [-f | --format]
1744  [-s | --long] [-t | --no-title] [-a | --no-auth]
1745
1746 where::
1747
1748  -x | --vsp-id          Onap VSP ID. It is of type STRING.
1749  -y | --vsp-version     VSP version. It is of type STRING.
1750  -u | --onap-username   Onap user name. It is of type STRING. By default,
1751                         it is read from environment variable
1752                         OPEN_USERNAME.
1753  -p | --onap-password   Onap user password. It is of type STRING. By
1754                         default, it is read from environment variable
1755                         OPEN_PASSWORD. Secured.
1756  -m | --host-url        Onap host url. It is of type URL. By default, it
1757                         is read from environment variable OPEN_HOST_URL.
1758  -h | --help            Onap command help message. It is of type STRING.
1759                         By default, it is false.
1760  -v | --version         Onap command service version. It is of type
1761                         STRING. By default, it is false.
1762  -d | --debug           Enable debug output. It is of type BOOL. By
1763                         default, it is false.
1764  -f | --format          Output formats, supported formats such as table,
1765                         csv, json, yaml. It is of type STRING. By
1766                         default, it is table.
1767  -s | --long            whether to print all attributes or only short
1768                         attributes. It is of type BOOL. By default, it is
1769                         false.
1770  -t | --no-title        whether to print title or not. It is of type
1771                         BOOL. By default, it is false.
1772  -a | --no-auth         whether to authenticate user or not. It is of
1773                         type BOOL. By default, it is false.
1774
1775
1776 Error::
1777
1778  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
1779
1780
1781
1782 [19] vsp-validate
1783 -----------------------------------------------
1784
1785
1786 usage: onap vsp-validate
1787
1788 Validated the uploaded Vendor Software Product
1789
1790 Onap service: sdc v1.0
1791
1792 Options::
1793
1794  [-x | --vsp-id] [-y | --vsp-version] [-u | --onap-username]
1795  [-p | --onap-password] [-m | --host-url] [-h | --help]
1796  [-v | --version] [-d | --debug] [-f | --format]
1797  [-s | --long] [-t | --no-title] [-a | --no-auth]
1798
1799 where::
1800
1801  -x | --vsp-id          Onap VSP ID. It is of type STRING.
1802  -y | --vsp-version     VSP version. It is of type STRING.
1803  -u | --onap-username   Onap user name. It is of type STRING. By default,
1804                         it is read from environment variable
1805                         OPEN_USERNAME.
1806  -p | --onap-password   Onap user password. It is of type STRING. By
1807                         default, it is read from environment variable
1808                         OPEN_PASSWORD. Secured.
1809  -m | --host-url        Onap host url. It is of type URL. By default, it
1810                         is read from environment variable OPEN_HOST_URL.
1811  -h | --help            Onap command help message. It is of type STRING.
1812                         By default, it is false.
1813  -v | --version         Onap command service version. It is of type
1814                         STRING. By default, it is false.
1815  -d | --debug           Enable debug output. It is of type BOOL. By
1816                         default, it is false.
1817  -f | --format          Output formats, supported formats such as table,
1818                         csv, json, yaml. It is of type STRING. By
1819                         default, it is table.
1820  -s | --long            whether to print all attributes or only short
1821                         attributes. It is of type BOOL. By default, it is
1822                         false.
1823  -t | --no-title        whether to print title or not. It is of type
1824                         BOOL. By default, it is false.
1825  -a | --no-auth         whether to authenticate user or not. It is of
1826                         type BOOL. By default, it is false.
1827
1828
1829 <<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
1830 =======
1831 Error::
1832
1833  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
1834
1835
1836
1837 [24] vsp-create
1838 -----------------------------------------------
1839
1840
1841 usage: onap vsp-create
1842
1843 Create Vendor Software Product
1844
1845 Onap service: sdc v1.0
1846
1847 Options::
1848
1849  [-x | --vsp-name] [-y | --vsp-description] [-z | --vsp-category]
1850  [-b | --vsp-subcategory] [-c | --vsp-license-version] [-e | --vsp-vendor-name]
1851  [-g | --vsp-vendor-id] [-i | --license-agreement-id] [-j | --feature-group-id]
1852  [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
1853  [-h | --help] [-v | --version] [-d | --debug]
1854  [-f | --format] [-s | --long] [-t | --no-title]
1855  [-a | --no-auth]
1856
1857 where::
1858
1859 <<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
1860  -x | --vsp-name              Onap VSP Name. It is of type STRING.
1861  -y | --vsp-description       Description for VSP. It is of type STRING. It is
1862                               optional.
1863  -z | --vsp-category          Category of the VSP. It is of type STRING. It is
1864                               optional. By default, it is
1865                               resourceNewCategory.generic.
1866  -b | --vsp-subcategory       Sub Category of VSP. It is of type STRING. It is
1867                               optional. By default, it is
1868                               resourceNewCategory.generic.abstract.
1869  -c | --vsp-license-version   License version. It is of type STRING. It is
1870                               optional. By default, it is 1.0.
1871  -e | --vsp-vendor-name       License Model Name. It is of type STRING.
1872  -g | --vsp-vendor-id         License Model ID. It is of type STRING.
1873  -i | --license-agreement-id  License Agreement ID. It is of type STRING.
1874  -j | --feature-group-id      Feature Group ID. It is of type STRING.
1875  -u | --onap-username         Onap user name. It is of type STRING. By default,
1876                               it is read from environment variable
1877                               ONAP_USERNAME.
1878  -p | --onap-password         Onap user password. It is of type STRING. By
1879                               default, it is read from environment variable
1880                               ONAP_PASSWORD. Secured.
1881  -m | --host-url              Onap host url. It is of type URL. By default, it
1882                               is read from environment variable ONAP_HOST_URL.
1883  -h | --help                  Onap command help message. It is of type STRING.
1884                               By default, it is false.
1885  -v | --version               Onap command service version. It is of type
1886                               STRING. By default, it is false.
1887  -d | --debug                 Enable debug output. It is of type BOOL. By
1888                               default, it is false.
1889  -f | --format                Output formats, supported formats such as table,
1890                               csv, json, yaml. It is of type STRING. By
1891                               default, it is table.
1892  -s | --long                  whether to print all attributes or only short
1893                               attributes. It is of type BOOL. By default, it is
1894                               false.
1895  -t | --no-title              whether to print title or not. It is of type
1896                               BOOL. By default, it is false.
1897  -a | --no-auth               whether to authenticate user or not. It is of
1898                               type BOOL. By default, it is false.
1899 =======
1900  -u | --onap-username   Onap user name. It is of type STRING. By default,
1901                         it is read from environment variable
1902                         OPEN_USERNAME.
1903  -p | --onap-password   Onap user password. It is of type STRING. By
1904                         default, it is read from environment variable
1905                         OPEN_PASSWORD. Secured.
1906  -m | --host-url        Onap host url. It is of type URL. By default, it
1907                         is read from environment variable OPEN_HOST_URL.
1908  -h | --help            Onap command help message. It is of type STRING.
1909                         By default, it is false.
1910  -v | --version         Onap command service version. It is of type
1911                         STRING. By default, it is false.
1912  -d | --debug           Enable debug output. It is of type BOOL. By
1913                         default, it is false.
1914  -f | --format          Output formats, supported formats such as table,
1915                         csv, json, yaml. It is of type STRING. By
1916                         default, it is table.
1917  -s | --long            whether to print all attributes or only short
1918                         attributes. It is of type BOOL. By default, it is
1919                         false.
1920  -t | --no-title        whether to print title or not. It is of type
1921                         BOOL. By default, it is false.
1922  -a | --no-auth         whether to authenticate user or not. It is of
1923                         type BOOL. By default, it is false.
1924 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
1925
1926
1927 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
1928 Results::
1929
1930  status   Validation status and is of type STRING.
1931  errors   Validation messages and is of type JSON.
1932
1933
1934 Error::
1935
1936  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
1937
1938
1939
1940 [20] vsp-list
1941 -----------------------------------------------
1942
1943
1944 usage: onap vsp-list
1945
1946 List of the Vendor Software Products
1947
1948 Onap service: sdc v1.0
1949
1950 Options::
1951
1952  [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
1953  [-h | --help] [-v | --version] [-d | --debug]
1954  [-f | --format] [-s | --long] [-t | --no-title]
1955  [-a | --no-auth]
1956
1957 where::
1958
1959  -u | --onap-username   Onap user name. It is of type STRING. By default,
1960                         it is read from environment variable
1961                         OPEN_USERNAME.
1962  -p | --onap-password   Onap user password. It is of type STRING. By
1963                         default, it is read from environment variable
1964                         OPEN_PASSWORD. Secured.
1965  -m | --host-url        Onap host url. It is of type URL. By default, it
1966                         is read from environment variable OPEN_HOST_URL.
1967  -h | --help            Onap command help message. It is of type STRING.
1968                         By default, it is false.
1969  -v | --version         Onap command service version. It is of type
1970                         STRING. By default, it is false.
1971  -d | --debug           Enable debug output. It is of type BOOL. By
1972                         default, it is false.
1973  -f | --format          Output formats, supported formats such as table,
1974                         csv, json, yaml. It is of type STRING. By
1975                         default, it is table.
1976  -s | --long            whether to print all attributes or only short
1977                         attributes. It is of type BOOL. By default, it is
1978                         false.
1979  -t | --no-title        whether to print title or not. It is of type
1980                         BOOL. By default, it is false.
1981  -a | --no-auth         whether to authenticate user or not. It is of
1982                         type BOOL. By default, it is false.
1983
1984
1985 Results::
1986
1987  ID               VSP ID and is of type STRING.
1988  name             VSP Name and is of type STRING.
1989  vendor-name      Vendor name and is of type STRING.
1990  version          Version and is of type STRING.
1991  status           status and is of type STRING.
1992  license-id       license aggreement and is of type STRING.
1993  license-version  license version and is of type STRING.
1994
1995
1996 Error::
1997
1998  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
1999
2000
2001
2002 [21] vsp-checkin
2003 -----------------------------------------------
2004
2005
2006 usage: onap vsp-checkin
2007
2008 Checkin Vendor Software Product
2009
2010 Onap service: sdc v1.0
2011
2012 Options::
2013
2014  [-x | --vsp-id] [-y | --vsp-version] [-u | --onap-username]
2015  [-p | --onap-password] [-m | --host-url] [-h | --help]
2016  [-v | --version] [-d | --debug] [-f | --format]
2017  [-s | --long] [-t | --no-title] [-a | --no-auth]
2018
2019 where::
2020
2021 <<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
2022  -x | --vsp-id          Onap VSP ID. It is of type STRING.
2023  -y | --vsp-version     VSP version. It is of type STRING.
2024 =======
2025  -x | --ems-id            Onap EMS unique id. It is of type UUID. By
2026                           default, it is
2027                           efba894e-20f4-4658-9d43-1f8736188d3d.
2028  -y | --resource-version  Onap vim resource version. It is of type STRING.
2029                           It is optional.
2030  -u | --onap-username     Onap user name. It is of type STRING. By default,
2031                           it is read from environment variable
2032                           OPEN_USERNAME.
2033  -p | --onap-password     Onap user password. It is of type STRING. By
2034                           default, it is read from environment variable
2035                           OPEN_PASSWORD. Secured.
2036  -m | --host-url          Onap host url. It is of type URL. By default, it
2037                           is read from environment variable OPEN_HOST_URL.
2038  -h | --help              Onap command help message. It is of type STRING.
2039                           By default, it is false.
2040  -v | --version           Onap command service version. It is of type
2041                           STRING. By default, it is false.
2042  -d | --debug             Enable debug output. It is of type BOOL. By
2043                           default, it is false.
2044  -f | --format            Output formats, supported formats such as table,
2045                           csv, json, yaml. It is of type STRING. By
2046                           default, it is table.
2047  -s | --long              whether to print all attributes or only short
2048                           attributes. It is of type BOOL. By default, it is
2049                           false.
2050  -t | --no-title          whether to print title or not. It is of type
2051                           BOOL. By default, it is false.
2052  -a | --no-auth           whether to authenticate user or not. It is of
2053                           type BOOL. By default, it is false.
2054
2055
2056 Error::
2057
2058  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
2059
2060
2061
2062 sdnc-register
2063 -----------------------------------------------
2064
2065
2066 usage: onap sdnc-register
2067
2068 Register a SDNC in Onap
2069
2070 Onap service: aai v11
2071
2072 Options::
2073
2074  [-x | --location] [-y | --sdnc-id] [-b | --name]
2075  [-c | --type] [-e | --vendor] [-q | --sdnc-version]
2076  [-g | --ip-address] [-k | --port] [-r | --protocal]
2077  [-i | --username] [-j | --password] [-z | --product-name]
2078  [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
2079  [-h | --help] [-v | --version] [-d | --debug]
2080  [-f | --format] [-s | --long] [-t | --no-title]
2081  [-a | --no-auth]
2082
2083 where::
2084
2085  -x | --location        Onap VIM unique id. It is of type UUID. By
2086                         default, it is
2087                         0f283039-a3fd-4fe1-ac14-b8cdb3a20b26.
2088  -y | --sdnc-id         Onap SDNC unique id. It is of type UUID. By
2089                         default, it is
2090                         b112c385-90ad-4eb7-ae6d-1f263925e97e.
2091  -b | --name            Onap SDNC name. It is of type STRING.
2092  -c | --type            Onap SDNC type. It is of type STRING.
2093  -e | --vendor          Onap SDNC vendor. It is of type STRING.
2094  -q | --sdnc-version    Onap SDNC version. It is of type STRING.
2095  -g | --ip-address      Onap SDNC ip address. It is of type STRING.
2096  -k | --port            Onap SDNC port. It is of type STRING.
2097  -r | --protocal        Onap SDNC protocal. It is of type STRING.
2098  -i | --username        Onap SDNC username. It is of type STRING.
2099  -j | --password        Onap SDNC password. It is of type STRING.
2100  -z | --product-name    Onap SDNC product-name. It is of type STRING.
2101 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
2102  -u | --onap-username   Onap user name. It is of type STRING. By default,
2103                         it is read from environment variable
2104                         OPEN_USERNAME.
2105  -p | --onap-password   Onap user password. It is of type STRING. By
2106                         default, it is read from environment variable
2107                         OPEN_PASSWORD. Secured.
2108  -m | --host-url        Onap host url. It is of type URL. By default, it
2109                         is read from environment variable OPEN_HOST_URL.
2110  -h | --help            Onap command help message. It is of type STRING.
2111                         By default, it is false.
2112  -v | --version         Onap command service version. It is of type
2113                         STRING. By default, it is false.
2114  -d | --debug           Enable debug output. It is of type BOOL. By
2115                         default, it is false.
2116  -f | --format          Output formats, supported formats such as table,
2117                         csv, json, yaml. It is of type STRING. By
2118                         default, it is table.
2119  -s | --long            whether to print all attributes or only short
2120                         attributes. It is of type BOOL. By default, it is
2121                         false.
2122  -t | --no-title        whether to print title or not. It is of type
2123                         BOOL. By default, it is false.
2124  -a | --no-auth         whether to authenticate user or not. It is of
2125                         type BOOL. By default, it is false.
2126
2127
2128 Error::
2129
2130  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
2131
2132
2133
2134 [22] service-model-checkin
2135 -----------------------------------------------
2136
2137
2138 usage: onap service-model-checkin
2139
2140 Checkin Service model in SDC
2141
2142 Onap service: sdc v1.0
2143
2144 Options::
2145
2146  [-b | --service-model-id] [-u | --onap-username] [-p | --onap-password]
2147  [-m | --host-url] [-h | --help] [-v | --version]
2148  [-d | --debug] [-f | --format] [-s | --long]
2149  [-t | --no-title] [-a | --no-auth]
2150
2151 where::
2152
2153 <<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
2154  -b | --service-model-id  Service model ID. It is of type STRING. It is
2155                           optional.
2156  -u | --onap-username     Onap user name. It is of type STRING. By default,
2157                           it is read from environment variable
2158                           ONAP_USERNAME.
2159  -p | --onap-password     Onap user password. It is of type STRING. By
2160                           default, it is read from environment variable
2161                           ONAP_PASSWORD. Secured.
2162  -m | --host-url          Onap host url. It is of type URL. By default, it
2163                           is read from environment variable ONAP_HOST_URL.
2164  -h | --help              Onap command help message. It is of type STRING.
2165                           By default, it is false.
2166  -v | --version           Onap command service version. It is of type
2167                           STRING. By default, it is false.
2168  -d | --debug             Enable debug output. It is of type BOOL. By
2169                           default, it is false.
2170  -f | --format            Output formats, supported formats such as table,
2171                           csv, json, yaml. It is of type STRING. By
2172                           default, it is table.
2173  -s | --long              whether to print all attributes or only short
2174                           attributes. It is of type BOOL. By default, it is
2175                           false.
2176  -t | --no-title          whether to print title or not. It is of type
2177                           BOOL. By default, it is false.
2178  -a | --no-auth           whether to authenticate user or not. It is of
2179                           type BOOL. By default, it is false.
2180 =======
2181  -x | --vsp-id          Onap VSP ID. It is of type STRING.
2182  -y | --vsp-version     VSP version. It is of type STRING.
2183  -u | --onap-username   Onap user name. It is of type STRING. By default,
2184                         it is read from environment variable
2185                         OPEN_USERNAME.
2186  -p | --onap-password   Onap user password. It is of type STRING. By
2187                         default, it is read from environment variable
2188                         OPEN_PASSWORD. Secured.
2189  -m | --host-url        Onap host url. It is of type URL. By default, it
2190                         is read from environment variable OPEN_HOST_URL.
2191  -h | --help            Onap command help message. It is of type STRING.
2192                         By default, it is false.
2193  -v | --version         Onap command service version. It is of type
2194                         STRING. By default, it is false.
2195  -d | --debug           Enable debug output. It is of type BOOL. By
2196                         default, it is false.
2197  -f | --format          Output formats, supported formats such as table,
2198                         csv, json, yaml. It is of type STRING. By
2199                         default, it is table.
2200  -s | --long            whether to print all attributes or only short
2201                         attributes. It is of type BOOL. By default, it is
2202                         false.
2203  -t | --no-title        whether to print title or not. It is of type
2204                         BOOL. By default, it is false.
2205  -a | --no-auth         whether to authenticate user or not. It is of
2206                         type BOOL. By default, it is false.
2207
2208
2209 Error::
2210
2211  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
2212
2213
2214
2215 [28] vsp-show
2216 -----------------------------------------------
2217
2218
2219 usage: onap vsp-show
2220
2221 Details of the Vendor Software Product
2222
2223 Onap service: sdc v1.0
2224
2225 Options::
2226
2227  [-x | --vsp-id] [-y | --vsp-version] [-u | --onap-username]
2228  [-p | --onap-password] [-m | --host-url] [-h | --help]
2229  [-v | --version] [-d | --debug] [-f | --format]
2230  [-s | --long] [-t | --no-title] [-a | --no-auth]
2231
2232 where::
2233
2234  -x | --vsp-id          Onap VSP ID. It is of type STRING.
2235  -y | --vsp-version     Onap VSP version. It is of type STRING.
2236  -u | --onap-username   Onap user name. It is of type STRING. By default,
2237                         it is read from environment variable
2238                         OPEN_USERNAME.
2239  -p | --onap-password   Onap user password. It is of type STRING. By
2240                         default, it is read from environment variable
2241                         OPEN_PASSWORD. Secured.
2242  -m | --host-url        Onap host url. It is of type URL. By default, it
2243                         is read from environment variable OPEN_HOST_URL.
2244  -h | --help            Onap command help message. It is of type STRING.
2245                         By default, it is false.
2246  -v | --version         Onap command service version. It is of type
2247                         STRING. By default, it is false.
2248  -d | --debug           Enable debug output. It is of type BOOL. By
2249                         default, it is false.
2250  -f | --format          Output formats, supported formats such as table,
2251                         csv, json, yaml. It is of type STRING. By
2252                         default, it is table.
2253  -s | --long            whether to print all attributes or only short
2254                         attributes. It is of type BOOL. By default, it is
2255                         false.
2256  -t | --no-title        whether to print title or not. It is of type
2257                         BOOL. By default, it is false.
2258  -a | --no-auth         whether to authenticate user or not. It is of
2259                         type BOOL. By default, it is false.
2260
2261
2262 Results::
2263
2264  name         VSP Name and is of type STRING.
2265  ID           VSP ID and is of type STRING.
2266  description  Description for the VSP and is of type STRING.
2267  vendor-name  Vendor name and is of type STRING.
2268  vendor-id    Vendor id and is of type STRING.
2269  version      Version and is of type STRING.
2270  status       status and is of type STRING.
2271  license-id   license aggreement and is of type STRING.
2272 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
2273
2274
2275 Error::
2276
2277  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
2278
2279
2280
2281 [23] service-model-distribute
2282 -----------------------------------------------
2283
2284
2285 usage: onap service-model-distribute
2286
2287 Distributes the Service model in SDC
2288
2289 Onap service: sdc v1.0
2290
2291 Options::
2292
2293  [-b | --service-model-id] [-u | --onap-username] [-p | --onap-password]
2294  [-m | --host-url] [-h | --help] [-v | --version]
2295  [-d | --debug] [-f | --format] [-s | --long]
2296  [-t | --no-title] [-a | --no-auth]
2297
2298 where::
2299
2300 <<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
2301  -b | --service-model-id  Service model ID. It is of type STRING. It is
2302                           optional.
2303  -u | --onap-username     Onap user name. It is of type STRING. By default,
2304                           it is read from environment variable
2305                           ONAP_USERNAME.
2306  -p | --onap-password     Onap user password. It is of type STRING. By
2307                           default, it is read from environment variable
2308                           ONAP_PASSWORD. Secured.
2309  -m | --host-url          Onap host url. It is of type URL. By default, it
2310                           is read from environment variable ONAP_HOST_URL.
2311 =======
2312 <<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
2313  -x | --vsp-id          Onap VSP ID. It is of type STRING.
2314  -y | --vsp-version     VSP version. It is of type STRING.
2315  -u | --onap-username   Onap user name. It is of type STRING. By default,
2316                         it is read from environment variable
2317                         ONAP_USERNAME.
2318  -p | --onap-password   Onap user password. It is of type STRING. By
2319                         default, it is read from environment variable
2320                         ONAP_PASSWORD. Secured.
2321  -m | --host-url        Onap host url. It is of type URL. By default, it
2322                         is read from environment variable ONAP_HOST_URL.
2323  -h | --help            Onap command help message. It is of type STRING.
2324                         By default, it is false.
2325  -v | --version         Onap command service version. It is of type
2326                         STRING. By default, it is false.
2327  -d | --debug           Enable debug output. It is of type BOOL. By
2328                         default, it is false.
2329  -f | --format          Output formats, supported formats such as table,
2330                         csv, json, yaml. It is of type STRING. By
2331                         default, it is table.
2332  -s | --long            whether to print all attributes or only short
2333                         attributes. It is of type BOOL. By default, it is
2334                         false.
2335  -t | --no-title        whether to print title or not. It is of type
2336                         BOOL. By default, it is false.
2337  -a | --no-auth         whether to authenticate user or not. It is of
2338                         type BOOL. By default, it is false.
2339 =======
2340  -x | --vnfm-id           Onap VNFM unique id. It is of type UUID. By
2341                           default, it is
2342                           d8a2726f-18a6-4bb1-904f-554a3fb70865.
2343  -y | --resource-version  Onap vim resource version. It is of type STRING.
2344                           It is optional.
2345  -u | --onap-username     Onap user name. It is of type STRING. By default,
2346                           it is read from environment variable
2347                           OPEN_USERNAME.
2348  -p | --onap-password     Onap user password. It is of type STRING. By
2349                           default, it is read from environment variable
2350                           OPEN_PASSWORD. Secured.
2351  -m | --host-url          Onap host url. It is of type URL. By default, it
2352                           is read from environment variable OPEN_HOST_URL.
2353 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
2354  -h | --help              Onap command help message. It is of type STRING.
2355                           By default, it is false.
2356  -v | --version           Onap command service version. It is of type
2357                           STRING. By default, it is false.
2358  -d | --debug             Enable debug output. It is of type BOOL. By
2359                           default, it is false.
2360  -f | --format            Output formats, supported formats such as table,
2361                           csv, json, yaml. It is of type STRING. By
2362                           default, it is table.
2363  -s | --long              whether to print all attributes or only short
2364                           attributes. It is of type BOOL. By default, it is
2365                           false.
2366  -t | --no-title          whether to print title or not. It is of type
2367                           BOOL. By default, it is false.
2368  -a | --no-auth           whether to authenticate user or not. It is of
2369                           type BOOL. By default, it is false.
2370 <<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
2371 =======
2372 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
2373 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
2374
2375
2376 Error::
2377
2378  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
2379
2380
2381
2382 [24] service-model-list
2383 -----------------------------------------------
2384
2385
2386 usage: onap service-model-list
2387
2388 List the service model in SDC
2389
2390 Onap service: sdc v1.0
2391
2392 Options::
2393
2394  [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
2395  [-h | --help] [-v | --version] [-d | --debug]
2396  [-f | --format] [-s | --long] [-t | --no-title]
2397  [-a | --no-auth]
2398
2399 where::
2400
2401  -u | --onap-username   Onap user name. It is of type STRING. By default,
2402                         it is read from environment variable
2403                         OPEN_USERNAME.
2404  -p | --onap-password   Onap user password. It is of type STRING. By
2405                         default, it is read from environment variable
2406                         OPEN_PASSWORD. Secured.
2407  -m | --host-url        Onap host url. It is of type URL. By default, it
2408                         is read from environment variable OPEN_HOST_URL.
2409  -h | --help            Onap command help message. It is of type STRING.
2410                         By default, it is false.
2411  -v | --version         Onap command service version. It is of type
2412                         STRING. By default, it is false.
2413  -d | --debug           Enable debug output. It is of type BOOL. By
2414                         default, it is false.
2415  -f | --format          Output formats, supported formats such as table,
2416                         csv, json, yaml. It is of type STRING. By
2417                         default, it is table.
2418  -s | --long            whether to print all attributes or only short
2419                         attributes. It is of type BOOL. By default, it is
2420                         false.
2421  -t | --no-title        whether to print title or not. It is of type
2422                         BOOL. By default, it is false.
2423  -a | --no-auth         whether to authenticate user or not. It is of
2424                         type BOOL. By default, it is false.
2425
2426
2427 Results::
2428
2429  uuid                 UUID and is of type STRING.
2430  invariant-uuid       Invariant UUID and is of type STRING.
2431  name                 Name and is of type STRING.
2432  version              version and is of type STRING.
2433  status               status and is of type STRING.
2434  distribution-status  status and is of type STRING.
2435  description          description and is of type STRING.
2436
2437
2438 Error::
2439
2440  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
2441
2442
2443
2444 [25] service-model-certify-start
2445 -----------------------------------------------
2446
2447
2448 usage: onap service-model-certify-start
2449
2450 Starts the certification of Service model in SDC
2451
2452 Onap service: sdc v1.0
2453
2454 Options::
2455
2456  [-b | --service-model-id] [-u | --onap-username] [-p | --onap-password]
2457  [-m | --host-url] [-h | --help] [-v | --version]
2458  [-d | --debug] [-f | --format] [-s | --long]
2459  [-t | --no-title] [-a | --no-auth]
2460
2461 where::
2462
2463  -b | --service-model-id  Service model ID. It is of type STRING. It is
2464                           optional.
2465  -u | --onap-username     Onap user name. It is of type STRING. By default,
2466                           it is read from environment variable
2467                           OPEN_USERNAME.
2468  -p | --onap-password     Onap user password. It is of type STRING. By
2469                           default, it is read from environment variable
2470                           OPEN_PASSWORD. Secured.
2471  -m | --host-url          Onap host url. It is of type URL. By default, it
2472                           is read from environment variable OPEN_HOST_URL.
2473  -h | --help              Onap command help message. It is of type STRING.
2474                           By default, it is false.
2475  -v | --version           Onap command service version. It is of type
2476                           STRING. By default, it is false.
2477  -d | --debug             Enable debug output. It is of type BOOL. By
2478                           default, it is false.
2479  -f | --format            Output formats, supported formats such as table,
2480                           csv, json, yaml. It is of type STRING. By
2481                           default, it is table.
2482  -s | --long              whether to print all attributes or only short
2483                           attributes. It is of type BOOL. By default, it is
2484                           false.
2485  -t | --no-title          whether to print title or not. It is of type
2486                           BOOL. By default, it is false.
2487  -a | --no-auth           whether to authenticate user or not. It is of
2488                           type BOOL. By default, it is false.
2489
2490
2491 Error::
2492
2493  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
2494
2495
2496
2497 [26] service-model-add-vf
2498 -----------------------------------------------
2499
2500
2501 usage: onap service-model-add-vf
2502
2503 Helps to add VF into service models in SDC
2504
2505 Onap service: sdc v1.0
2506
2507 Options::
2508
2509  [-x | --service-model-id] [-y | --vf-id] [-z | --vf-name]
2510  [-b | --vf-version] [-u | --onap-username] [-p | --onap-password]
2511  [-m | --host-url] [-h | --help] [-v | --version]
2512  [-d | --debug] [-f | --format] [-s | --long]
2513  [-t | --no-title] [-a | --no-auth]
2514
2515 where::
2516
2517 <<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
2518  -x | --service-model-id  Onap Service Name. It is of type STRING.
2519  -y | --vf-id             VF ID. It is of type STRING. It is optional.
2520  -z | --vf-name           VF ID. It is of type STRING. It is optional.
2521  -b | --vf-version        VF version. It is of type STRING. It is optional.
2522 =======
2523 <<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
2524  -b | --service-model-id  Service model ID. It is of type STRING. It is
2525                           optional.
2526 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
2527  -u | --onap-username     Onap user name. It is of type STRING. By default,
2528                           it is read from environment variable
2529                           ONAP_USERNAME.
2530  -p | --onap-password     Onap user password. It is of type STRING. By
2531                           default, it is read from environment variable
2532                           ONAP_PASSWORD. Secured.
2533  -m | --host-url          Onap host url. It is of type URL. By default, it
2534                           is read from environment variable ONAP_HOST_URL.
2535  -h | --help              Onap command help message. It is of type STRING.
2536                           By default, it is false.
2537  -v | --version           Onap command service version. It is of type
2538                           STRING. By default, it is false.
2539  -d | --debug             Enable debug output. It is of type BOOL. By
2540                           default, it is false.
2541  -f | --format            Output formats, supported formats such as table,
2542                           csv, json, yaml. It is of type STRING. By
2543                           default, it is table.
2544  -s | --long              whether to print all attributes or only short
2545                           attributes. It is of type BOOL. By default, it is
2546                           false.
2547  -t | --no-title          whether to print title or not. It is of type
2548                           BOOL. By default, it is false.
2549  -a | --no-auth           whether to authenticate user or not. It is of
2550                           type BOOL. By default, it is false.
2551 =======
2552  -x | --customer-name   Onap customer name. It is of type STRING.
2553  -u | --onap-username   Onap user name. It is of type STRING. By default,
2554                         it is read from environment variable
2555                         OPEN_USERNAME.
2556  -p | --onap-password   Onap user password. It is of type STRING. By
2557                         default, it is read from environment variable
2558                         OPEN_PASSWORD. Secured.
2559  -m | --host-url        Onap host url. It is of type URL. By default, it
2560                         is read from environment variable OPEN_HOST_URL.
2561  -h | --help            Onap command help message. It is of type STRING.
2562                         By default, it is false.
2563  -v | --version         Onap command service version. It is of type
2564                         STRING. By default, it is false.
2565  -d | --debug           Enable debug output. It is of type BOOL. By
2566                         default, it is false.
2567  -f | --format          Output formats, supported formats such as table,
2568                         csv, json, yaml. It is of type STRING. By
2569                         default, it is table.
2570  -s | --long            whether to print all attributes or only short
2571                         attributes. It is of type BOOL. By default, it is
2572                         false.
2573  -t | --no-title        whether to print title or not. It is of type
2574                         BOOL. By default, it is false.
2575  -a | --no-auth         whether to authenticate user or not. It is of
2576                         type BOOL. By default, it is false.
2577
2578
2579 Results::
2580
2581  service-type       Onap service type and is of type STRING.
2582  resource-version   Onap subscription resource version and is of type
2583                     STRING.
2584  tenant             Onap tenant name and is of type STRING.
2585  region             Onap region name and is of type STRING.
2586  cloud              Onap cloud name and is of type STRING.
2587 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
2588
2589
2590 Results::
2591
2592  ID   Service ID and is of type STRING.
2593
2594
2595 Error::
2596
2597  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
2598
2599
2600
2601 [27] service-model-certify-request
2602 -----------------------------------------------
2603
2604
2605 usage: onap service-model-certify-request
2606
2607 Request the certification of Service model in SDC
2608
2609 Onap service: sdc v1.0
2610
2611 Options::
2612
2613  [-b | --service-model-id] [-u | --onap-username] [-p | --onap-password]
2614  [-m | --host-url] [-h | --help] [-v | --version]
2615  [-d | --debug] [-f | --format] [-s | --long]
2616  [-t | --no-title] [-a | --no-auth]
2617
2618 where::
2619
2620 <<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
2621  -b | --service-model-id  Service model ID. It is of type STRING. It is
2622                           optional.
2623  -u | --onap-username     Onap user name. It is of type STRING. By default,
2624                           it is read from environment variable
2625                           ONAP_USERNAME.
2626  -p | --onap-password     Onap user password. It is of type STRING. By
2627                           default, it is read from environment variable
2628                           ONAP_PASSWORD. Secured.
2629  -m | --host-url          Onap host url. It is of type URL. By default, it
2630                           is read from environment variable ONAP_HOST_URL.
2631  -h | --help              Onap command help message. It is of type STRING.
2632                           By default, it is false.
2633  -v | --version           Onap command service version. It is of type
2634                           STRING. By default, it is false.
2635  -d | --debug             Enable debug output. It is of type BOOL. By
2636                           default, it is false.
2637  -f | --format            Output formats, supported formats such as table,
2638                           csv, json, yaml. It is of type STRING. By
2639                           default, it is table.
2640  -s | --long              whether to print all attributes or only short
2641                           attributes. It is of type BOOL. By default, it is
2642                           false.
2643  -t | --no-title          whether to print title or not. It is of type
2644                           BOOL. By default, it is false.
2645  -a | --no-auth           whether to authenticate user or not. It is of
2646                           type BOOL. By default, it is false.
2647 =======
2648  -x | --cloud           Onap cloud. It is of type STRING.
2649  -y | --region          Onap cloud region. It is of type STRING.
2650  -z | --tenant-id       Onap cloud tenant id. It is of type STRING.
2651  -r | --tenant-name     Onap cloud tenant name. It is of type STRING.
2652  -u | --onap-username   Onap user name. It is of type STRING. By default,
2653                         it is read from environment variable
2654                         OPEN_USERNAME.
2655  -p | --onap-password   Onap user password. It is of type STRING. By
2656                         default, it is read from environment variable
2657                         OPEN_PASSWORD. Secured.
2658  -m | --host-url        Onap host url. It is of type URL. By default, it
2659                         is read from environment variable OPEN_HOST_URL.
2660  -h | --help            Onap command help message. It is of type STRING.
2661                         By default, it is false.
2662  -v | --version         Onap command service version. It is of type
2663                         STRING. By default, it is false.
2664  -d | --debug           Enable debug output. It is of type BOOL. By
2665                         default, it is false.
2666  -f | --format          Output formats, supported formats such as table,
2667                         csv, json, yaml. It is of type STRING. By
2668                         default, it is table.
2669  -s | --long            whether to print all attributes or only short
2670                         attributes. It is of type BOOL. By default, it is
2671                         false.
2672  -t | --no-title        whether to print title or not. It is of type
2673                         BOOL. By default, it is false.
2674  -a | --no-auth         whether to authenticate user or not. It is of
2675                         type BOOL. By default, it is false.
2676 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
2677
2678
2679 Error::
2680
2681  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
2682
2683
2684
2685 <<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
2686 [28] service-model-revert
2687 =======
2688 [34] service-model-create
2689 -----------------------------------------------
2690
2691
2692 usage: onap service-model-create
2693
2694 Create Service model in SDC
2695
2696 Onap service: sdc v1.0
2697
2698 Options::
2699
2700  [-x | --name] [-y | --description] [-z | --project-code]
2701  [-b | --category] [-c | --category-display-name] [-e | --icon-id]
2702  [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
2703  [-h | --help] [-v | --version] [-d | --debug]
2704  [-f | --format] [-s | --long] [-t | --no-title]
2705  [-a | --no-auth]
2706
2707 where::
2708
2709 <<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
2710  -x | --name                    Onap Service Name. It is of type STRING.
2711  -y | --description             Description for Service. It is of type STRING. It
2712                                 is optional.
2713  -z | --project-code            Project code. It is of type STRING. It is
2714                                 optional.
2715  -b | --category                Service category. It is of type STRING. It is
2716                                 optional. By default, it is network l1-3.
2717  -c | --category-display-name   Service category display name. It is of type
2718                                 STRING. It is optional. By default, it is Network
2719                                 L1-3.
2720  -e | --icon-id                 Service Icon id. It is of type STRING. It is
2721                                 optional. By default, it is defaulticon.
2722 =======
2723  -x | --service-instace-id  unique id for service instance. It is of type
2724                             STRING.
2725  -u | --onap-username       Onap user name. It is of type STRING. By default,
2726                             it is read from environment variable
2727                             OPEN_USERNAME.
2728  -p | --onap-password       Onap user password. It is of type STRING. By
2729                             default, it is read from environment variable
2730                             OPEN_PASSWORD. Secured.
2731  -m | --host-url            Onap host url. It is of type URL. By default, it
2732                             is read from environment variable OPEN_HOST_URL.
2733  -h | --help                Onap command help message. It is of type STRING.
2734                             By default, it is false.
2735  -v | --version             Onap command service version. It is of type
2736                             STRING. By default, it is false.
2737  -d | --debug               Enable debug output. It is of type BOOL. By
2738                             default, it is false.
2739  -f | --format              Output formats, supported formats such as table,
2740                             csv, json, yaml. It is of type STRING. By
2741                             default, it is table.
2742  -s | --long                whether to print all attributes or only short
2743                             attributes. It is of type BOOL. By default, it is
2744                             false.
2745  -t | --no-title            whether to print title or not. It is of type
2746                             BOOL. By default, it is false.
2747  -a | --no-auth             whether to authenticate user or not. It is of
2748                             type BOOL. By default, it is false.
2749
2750
2751 Error::
2752
2753  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
2754
2755
2756
2757 vnf-create
2758 -----------------------------------------------
2759
2760
2761 usage: onap vnf-create
2762
2763 Create a VNF
2764
2765 Onap service: mso v2
2766
2767 Options::
2768
2769  [-l | --lcp-cloudregion-id] [-z | --tenant-id] [-w | --product-family-id]
2770  [-i | --instance-name] [-r | --supress-rollback] [-y | --service-instance-id]
2771  [-x | --parenet-service-model] [-u | --onap-username] [-p | --onap-password]
2772  [-m | --host-url] [-h | --help] [-v | --version]
2773  [-d | --debug] [-f | --format] [-s | --long]
2774  [-t | --no-title] [-a | --no-auth]
2775
2776 where::
2777
2778  -l | --lcp-cloudregion-id      AIC LCP node location identifier. It is of type
2779                                 STRING.
2780  -z | --tenant-id               openstack tenant id (uuid). It is of type STRING.
2781  -w | --product-family-id       UUID for product family (named service id in
2782                                 AAI). It is of type STRING.
2783  -i | --instance-name           service instance name. It is of type STRING.
2784  -r | --supress-rollback        rollback changes if instantiation fails. It is of
2785                                 type BOOL. It is optional. By default, it is
2786                                 false.
2787  -y | --service-instance-id     unique id for service instance. It is of type
2788                                 STRING.
2789  -x | --parenet-service-model   parent service model name. It is of type STRING.
2790 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
2791  -u | --onap-username           Onap user name. It is of type STRING. By default,
2792                                 it is read from environment variable
2793                                 OPEN_USERNAME.
2794  -p | --onap-password           Onap user password. It is of type STRING. By
2795                                 default, it is read from environment variable
2796                                 OPEN_PASSWORD. Secured.
2797  -m | --host-url                Onap host url. It is of type URL. By default, it
2798                                 is read from environment variable OPEN_HOST_URL.
2799  -h | --help                    Onap command help message. It is of type STRING.
2800                                 By default, it is false.
2801  -v | --version                 Onap command service version. It is of type
2802                                 STRING. By default, it is false.
2803  -d | --debug                   Enable debug output. It is of type BOOL. By
2804                                 default, it is false.
2805  -f | --format                  Output formats, supported formats such as table,
2806                                 csv, json, yaml. It is of type STRING. By
2807                                 default, it is table.
2808  -s | --long                    whether to print all attributes or only short
2809                                 attributes. It is of type BOOL. By default, it is
2810                                 false.
2811  -t | --no-title                whether to print title or not. It is of type
2812                                 BOOL. By default, it is false.
2813  -a | --no-auth                 whether to authenticate user or not. It is of
2814                                 type BOOL. By default, it is false.
2815
2816
2817 Results::
2818
2819  ID   Service ID and is of type STRING.
2820
2821
2822 Error::
2823
2824  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
2825
2826
2827
2828 [35] service-model-distribute
2829 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
2830 -----------------------------------------------
2831
2832
2833 usage: onap service-model-revert
2834
2835 Checkout Service model in SDC
2836
2837 Onap service: sdc v1.0
2838
2839 Options::
2840
2841  [-b | --service-model-id] [-u | --onap-username] [-p | --onap-password]
2842  [-m | --host-url] [-h | --help] [-v | --version]
2843  [-d | --debug] [-f | --format] [-s | --long]
2844  [-t | --no-title] [-a | --no-auth]
2845
2846 where::
2847
2848 <<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
2849  -b | --service-model-id  Service model ID. It is of type STRING. It is
2850                           optional.
2851  -u | --onap-username     Onap user name. It is of type STRING. By default,
2852                           it is read from environment variable
2853                           ONAP_USERNAME.
2854  -p | --onap-password     Onap user password. It is of type STRING. By
2855                           default, it is read from environment variable
2856                           ONAP_PASSWORD. Secured.
2857  -m | --host-url          Onap host url. It is of type URL. By default, it
2858                           is read from environment variable ONAP_HOST_URL.
2859  -h | --help              Onap command help message. It is of type STRING.
2860                           By default, it is false.
2861  -v | --version           Onap command service version. It is of type
2862                           STRING. By default, it is false.
2863  -d | --debug             Enable debug output. It is of type BOOL. By
2864                           default, it is false.
2865  -f | --format            Output formats, supported formats such as table,
2866                           csv, json, yaml. It is of type STRING. By
2867                           default, it is table.
2868  -s | --long              whether to print all attributes or only short
2869                           attributes. It is of type BOOL. By default, it is
2870                           false.
2871  -t | --no-title          whether to print title or not. It is of type
2872                           BOOL. By default, it is false.
2873  -a | --no-auth           whether to authenticate user or not. It is of
2874                           type BOOL. By default, it is false.
2875 =======
2876  -x | --vnf-instace-id      id for vnf. It is of type STRING.
2877  -y | --service-instace-id  unique id for service instance. It is of type
2878                             STRING.
2879  -l | --lcp-cloudregion-id  AIC LCP node location identifier. It is of type
2880                             STRING.
2881  -z | --tenant-id           openstack tenant id (uuid). It is of type STRING.
2882  -u | --onap-username       Onap user name. It is of type STRING. By default,
2883                             it is read from environment variable
2884                             OPEN_USERNAME.
2885  -p | --onap-password       Onap user password. It is of type STRING. By
2886                             default, it is read from environment variable
2887                             OPEN_PASSWORD. Secured.
2888  -m | --host-url            Onap host url. It is of type URL. By default, it
2889                             is read from environment variable OPEN_HOST_URL.
2890  -h | --help                Onap command help message. It is of type STRING.
2891                             By default, it is false.
2892  -v | --version             Onap command service version. It is of type
2893                             STRING. By default, it is false.
2894  -d | --debug               Enable debug output. It is of type BOOL. By
2895                             default, it is false.
2896  -f | --format              Output formats, supported formats such as table,
2897                             csv, json, yaml. It is of type STRING. By
2898                             default, it is table.
2899  -s | --long                whether to print all attributes or only short
2900                             attributes. It is of type BOOL. By default, it is
2901                             false.
2902  -t | --no-title            whether to print title or not. It is of type
2903                             BOOL. By default, it is false.
2904  -a | --no-auth             whether to authenticate user or not. It is of
2905                             type BOOL. By default, it is false.
2906 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
2907
2908
2909 Error::
2910
2911  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
2912
2913
2914
2915 [29] service-model-checkout
2916 -----------------------------------------------
2917
2918
2919 usage: onap service-model-checkout
2920
2921 Checkout Service model in SDC
2922
2923 Onap service: sdc v1.0
2924
2925 Options::
2926
2927  [-b | --service-model-id] [-u | --onap-username] [-p | --onap-password]
2928  [-m | --host-url] [-h | --help] [-v | --version]
2929  [-d | --debug] [-f | --format] [-s | --long]
2930  [-t | --no-title] [-a | --no-auth]
2931
2932 where::
2933
2934 <<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
2935  -b | --service-model-id  Service model ID. It is of type STRING. It is
2936                           optional.
2937  -u | --onap-username     Onap user name. It is of type STRING. By default,
2938                           it is read from environment variable
2939                           ONAP_USERNAME.
2940  -p | --onap-password     Onap user password. It is of type STRING. By
2941                           default, it is read from environment variable
2942                           ONAP_PASSWORD. Secured.
2943  -m | --host-url          Onap host url. It is of type URL. By default, it
2944                           is read from environment variable ONAP_HOST_URL.
2945  -h | --help              Onap command help message. It is of type STRING.
2946                           By default, it is false.
2947  -v | --version           Onap command service version. It is of type
2948                           STRING. By default, it is false.
2949  -d | --debug             Enable debug output. It is of type BOOL. By
2950                           default, it is false.
2951  -f | --format            Output formats, supported formats such as table,
2952                           csv, json, yaml. It is of type STRING. By
2953                           default, it is table.
2954  -s | --long              whether to print all attributes or only short
2955                           attributes. It is of type BOOL. By default, it is
2956                           false.
2957  -t | --no-title          whether to print title or not. It is of type
2958                           BOOL. By default, it is false.
2959  -a | --no-auth           whether to authenticate user or not. It is of
2960                           type BOOL. By default, it is false.
2961
2962
2963 Error::
2964
2965  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
2966
2967
2968
2969 [30] service-model-certify-complete
2970 -----------------------------------------------
2971
2972
2973 usage: onap service-model-certify-complete
2974
2975 Completes the certification of Service model in SDC
2976
2977 Onap service: sdc v1.0
2978
2979 Options::
2980
2981  [-b | --service-model-id] [-u | --onap-username] [-p | --onap-password]
2982  [-m | --host-url] [-h | --help] [-v | --version]
2983  [-d | --debug] [-f | --format] [-s | --long]
2984  [-t | --no-title] [-a | --no-auth]
2985
2986 where::
2987
2988  -b | --service-model-id  Service model ID. It is of type STRING. It is
2989                           optional.
2990  -u | --onap-username     Onap user name. It is of type STRING. By default,
2991                           it is read from environment variable
2992                           ONAP_USERNAME.
2993  -p | --onap-password     Onap user password. It is of type STRING. By
2994                           default, it is read from environment variable
2995                           ONAP_PASSWORD. Secured.
2996  -m | --host-url          Onap host url. It is of type URL. By default, it
2997                           is read from environment variable ONAP_HOST_URL.
2998  -h | --help              Onap command help message. It is of type STRING.
2999                           By default, it is false.
3000  -v | --version           Onap command service version. It is of type
3001                           STRING. By default, it is false.
3002  -d | --debug             Enable debug output. It is of type BOOL. By
3003                           default, it is false.
3004  -f | --format            Output formats, supported formats such as table,
3005                           csv, json, yaml. It is of type STRING. By
3006                           default, it is table.
3007  -s | --long              whether to print all attributes or only short
3008                           attributes. It is of type BOOL. By default, it is
3009                           false.
3010  -t | --no-title          whether to print title or not. It is of type
3011                           BOOL. By default, it is false.
3012  -a | --no-auth           whether to authenticate user or not. It is of
3013                           type BOOL. By default, it is false.
3014
3015
3016 Error::
3017
3018  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
3019
3020
3021
3022 [31] service2vf-model-list
3023 -----------------------------------------------
3024
3025
3026 usage: onap service2vf-model-list
3027
3028 List the VF in a given service model in SDC
3029
3030 Onap service: sdc v1.0
3031
3032 Options::
3033
3034  [-z | --service-model-id] [-u | --onap-username] [-p | --onap-password]
3035  [-m | --host-url] [-h | --help] [-v | --version]
3036  [-d | --debug] [-f | --format] [-s | --long]
3037  [-t | --no-title] [-a | --no-auth]
3038
3039 where::
3040
3041 =======
3042 <<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
3043 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
3044  -z | --service-model-id  Service model uuid. It is of type STRING.
3045  -u | --onap-username     Onap user name. It is of type STRING. By default,
3046                           it is read from environment variable
3047                           ONAP_USERNAME.
3048  -p | --onap-password     Onap user password. It is of type STRING. By
3049                           default, it is read from environment variable
3050                           ONAP_PASSWORD. Secured.
3051  -m | --host-url          Onap host url. It is of type URL. By default, it
3052                           is read from environment variable ONAP_HOST_URL.
3053  -h | --help              Onap command help message. It is of type STRING.
3054                           By default, it is false.
3055  -v | --version           Onap command service version. It is of type
3056                           STRING. By default, it is false.
3057  -d | --debug             Enable debug output. It is of type BOOL. By
3058                           default, it is false.
3059  -f | --format            Output formats, supported formats such as table,
3060                           csv, json, yaml. It is of type STRING. By
3061                           default, it is table.
3062  -s | --long              whether to print all attributes or only short
3063                           attributes. It is of type BOOL. By default, it is
3064                           false.
3065  -t | --no-title          whether to print title or not. It is of type
3066                           BOOL. By default, it is false.
3067  -a | --no-auth           whether to authenticate user or not. It is of
3068                           type BOOL. By default, it is false.
3069
3070
3071 Results::
3072
3073  vf-uuid                UUID and is of type STRING.
3074  vf-name                name and is of type STRING.
3075  vf-customization-uuid  customization UUID and is of type STRING.
3076  vf-version             version and is of type STRING.
3077 =======
3078  -c | --global-subscriber-id  unique id for customer. It is of type STRING.
3079  -b | --subscriber-name       subscriber name. It is of type STRING. It is
3080                               optional.
3081  -i | --instance-name         service instance name. It is of type STRING.
3082  -r | --supress-rollback      rollback changes if instantiation fails. It is of
3083                               type BOOL. It is optional. By default, it is
3084                               false.
3085  -u | --onap-username         Onap user name. It is of type STRING. By default,
3086                               it is read from environment variable
3087                               OPEN_USERNAME.
3088  -p | --onap-password         Onap user password. It is of type STRING. By
3089                               default, it is read from environment variable
3090                               OPEN_PASSWORD. Secured.
3091  -m | --host-url              Onap host url. It is of type URL. By default, it
3092                               is read from environment variable OPEN_HOST_URL.
3093  -h | --help                  Onap command help message. It is of type STRING.
3094                               By default, it is false.
3095  -v | --version               Onap command service version. It is of type
3096                               STRING. By default, it is false.
3097  -d | --debug                 Enable debug output. It is of type BOOL. By
3098                               default, it is false.
3099  -f | --format                Output formats, supported formats such as table,
3100                               csv, json, yaml. It is of type STRING. By
3101                               default, it is table.
3102  -s | --long                  whether to print all attributes or only short
3103                               attributes. It is of type BOOL. By default, it is
3104                               false.
3105  -t | --no-title              whether to print title or not. It is of type
3106                               BOOL. By default, it is false.
3107  -a | --no-auth               whether to authenticate user or not. It is of
3108                               type BOOL. By default, it is false.
3109 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
3110
3111
3112 Error::
3113
3114  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
3115
3116
3117
3118 [32] service-model-create
3119 -----------------------------------------------
3120
3121
3122 usage: onap service-model-create
3123
3124 Create Service model in SDC
3125
3126 Onap service: sdc v1.0
3127
3128 Options::
3129
3130  [-x | --name] [-y | --description] [-z | --project-code]
3131  [-b | --category] [-c | --category-display-name] [-e | --icon-id]
3132  [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
3133  [-h | --help] [-v | --version] [-d | --debug]
3134  [-f | --format] [-s | --long] [-t | --no-title]
3135  [-a | --no-auth]
3136
3137 where::
3138
3139  -x | --name                    Onap Service Name. It is of type STRING.
3140  -y | --description             Description for Service. It is of type STRING. It
3141                                 is optional.
3142  -z | --project-code            Project code. It is of type STRING. It is
3143                                 optional.
3144  -b | --category                Service category. It is of type STRING. It is
3145                                 optional. By default, it is network l1-3.
3146  -c | --category-display-name   Service category display name. It is of type
3147                                 STRING. It is optional. By default, it is Network
3148                                 L1-3.
3149  -e | --icon-id                 Service Icon id. It is of type STRING. It is
3150                                 optional. By default, it is defaulticon.
3151  -u | --onap-username           Onap user name. It is of type STRING. By default,
3152                                 it is read from environment variable
3153                                 ONAP_USERNAME.
3154  -p | --onap-password           Onap user password. It is of type STRING. By
3155                                 default, it is read from environment variable
3156                                 ONAP_PASSWORD. Secured.
3157  -m | --host-url                Onap host url. It is of type URL. By default, it
3158                                 is read from environment variable ONAP_HOST_URL.
3159  -h | --help                    Onap command help message. It is of type STRING.
3160                                 By default, it is false.
3161  -v | --version                 Onap command service version. It is of type
3162                                 STRING. By default, it is false.
3163  -d | --debug                   Enable debug output. It is of type BOOL. By
3164                                 default, it is false.
3165  -f | --format                  Output formats, supported formats such as table,
3166                                 csv, json, yaml. It is of type STRING. By
3167                                 default, it is table.
3168  -s | --long                    whether to print all attributes or only short
3169                                 attributes. It is of type BOOL. By default, it is
3170                                 false.
3171  -t | --no-title                whether to print title or not. It is of type
3172                                 BOOL. By default, it is false.
3173  -a | --no-auth                 whether to authenticate user or not. It is of
3174                                 type BOOL. By default, it is false.
3175
3176
3177 Results::
3178
3179  ID   Service ID and is of type STRING.
3180
3181
3182 Error::
3183
3184  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
3185
3186
3187
3188 [33] service-model-approve
3189 -----------------------------------------------
3190
3191
3192 usage: onap service-model-approve
3193
3194 Approves the Service model in SDC
3195
3196 Onap service: sdc v1.0
3197
3198 Options::
3199
3200  [-b | --service-model-id] [-u | --onap-username] [-p | --onap-password]
3201  [-m | --host-url] [-h | --help] [-v | --version]
3202  [-d | --debug] [-f | --format] [-s | --long]
3203  [-t | --no-title] [-a | --no-auth]
3204
3205 where::
3206
3207 <<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
3208  -b | --service-model-id  Service model ID. It is of type STRING. It is
3209                           optional.
3210  -u | --onap-username     Onap user name. It is of type STRING. By default,
3211                           it is read from environment variable
3212                           ONAP_USERNAME.
3213  -p | --onap-password     Onap user password. It is of type STRING. By
3214                           default, it is read from environment variable
3215                           ONAP_PASSWORD. Secured.
3216  -m | --host-url          Onap host url. It is of type URL. By default, it
3217                           is read from environment variable ONAP_HOST_URL.
3218  -h | --help              Onap command help message. It is of type STRING.
3219                           By default, it is false.
3220  -v | --version           Onap command service version. It is of type
3221                           STRING. By default, it is false.
3222  -d | --debug             Enable debug output. It is of type BOOL. By
3223                           default, it is false.
3224  -f | --format            Output formats, supported formats such as table,
3225                           csv, json, yaml. It is of type STRING. By
3226                           default, it is table.
3227  -s | --long              whether to print all attributes or only short
3228                           attributes. It is of type BOOL. By default, it is
3229                           false.
3230  -t | --no-title          whether to print title or not. It is of type
3231                           BOOL. By default, it is false.
3232  -a | --no-auth           whether to authenticate user or not. It is of
3233                           type BOOL. By default, it is false.
3234
3235
3236 Error::
3237
3238  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
3239
3240
3241
3242 [34] vf-model-create
3243 -----------------------------------------------
3244
3245
3246 usage: onap vf-model-create
3247
3248 Create Virtual function from Vendor Software Product
3249
3250 Onap service: sdc v1.0
3251
3252 Options::
3253
3254  [-x | --name] [-y | --description] [-z | --vendor-name]
3255  [-b | --vsp-id] [-g | --vsp-version] [-u | --onap-username]
3256  [-p | --onap-password] [-m | --host-url] [-h | --help]
3257  [-v | --version] [-d | --debug] [-f | --format]
3258  [-s | --long] [-t | --no-title] [-a | --no-auth]
3259
3260 where::
3261
3262  -x | --name            Onap VF Name. It is of type STRING.
3263  -y | --description     Description for VF. It is of type STRING. It is
3264                         optional.
3265  -z | --vendor-name     Vendor name. It is of type STRING. It is optional.
3266  -b | --vsp-id          VSP ID. It is of type STRING. It is optional.
3267  -g | --vsp-version     VSP version. It is of type STRING. It is optional.
3268 =======
3269 <<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
3270  -b | --vf-id           VF ID. It is of type STRING. It is optional.
3271 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
3272  -u | --onap-username   Onap user name. It is of type STRING. By default,
3273                         it is read from environment variable
3274                         ONAP_USERNAME.
3275  -p | --onap-password   Onap user password. It is of type STRING. By
3276                         default, it is read from environment variable
3277                         ONAP_PASSWORD. Secured.
3278  -m | --host-url        Onap host url. It is of type URL. By default, it
3279                         is read from environment variable ONAP_HOST_URL.
3280  -h | --help            Onap command help message. It is of type STRING.
3281                         By default, it is false.
3282  -v | --version         Onap command service version. It is of type
3283                         STRING. By default, it is false.
3284  -d | --debug           Enable debug output. It is of type BOOL. By
3285                         default, it is false.
3286  -f | --format          Output formats, supported formats such as table,
3287                         csv, json, yaml. It is of type STRING. By
3288                         default, it is table.
3289  -s | --long            whether to print all attributes or only short
3290                         attributes. It is of type BOOL. By default, it is
3291                         false.
3292  -t | --no-title        whether to print title or not. It is of type
3293                         BOOL. By default, it is false.
3294  -a | --no-auth         whether to authenticate user or not. It is of
3295                         type BOOL. By default, it is false.
3296 =======
3297  -x | --vnf-instace-id      id for vnf. It is of type STRING.
3298  -y | --service-instace-id  unique id for service instance. It is of type
3299                             STRING.
3300  -w | --vf-module-id        vf module id. It is of type STRING.
3301  -l | --lcp-cloudregion-id  AIC LCP node location identifier. It is of type
3302                             STRING.
3303  -z | --tenant-id           openstack tenant id (uuid). It is of type STRING.
3304  -u | --onap-username       Onap user name. It is of type STRING. By default,
3305                             it is read from environment variable
3306                             OPEN_USERNAME.
3307  -p | --onap-password       Onap user password. It is of type STRING. By
3308                             default, it is read from environment variable
3309                             OPEN_PASSWORD. Secured.
3310  -m | --host-url            Onap host url. It is of type URL. By default, it
3311                             is read from environment variable OPEN_HOST_URL.
3312  -h | --help                Onap command help message. It is of type STRING.
3313                             By default, it is false.
3314  -v | --version             Onap command service version. It is of type
3315                             STRING. By default, it is false.
3316  -d | --debug               Enable debug output. It is of type BOOL. By
3317                             default, it is false.
3318  -f | --format              Output formats, supported formats such as table,
3319                             csv, json, yaml. It is of type STRING. By
3320                             default, it is table.
3321  -s | --long                whether to print all attributes or only short
3322                             attributes. It is of type BOOL. By default, it is
3323                             false.
3324  -t | --no-title            whether to print title or not. It is of type
3325                             BOOL. By default, it is false.
3326  -a | --no-auth             whether to authenticate user or not. It is of
3327                             type BOOL. By default, it is false.
3328 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
3329
3330
3331 Results::
3332
3333  ID   VF ID and is of type STRING.
3334
3335
3336 Error::
3337
3338  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
3339
3340
3341
3342 [35] vf-model-checkin
3343 -----------------------------------------------
3344
3345
3346 usage: onap vf-model-checkin
3347
3348 Checkin Virtual function
3349
3350 Onap service: sdc v1.0
3351
3352 Options::
3353
3354  [-b | --vf-id] [-u | --onap-username] [-p | --onap-password]
3355  [-m | --host-url] [-h | --help] [-v | --version]
3356  [-d | --debug] [-f | --format] [-s | --long]
3357  [-t | --no-title] [-a | --no-auth]
3358
3359 where::
3360
3361 <<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
3362  -b | --vf-id           VF ID. It is of type STRING. It is optional.
3363  -u | --onap-username   Onap user name. It is of type STRING. By default,
3364                         it is read from environment variable
3365                         ONAP_USERNAME.
3366  -p | --onap-password   Onap user password. It is of type STRING. By
3367                         default, it is read from environment variable
3368                         ONAP_PASSWORD. Secured.
3369  -m | --host-url        Onap host url. It is of type URL. By default, it
3370                         is read from environment variable ONAP_HOST_URL.
3371  -h | --help            Onap command help message. It is of type STRING.
3372                         By default, it is false.
3373  -v | --version         Onap command service version. It is of type
3374                         STRING. By default, it is false.
3375  -d | --debug           Enable debug output. It is of type BOOL. By
3376                         default, it is false.
3377  -f | --format          Output formats, supported formats such as table,
3378                         csv, json, yaml. It is of type STRING. By
3379                         default, it is table.
3380  -s | --long            whether to print all attributes or only short
3381                         attributes. It is of type BOOL. By default, it is
3382                         false.
3383  -t | --no-title        whether to print title or not. It is of type
3384                         BOOL. By default, it is false.
3385  -a | --no-auth         whether to authenticate user or not. It is of
3386                         type BOOL. By default, it is false.
3387 =======
3388  -l | --lcp-cloudregion-id      AIC LCP node location identifier. It is of type
3389                                 STRING.
3390  -w | --tenant-id               openstack tenant id (uuid). It is of type STRING.
3391  -y | --vnf-instace-id          vnf instance id. It is of type STRING.
3392  -x | --service-instace-id      unique id for service instance. It is of type
3393                                 STRING.
3394  -z | --parenet-service-model   parent service model name. It is of type STRING.
3395  -r | --supress-rollback        rollback changes if instantiation fails. It is of
3396                                 type BOOL. It is optional. By default, it is
3397                                 false.
3398  -i | --instance-name           service instance name. It is of type STRING.
3399  -u | --onap-username           Onap user name. It is of type STRING. By default,
3400                                 it is read from environment variable
3401                                 OPEN_USERNAME.
3402  -p | --onap-password           Onap user password. It is of type STRING. By
3403                                 default, it is read from environment variable
3404                                 OPEN_PASSWORD. Secured.
3405  -m | --host-url                Onap host url. It is of type URL. By default, it
3406                                 is read from environment variable OPEN_HOST_URL.
3407  -h | --help                    Onap command help message. It is of type STRING.
3408                                 By default, it is false.
3409  -v | --version                 Onap command service version. It is of type
3410                                 STRING. By default, it is false.
3411  -d | --debug                   Enable debug output. It is of type BOOL. By
3412                                 default, it is false.
3413  -f | --format                  Output formats, supported formats such as table,
3414                                 csv, json, yaml. It is of type STRING. By
3415                                 default, it is table.
3416  -s | --long                    whether to print all attributes or only short
3417                                 attributes. It is of type BOOL. By default, it is
3418                                 false.
3419  -t | --no-title                whether to print title or not. It is of type
3420                                 BOOL. By default, it is false.
3421  -a | --no-auth                 whether to authenticate user or not. It is of
3422                                 type BOOL. By default, it is false.
3423 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
3424
3425
3426 Error::
3427
3428  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
3429
3430
3431
3432 [36] vlm-revert
3433 -----------------------------------------------
3434
3435
3436 usage: onap vlm-revert
3437
3438 Revert Vendor License Model
3439
3440 Onap service: sdc v1.0
3441
3442 Options::
3443
3444  [-x | --vlm-id] [-y | --vlm-version] [-u | --onap-username]
3445  [-p | --onap-password] [-m | --host-url] [-h | --help]
3446  [-v | --version] [-d | --debug] [-f | --format]
3447  [-s | --long] [-t | --no-title] [-a | --no-auth]
3448
3449 where::
3450
3451 <<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
3452  -x | --vlm-id          Onap VLM ID. It is of type STRING.
3453  -y | --vlm-version     VLM version. It is of type STRING.
3454 =======
3455 <<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
3456  -b | --vf-id           VF ID. It is of type STRING. It is optional.
3457 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
3458  -u | --onap-username   Onap user name. It is of type STRING. By default,
3459                         it is read from environment variable
3460                         ONAP_USERNAME.
3461  -p | --onap-password   Onap user password. It is of type STRING. By
3462                         default, it is read from environment variable
3463                         ONAP_PASSWORD. Secured.
3464  -m | --host-url        Onap host url. It is of type URL. By default, it
3465                         is read from environment variable ONAP_HOST_URL.
3466  -h | --help            Onap command help message. It is of type STRING.
3467                         By default, it is false.
3468  -v | --version         Onap command service version. It is of type
3469                         STRING. By default, it is false.
3470  -d | --debug           Enable debug output. It is of type BOOL. By
3471                         default, it is false.
3472  -f | --format          Output formats, supported formats such as table,
3473                         csv, json, yaml. It is of type STRING. By
3474                         default, it is table.
3475  -s | --long            whether to print all attributes or only short
3476                         attributes. It is of type BOOL. By default, it is
3477                         false.
3478  -t | --no-title        whether to print title or not. It is of type
3479                         BOOL. By default, it is false.
3480  -a | --no-auth         whether to authenticate user or not. It is of
3481                         type BOOL. By default, it is false.
3482 =======
3483  -x | --vendor-name                 vendor name. It is of type STRING.
3484  -y | --license-model-description   Description for License Model. It is of type
3485                                     STRING. It is optional.
3486  -u | --onap-username               Onap user name. It is of type STRING. By default,
3487                                     it is read from environment variable
3488                                     OPEN_USERNAME.
3489  -p | --onap-password               Onap user password. It is of type STRING. By
3490                                     default, it is read from environment variable
3491                                     OPEN_PASSWORD. Secured.
3492  -m | --host-url                    Onap host url. It is of type URL. By default, it
3493                                     is read from environment variable OPEN_HOST_URL.
3494  -h | --help                        Onap command help message. It is of type STRING.
3495                                     By default, it is false.
3496  -v | --version                     Onap command service version. It is of type
3497                                     STRING. By default, it is false.
3498  -d | --debug                       Enable debug output. It is of type BOOL. By
3499                                     default, it is false.
3500  -f | --format                      Output formats, supported formats such as table,
3501                                     csv, json, yaml. It is of type STRING. By
3502                                     default, it is table.
3503  -s | --long                        whether to print all attributes or only short
3504                                     attributes. It is of type BOOL. By default, it is
3505                                     false.
3506  -t | --no-title                    whether to print title or not. It is of type
3507                                     BOOL. By default, it is false.
3508  -a | --no-auth                     whether to authenticate user or not. It is of
3509                                     type BOOL. By default, it is false.
3510
3511
3512 Results::
3513
3514  ID   License Model ID and is of type STRING.
3515 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
3516
3517
3518 Error::
3519
3520  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
3521
3522
3523
3524 [37] vlm-feature-group-create
3525 -----------------------------------------------
3526
3527
3528 usage: onap vlm-feature-group-create
3529
3530 Create feature group Pool
3531
3532 Onap service: sdc v1.0
3533
3534 Options::
3535
3536  [-x | --name] [-y | --vlm-id] [-e | --vlm-version]
3537  [-z | --description] [-g | --vlm-key-group-id] [-b | --vlm-entitle-pool-id]
3538  [-c | --part-number] [-k | --manufacture-reference-number] [-u | --onap-username]
3539  [-p | --onap-password] [-m | --host-url] [-h | --help]
3540  [-v | --version] [-d | --debug] [-f | --format]
3541  [-s | --long] [-t | --no-title] [-a | --no-auth]
3542
3543 where::
3544
3545 <<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
3546  -x | --name                          Feature group name. It is of type STRING.
3547  -y | --vlm-id                        License Model ID. It is of type STRING.
3548  -e | --vlm-version                   License Model version. It is of type STRING.
3549  -z | --description                   Description for feature group. It is of type
3550                                       STRING.
3551  -g | --vlm-key-group-id              VLM keygroup. It is of type STRING.
3552  -b | --vlm-entitle-pool-id           VLM Entitlement pool. It is of type STRING.
3553  -c | --part-number                   Part number. It is of type STRING.
3554  -k | --manufacture-reference-number  Manufature Reference Number. It is of type STRING.
3555  -u | --onap-username                 Onap user name. It is of type STRING. By default,
3556                                       it is read from environment variable
3557                                       ONAP_USERNAME.
3558  -p | --onap-password                 Onap user password. It is of type STRING. By
3559                                       default, it is read from environment variable
3560                                       ONAP_PASSWORD. Secured.
3561  -m | --host-url                      Onap host url. It is of type URL. By default, it
3562                                       is read from environment variable ONAP_HOST_URL.
3563  -h | --help                          Onap command help message. It is of type STRING.
3564                                       By default, it is false.
3565  -v | --version                       Onap command service version. It is of type
3566                                       STRING. By default, it is false.
3567  -d | --debug                         Enable debug output. It is of type BOOL. By
3568                                       default, it is false.
3569  -f | --format                        Output formats, supported formats such as table,
3570                                       csv, json, yaml. It is of type STRING. By
3571                                       default, it is table.
3572  -s | --long                          whether to print all attributes or only short
3573                                       attributes. It is of type BOOL. By default, it is
3574                                       false.
3575  -t | --no-title                      whether to print title or not. It is of type
3576                                       BOOL. By default, it is false.
3577  -a | --no-auth                       whether to authenticate user or not. It is of
3578                                       type BOOL. By default, it is false.
3579
3580
3581 Results::
3582
3583  ID   Feature group ID and is of type STRING.
3584
3585
3586 Error::
3587
3588  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
3589
3590
3591
3592 [38] vlm-submit
3593 -----------------------------------------------
3594
3595
3596 usage: onap vlm-submit
3597
3598 Submit Vendor License Model
3599
3600 Onap service: sdc v1.0
3601
3602 Options::
3603
3604  [-x | --vlm-id] [-y | --vlm-version] [-u | --onap-username]
3605  [-p | --onap-password] [-m | --host-url] [-h | --help]
3606  [-v | --version] [-d | --debug] [-f | --format]
3607  [-s | --long] [-t | --no-title] [-a | --no-auth]
3608
3609 where::
3610
3611  -x | --vlm-id          Onap VLM ID. It is of type STRING.
3612  -y | --vlm-version     VLM version. It is of type STRING.
3613 =======
3614 <<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
3615  -b | --vf-id           VF ID. It is of type STRING. It is optional.
3616 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
3617  -u | --onap-username   Onap user name. It is of type STRING. By default,
3618                         it is read from environment variable
3619                         ONAP_USERNAME.
3620  -p | --onap-password   Onap user password. It is of type STRING. By
3621                         default, it is read from environment variable
3622                         ONAP_PASSWORD. Secured.
3623  -m | --host-url        Onap host url. It is of type URL. By default, it
3624                         is read from environment variable ONAP_HOST_URL.
3625  -h | --help            Onap command help message. It is of type STRING.
3626                         By default, it is false.
3627  -v | --version         Onap command service version. It is of type
3628                         STRING. By default, it is false.
3629  -d | --debug           Enable debug output. It is of type BOOL. By
3630                         default, it is false.
3631  -f | --format          Output formats, supported formats such as table,
3632                         csv, json, yaml. It is of type STRING. By
3633                         default, it is table.
3634  -s | --long            whether to print all attributes or only short
3635                         attributes. It is of type BOOL. By default, it is
3636                         false.
3637  -t | --no-title        whether to print title or not. It is of type
3638                         BOOL. By default, it is false.
3639  -a | --no-auth         whether to authenticate user or not. It is of
3640                         type BOOL. By default, it is false.
3641 =======
3642  -x | --vsp-name                  Onap VSP Name. It is of type STRING.
3643  -y | --vsp-description           Description for VSP. It is of type STRING. It is
3644                                   optional.
3645  -null | --vsp-category           Category of the VSP. It is of type STRING. It is
3646                                   optional. By default, it is
3647                                   resourceNewCategory.generic.
3648  -null | --vsp-subcategory        Sub Category of VSP. It is of type STRING. It is
3649                                   optional. By default, it is
3650                                   resourceNewCategory.generic.abstract.
3651  -null | --vsp-license-version    License version. It is of type STRING. It is
3652                                   optional. By default, it is 1.0.
3653  -null | --vsp-vendor-name        License Model Name. It is of type STRING.
3654  -null | --vsp-vendor-id          License Model ID. It is of type STRING.
3655  -null | --license-agreement-id   License Agreement ID. It is of type STRING.
3656  -null | --feature-group-id       Feature Group ID. It is of type STRING.
3657  -u | --onap-username             Onap user name. It is of type STRING. By default,
3658                                   it is read from environment variable
3659                                   OPEN_USERNAME.
3660  -p | --onap-password             Onap user password. It is of type STRING. By
3661                                   default, it is read from environment variable
3662                                   OPEN_PASSWORD. Secured.
3663  -m | --host-url                  Onap host url. It is of type URL. By default, it
3664                                   is read from environment variable OPEN_HOST_URL.
3665  -h | --help                      Onap command help message. It is of type STRING.
3666                                   By default, it is false.
3667  -v | --version                   Onap command service version. It is of type
3668                                   STRING. By default, it is false.
3669  -d | --debug                     Enable debug output. It is of type BOOL. By
3670                                   default, it is false.
3671  -f | --format                    Output formats, supported formats such as table,
3672                                   csv, json, yaml. It is of type STRING. By
3673                                   default, it is table.
3674  -s | --long                      whether to print all attributes or only short
3675                                   attributes. It is of type BOOL. By default, it is
3676                                   false.
3677  -t | --no-title                  whether to print title or not. It is of type
3678                                   BOOL. By default, it is false.
3679  -a | --no-auth                   whether to authenticate user or not. It is of
3680                                   type BOOL. By default, it is false.
3681
3682
3683 Results::
3684
3685  ID   VSP ID and is of type STRING.
3686 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
3687
3688
3689 Error::
3690
3691  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
3692
3693
3694
3695 [39] vf-model-certify-start
3696 -----------------------------------------------
3697
3698
3699 usage: onap vf-model-certify-start
3700
3701 Start certifying Virtual function
3702
3703 Onap service: sdc v1.0
3704
3705 Options::
3706
3707  [-b | --vf-id] [-u | --onap-username] [-p | --onap-password]
3708  [-m | --host-url] [-h | --help] [-v | --version]
3709  [-d | --debug] [-f | --format] [-s | --long]
3710  [-t | --no-title] [-a | --no-auth]
3711
3712 where::
3713
3714  -b | --vf-id           VF ID. It is of type STRING. It is optional.
3715  -u | --onap-username   Onap user name. It is of type STRING. By default,
3716                         it is read from environment variable
3717                         OPEN_USERNAME.
3718  -p | --onap-password   Onap user password. It is of type STRING. By
3719                         default, it is read from environment variable
3720                         OPEN_PASSWORD. Secured.
3721  -m | --host-url        Onap host url. It is of type URL. By default, it
3722                         is read from environment variable OPEN_HOST_URL.
3723  -h | --help            Onap command help message. It is of type STRING.
3724                         By default, it is false.
3725  -v | --version         Onap command service version. It is of type
3726                         STRING. By default, it is false.
3727  -d | --debug           Enable debug output. It is of type BOOL. By
3728                         default, it is false.
3729  -f | --format          Output formats, supported formats such as table,
3730                         csv, json, yaml. It is of type STRING. By
3731                         default, it is table.
3732  -s | --long            whether to print all attributes or only short
3733                         attributes. It is of type BOOL. By default, it is
3734                         false.
3735  -t | --no-title        whether to print title or not. It is of type
3736                         BOOL. By default, it is false.
3737  -a | --no-auth         whether to authenticate user or not. It is of
3738                         type BOOL. By default, it is false.
3739
3740
3741 Error::
3742
3743  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
3744
3745
3746
3747 [40] vf-model-list
3748 -----------------------------------------------
3749
3750
3751 usage: onap vf-model-list
3752
3753 List the VF resource model in SDC
3754
3755 Onap service: sdc v1.0
3756
3757 Options::
3758
3759  [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
3760  [-h | --help] [-v | --version] [-d | --debug]
3761  [-f | --format] [-s | --long] [-t | --no-title]
3762  [-a | --no-auth]
3763
3764 where::
3765
3766  -u | --onap-username   Onap user name. It is of type STRING. By default,
3767                         it is read from environment variable
3768                         OPEN_USERNAME.
3769  -p | --onap-password   Onap user password. It is of type STRING. By
3770                         default, it is read from environment variable
3771                         OPEN_PASSWORD. Secured.
3772  -m | --host-url        Onap host url. It is of type URL. By default, it
3773                         is read from environment variable OPEN_HOST_URL.
3774  -h | --help            Onap command help message. It is of type STRING.
3775                         By default, it is false.
3776  -v | --version         Onap command service version. It is of type
3777                         STRING. By default, it is false.
3778  -d | --debug           Enable debug output. It is of type BOOL. By
3779                         default, it is false.
3780  -f | --format          Output formats, supported formats such as table,
3781                         csv, json, yaml. It is of type STRING. By
3782                         default, it is table.
3783  -s | --long            whether to print all attributes or only short
3784                         attributes. It is of type BOOL. By default, it is
3785                         false.
3786  -t | --no-title        whether to print title or not. It is of type
3787                         BOOL. By default, it is false.
3788  -a | --no-auth         whether to authenticate user or not. It is of
3789                         type BOOL. By default, it is false.
3790
3791
3792 Results::
3793
3794  uuid             UUID and is of type STRING.
3795  uniqueid         UUID and is of type STRING.
3796  invariant-uuid   Invariant UUID and is of type STRING.
3797  name             Name and is of type STRING.
3798  version          version and is of type STRING.
3799  status           status and is of type STRING.
3800  description      description and is of type STRING.
3801  vsp-uuid         VSP uuid and is of type STRING.
3802  vsp-version      VSP version and is of type STRING.
3803
3804
3805 Error::
3806
3807  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
3808
3809
3810
3811 [41] vlm-entitlement-pool-list
3812 -----------------------------------------------
3813
3814
3815 usage: onap vlm-entitlement-pool-list
3816
3817 entitlement pool list in a license model
3818
3819 Onap service: sdc v1.0
3820
3821 Options::
3822
3823  [-x | --vlm-id] [-y | --vlm-version] [-u | --onap-username]
3824  [-p | --onap-password] [-m | --host-url] [-h | --help]
3825  [-v | --version] [-d | --debug] [-f | --format]
3826  [-s | --long] [-t | --no-title] [-a | --no-auth]
3827
3828 where::
3829
3830  -x | --vlm-id          License Model ID. It is of type STRING.
3831  -y | --vlm-version     License Model version. It is of type STRING.
3832  -u | --onap-username   Onap user name. It is of type STRING. By default,
3833                         it is read from environment variable
3834                         OPEN_USERNAME.
3835  -p | --onap-password   Onap user password. It is of type STRING. By
3836                         default, it is read from environment variable
3837                         OPEN_PASSWORD. Secured.
3838  -m | --host-url        Onap host url. It is of type URL. By default, it
3839                         is read from environment variable OPEN_HOST_URL.
3840  -h | --help            Onap command help message. It is of type STRING.
3841                         By default, it is false.
3842  -v | --version         Onap command service version. It is of type
3843                         STRING. By default, it is false.
3844  -d | --debug           Enable debug output. It is of type BOOL. By
3845                         default, it is false.
3846  -f | --format          Output formats, supported formats such as table,
3847                         csv, json, yaml. It is of type STRING. By
3848                         default, it is table.
3849  -s | --long            whether to print all attributes or only short
3850                         attributes. It is of type BOOL. By default, it is
3851                         false.
3852  -t | --no-title        whether to print title or not. It is of type
3853                         BOOL. By default, it is false.
3854  -a | --no-auth         whether to authenticate user or not. It is of
3855                         type BOOL. By default, it is false.
3856
3857
3858 Results::
3859
3860  ID     Feature group ID and is of type STRING.
3861  name   Feature group name and is of type STRING.
3862
3863
3864 Error::
3865
3866  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
3867
3868
3869
3870 [42] vlm-feature-group-list
3871 -----------------------------------------------
3872
3873
3874 usage: onap vlm-feature-group-list
3875
3876 Feature group list in a license model
3877
3878 Onap service: sdc v1.0
3879
3880 Options::
3881
3882  [-x | --vlm-id] [-y | --vlm-version] [-u | --onap-username]
3883  [-p | --onap-password] [-m | --host-url] [-h | --help]
3884  [-v | --version] [-d | --debug] [-f | --format]
3885  [-s | --long] [-t | --no-title] [-a | --no-auth]
3886
3887 where::
3888
3889  -x | --vlm-id          License Model ID. It is of type STRING.
3890  -y | --vlm-version     License Model version. It is of type STRING.
3891  -u | --onap-username   Onap user name. It is of type STRING. By default,
3892                         it is read from environment variable
3893                         ONAP_USERNAME.
3894  -p | --onap-password   Onap user password. It is of type STRING. By
3895                         default, it is read from environment variable
3896                         ONAP_PASSWORD. Secured.
3897  -m | --host-url        Onap host url. It is of type URL. By default, it
3898                         is read from environment variable ONAP_HOST_URL.
3899  -h | --help            Onap command help message. It is of type STRING.
3900                         By default, it is false.
3901  -v | --version         Onap command service version. It is of type
3902                         STRING. By default, it is false.
3903  -d | --debug           Enable debug output. It is of type BOOL. By
3904                         default, it is false.
3905  -f | --format          Output formats, supported formats such as table,
3906                         csv, json, yaml. It is of type STRING. By
3907                         default, it is table.
3908  -s | --long            whether to print all attributes or only short
3909                         attributes. It is of type BOOL. By default, it is
3910                         false.
3911  -t | --no-title        whether to print title or not. It is of type
3912                         BOOL. By default, it is false.
3913  -a | --no-auth         whether to authenticate user or not. It is of
3914                         type BOOL. By default, it is false.
3915
3916
3917 Results::
3918
3919  ID     Feature group ID and is of type STRING.
3920  name   Feature group name and is of type STRING.
3921
3922
3923 Error::
3924
3925  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
3926
3927
3928
3929 [43] vlm-checkout
3930 -----------------------------------------------
3931
3932
3933 usage: onap vlm-checkout
3934
3935 Checkout Vendor License Model
3936
3937 Onap service: sdc v1.0
3938
3939 Options::
3940
3941  [-x | --vlm-id] [-y | --vlm-version] [-u | --onap-username]
3942  [-p | --onap-password] [-m | --host-url] [-h | --help]
3943  [-v | --version] [-d | --debug] [-f | --format]
3944  [-s | --long] [-t | --no-title] [-a | --no-auth]
3945
3946 where::
3947
3948  -x | --vlm-id          Onap VLM ID. It is of type STRING.
3949  -y | --vlm-version     VLM version. It is of type STRING.
3950  -u | --onap-username   Onap user name. It is of type STRING. By default,
3951                         it is read from environment variable
3952                         ONAP_USERNAME.
3953  -p | --onap-password   Onap user password. It is of type STRING. By
3954                         default, it is read from environment variable
3955                         ONAP_PASSWORD. Secured.
3956  -m | --host-url        Onap host url. It is of type URL. By default, it
3957                         is read from environment variable ONAP_HOST_URL.
3958  -h | --help            Onap command help message. It is of type STRING.
3959                         By default, it is false.
3960  -v | --version         Onap command service version. It is of type
3961                         STRING. By default, it is false.
3962  -d | --debug           Enable debug output. It is of type BOOL. By
3963                         default, it is false.
3964  -f | --format          Output formats, supported formats such as table,
3965                         csv, json, yaml. It is of type STRING. By
3966                         default, it is table.
3967  -s | --long            whether to print all attributes or only short
3968                         attributes. It is of type BOOL. By default, it is
3969                         false.
3970  -t | --no-title        whether to print title or not. It is of type
3971                         BOOL. By default, it is false.
3972  -a | --no-auth         whether to authenticate user or not. It is of
3973                         type BOOL. By default, it is false.
3974
3975
3976 Error::
3977
3978  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
3979
3980
3981
3982 [44] vlm-list
3983 -----------------------------------------------
3984
3985
3986 usage: onap vlm-list
3987
3988 List License Model
3989
3990 Onap service: sdc v1.0
3991
3992 Options::
3993
3994  [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
3995  [-h | --help] [-v | --version] [-d | --debug]
3996  [-f | --format] [-s | --long] [-t | --no-title]
3997  [-a | --no-auth]
3998
3999 where::
4000
4001  -u | --onap-username   Onap user name. It is of type STRING. By default,
4002                         it is read from environment variable
4003                         ONAP_USERNAME.
4004  -p | --onap-password   Onap user password. It is of type STRING. By
4005                         default, it is read from environment variable
4006                         ONAP_PASSWORD. Secured.
4007  -m | --host-url        Onap host url. It is of type URL. By default, it
4008                         is read from environment variable ONAP_HOST_URL.
4009  -h | --help            Onap command help message. It is of type STRING.
4010                         By default, it is false.
4011  -v | --version         Onap command service version. It is of type
4012                         STRING. By default, it is false.
4013  -d | --debug           Enable debug output. It is of type BOOL. By
4014                         default, it is false.
4015  -f | --format          Output formats, supported formats such as table,
4016                         csv, json, yaml. It is of type STRING. By
4017                         default, it is table.
4018  -s | --long            whether to print all attributes or only short
4019                         attributes. It is of type BOOL. By default, it is
4020                         false.
4021  -t | --no-title        whether to print title or not. It is of type
4022                         BOOL. By default, it is false.
4023  -a | --no-auth         whether to authenticate user or not. It is of
4024                         type BOOL. By default, it is false.
4025
4026
4027 Results::
4028
4029  id           License ID and is of type UUID.
4030  vendor-name  Vendor  Name and is of type STRING.
4031  vlm-version  VLM version and is of type STRING.
4032  status       status and is of type STRING.
4033  description  License description and is of type STRING.
4034
4035
4036 Error::
4037
4038  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
4039
4040
4041
4042 [45] vlm-aggreement-create
4043 -----------------------------------------------
4044
4045
4046 usage: onap vlm-aggreement-create
4047
4048 Create license aggreement
4049
4050 Onap service: sdc v1.0
4051
4052 Options::
4053
4054  [-x | --name] [-y | --vlm-id] [-e | --vlm-version]
4055  [-z | --description] [-g | --vlm-feature-group-id] [-u | --onap-username]
4056  [-p | --onap-password] [-m | --host-url] [-h | --help]
4057  [-v | --version] [-d | --debug] [-f | --format]
4058  [-s | --long] [-t | --no-title] [-a | --no-auth]
4059
4060 where::
4061
4062  -x | --name                  aggreement name. It is of type STRING.
4063  -y | --vlm-id                License Model ID. It is of type STRING.
4064  -e | --vlm-version           License Model version. It is of type STRING.
4065  -z | --description           Description for aggreement. It is of type STRING.
4066  -g | --vlm-feature-group-id  VLM feature group. It is of type STRING.
4067  -u | --onap-username         Onap user name. It is of type STRING. By default,
4068                               it is read from environment variable
4069                               ONAP_USERNAME.
4070  -p | --onap-password         Onap user password. It is of type STRING. By
4071                               default, it is read from environment variable
4072                               ONAP_PASSWORD. Secured.
4073  -m | --host-url              Onap host url. It is of type URL. By default, it
4074                               is read from environment variable ONAP_HOST_URL.
4075  -h | --help                  Onap command help message. It is of type STRING.
4076                               By default, it is false.
4077  -v | --version               Onap command service version. It is of type
4078                               STRING. By default, it is false.
4079  -d | --debug                 Enable debug output. It is of type BOOL. By
4080                               default, it is false.
4081  -f | --format                Output formats, supported formats such as table,
4082                               csv, json, yaml. It is of type STRING. By
4083                               default, it is table.
4084  -s | --long                  whether to print all attributes or only short
4085                               attributes. It is of type BOOL. By default, it is
4086                               false.
4087  -t | --no-title              whether to print title or not. It is of type
4088                               BOOL. By default, it is false.
4089  -a | --no-auth               whether to authenticate user or not. It is of
4090                               type BOOL. By default, it is false.
4091
4092
4093 Results::
4094
4095  ID   aggreement ID and is of type STRING.
4096
4097
4098 Error::
4099
4100  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
4101
4102
4103
4104 [46] vf-model-certify-request
4105 -----------------------------------------------
4106
4107
4108 usage: onap vf-model-certify-request
4109
4110 Request for certifying Virtual function
4111
4112 Onap service: sdc v1.0
4113
4114 Options::
4115
4116  [-b | --vf-id] [-u | --onap-username] [-p | --onap-password]
4117  [-m | --host-url] [-h | --help] [-v | --version]
4118  [-d | --debug] [-f | --format] [-s | --long]
4119  [-t | --no-title] [-a | --no-auth]
4120
4121 where::
4122
4123  -b | --vf-id           VF ID. It is of type STRING. It is optional.
4124  -u | --onap-username   Onap user name. It is of type STRING. By default,
4125                         it is read from environment variable
4126                         ONAP_USERNAME.
4127  -p | --onap-password   Onap user password. It is of type STRING. By
4128                         default, it is read from environment variable
4129                         ONAP_PASSWORD. Secured.
4130  -m | --host-url        Onap host url. It is of type URL. By default, it
4131                         is read from environment variable ONAP_HOST_URL.
4132  -h | --help            Onap command help message. It is of type STRING.
4133                         By default, it is false.
4134  -v | --version         Onap command service version. It is of type
4135                         STRING. By default, it is false.
4136  -d | --debug           Enable debug output. It is of type BOOL. By
4137                         default, it is false.
4138  -f | --format          Output formats, supported formats such as table,
4139                         csv, json, yaml. It is of type STRING. By
4140                         default, it is table.
4141  -s | --long            whether to print all attributes or only short
4142                         attributes. It is of type BOOL. By default, it is
4143                         false.
4144  -t | --no-title        whether to print title or not. It is of type
4145                         BOOL. By default, it is false.
4146  -a | --no-auth         whether to authenticate user or not. It is of
4147                         type BOOL. By default, it is false.
4148
4149
4150 Error::
4151
4152  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
4153
4154
4155
4156 [47] vf2vfmodule-model-list
4157 -----------------------------------------------
4158
4159
4160 usage: onap vf2vfmodule-model-list
4161
4162 List the VF modules in a given VF model in SDC
4163
4164 Onap service: sdc v1.0
4165
4166 Options::
4167
4168  [-z | --vf-id] [-u | --onap-username] [-p | --onap-password]
4169  [-m | --host-url] [-h | --help] [-v | --version]
4170  [-d | --debug] [-f | --format] [-s | --long]
4171  [-t | --no-title] [-a | --no-auth]
4172
4173 where::
4174
4175  -z | --vf-id           VF uuid. It is of type STRING.
4176  -u | --onap-username   Onap user name. It is of type STRING. By default,
4177                         it is read from environment variable
4178                         ONAP_USERNAME.
4179  -p | --onap-password   Onap user password. It is of type STRING. By
4180                         default, it is read from environment variable
4181                         ONAP_PASSWORD. Secured.
4182  -m | --host-url        Onap host url. It is of type URL. By default, it
4183                         is read from environment variable ONAP_HOST_URL.
4184  -h | --help            Onap command help message. It is of type STRING.
4185                         By default, it is false.
4186  -v | --version         Onap command service version. It is of type
4187                         STRING. By default, it is false.
4188  -d | --debug           Enable debug output. It is of type BOOL. By
4189                         default, it is false.
4190  -f | --format          Output formats, supported formats such as table,
4191                         csv, json, yaml. It is of type STRING. By
4192                         default, it is table.
4193  -s | --long            whether to print all attributes or only short
4194                         attributes. It is of type BOOL. By default, it is
4195                         false.
4196  -t | --no-title        whether to print title or not. It is of type
4197                         BOOL. By default, it is false.
4198  -a | --no-auth         whether to authenticate user or not. It is of
4199                         type BOOL. By default, it is false.
4200
4201
4202 Results::
4203
4204  vsp-uuid               VSP uuid and is of type STRING.
4205  vsp-version            VSP version and is of type STRING.
4206  module-uuid            UUID and is of type STRING.
4207  module-invariant-uuid  Invariant UUID and is of type STRING.
4208  module-name            name and is of type STRING.
4209  module-version         version and is of type STRING.
4210
4211
4212 Error::
4213
4214  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
4215
4216
4217
4218 [48] vf-model-certify-complete
4219 -----------------------------------------------
4220
4221
4222 usage: onap vf-model-certify-complete
4223
4224 Complete certifying Virtual function
4225
4226 Onap service: sdc v1.0
4227
4228 Options::
4229
4230  [-b | --vf-id] [-u | --onap-username] [-p | --onap-password]
4231  [-m | --host-url] [-h | --help] [-v | --version]
4232  [-d | --debug] [-f | --format] [-s | --long]
4233  [-t | --no-title] [-a | --no-auth]
4234
4235 where::
4236
4237  -b | --vf-id           VF ID. It is of type STRING. It is optional.
4238  -u | --onap-username   Onap user name. It is of type STRING. By default,
4239                         it is read from environment variable
4240                         ONAP_USERNAME.
4241  -p | --onap-password   Onap user password. It is of type STRING. By
4242                         default, it is read from environment variable
4243                         ONAP_PASSWORD. Secured.
4244  -m | --host-url        Onap host url. It is of type URL. By default, it
4245                         is read from environment variable ONAP_HOST_URL.
4246  -h | --help            Onap command help message. It is of type STRING.
4247                         By default, it is false.
4248  -v | --version         Onap command service version. It is of type
4249                         STRING. By default, it is false.
4250  -d | --debug           Enable debug output. It is of type BOOL. By
4251                         default, it is false.
4252  -f | --format          Output formats, supported formats such as table,
4253                         csv, json, yaml. It is of type STRING. By
4254                         default, it is table.
4255  -s | --long            whether to print all attributes or only short
4256                         attributes. It is of type BOOL. By default, it is
4257                         false.
4258  -t | --no-title        whether to print title or not. It is of type
4259                         BOOL. By default, it is false.
4260  -a | --no-auth         whether to authenticate user or not. It is of
4261                         type BOOL. By default, it is false.
4262
4263
4264 Error::
4265
4266  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
4267
4268
4269
4270 [49] cloud-list
4271 -----------------------------------------------
4272
4273
4274 usage: onap cloud-list
4275
4276 List the configured clouds and Onap service subscriptions
4277
4278 Onap service: aai v11
4279
4280 Options::
4281
4282  [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
4283  [-h | --help] [-v | --version] [-d | --debug]
4284  [-f | --format] [-s | --long] [-t | --no-title]
4285  [-a | --no-auth]
4286
4287 where::
4288
4289  -u | --onap-username   Onap user name. It is of type STRING. By default,
4290                         it is read from environment variable
4291                         ONAP_USERNAME.
4292  -p | --onap-password   Onap user password. It is of type STRING. By
4293                         default, it is read from environment variable
4294                         ONAP_PASSWORD. Secured.
4295  -m | --host-url        Onap host url. It is of type URL. By default, it
4296                         is read from environment variable ONAP_HOST_URL.
4297  -h | --help            Onap command help message. It is of type STRING.
4298                         By default, it is false.
4299  -v | --version         Onap command service version. It is of type
4300                         STRING. By default, it is false.
4301  -d | --debug           Enable debug output. It is of type BOOL. By
4302                         default, it is false.
4303  -f | --format          Output formats, supported formats such as table,
4304                         csv, json, yaml. It is of type STRING. By
4305                         default, it is table.
4306  -s | --long            whether to print all attributes or only short
4307                         attributes. It is of type BOOL. By default, it is
4308                         false.
4309  -t | --no-title        whether to print title or not. It is of type
4310                         BOOL. By default, it is false.
4311  -a | --no-auth         whether to authenticate user or not. It is of
4312                         type BOOL. By default, it is false.
4313
4314
4315 Results::
4316
4317  cloud              Onap cloud and is of type STRING.
4318  region             Onap cloud region and is of type STRING.
4319  tenant             Onap cloud tenat and is of type STRING.
4320  tenant-id          Onap cloud tenat id and is of type STRING.
4321  customer           Onap cloud customer and is of type STRING.
4322  service            Onap cloud service and is of type STRING.
4323  resource-version   Onap cloud resource version and is of type STRING.
4324
4325
4326 Error::
4327
4328  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
4329
4330
4331
4332 [50] sdnc-list
4333 -----------------------------------------------
4334
4335
4336 usage: onap sdnc-list
4337
4338 List the configured sdnc
4339
4340 Onap service: aai v11
4341
4342 Options::
4343
4344  [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
4345  [-h | --help] [-v | --version] [-d | --debug]
4346  [-f | --format] [-s | --long] [-t | --no-title]
4347  [-a | --no-auth]
4348
4349 where::
4350
4351  -u | --onap-username   Onap user name. It is of type STRING. By default,
4352                         it is read from environment variable
4353                         ONAP_USERNAME.
4354  -p | --onap-password   Onap user password. It is of type STRING. By
4355                         default, it is read from environment variable
4356                         ONAP_PASSWORD. Secured.
4357  -m | --host-url        Onap host url. It is of type URL. By default, it
4358                         is read from environment variable ONAP_HOST_URL.
4359  -h | --help            Onap command help message. It is of type STRING.
4360                         By default, it is false.
4361  -v | --version         Onap command service version. It is of type
4362                         STRING. By default, it is false.
4363  -d | --debug           Enable debug output. It is of type BOOL. By
4364                         default, it is false.
4365  -f | --format          Output formats, supported formats such as table,
4366                         csv, json, yaml. It is of type STRING. By
4367                         default, it is table.
4368  -s | --long            whether to print all attributes or only short
4369                         attributes. It is of type BOOL. By default, it is
4370                         false.
4371  -t | --no-title        whether to print title or not. It is of type
4372                         BOOL. By default, it is false.
4373  -a | --no-auth         whether to authenticate user or not. It is of
4374                         type BOOL. By default, it is false.
4375
4376
4377 Results::
4378
4379  sdnc-id            Onap sdnc id and is of type STRING.
4380  resource-version   Onap sdnc resource version and is of type STRING.
4381
4382
4383 Error::
4384
4385  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
4386
4387
4388
4389 [51] sdnc-register
4390 -----------------------------------------------
4391
4392
4393 usage: onap sdnc-register
4394
4395 Register a SDNC in Onap
4396
4397 Onap service: aai v11
4398
4399 Options::
4400
4401  [-x | --location] [-y | --sdnc-id] [-b | --name]
4402  [-c | --type] [-e | --vendor] [-q | --sdnc-version]
4403  [-g | --ip-address] [-k | --port] [-r | --protocal]
4404  [-i | --username] [-j | --password] [-z | --product-name]
4405  [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
4406  [-h | --help] [-v | --version] [-d | --debug]
4407  [-f | --format] [-s | --long] [-t | --no-title]
4408  [-a | --no-auth]
4409
4410 where::
4411
4412  -x | --location        Onap VIM unique id. It is of type UUID. By
4413                         default, it is
4414                         2821b55f-121c-47a8-8b47-6a555ce54e19.
4415  -y | --sdnc-id         Onap SDNC unique id. It is of type UUID. By
4416                         default, it is
4417                         d5575325-4d90-4ead-9656-8186504e9a88.
4418  -b | --name            Onap SDNC name. It is of type STRING.
4419  -c | --type            Onap SDNC type. It is of type STRING.
4420  -e | --vendor          Onap SDNC vendor. It is of type STRING.
4421  -q | --sdnc-version    Onap SDNC version. It is of type STRING.
4422  -g | --ip-address      Onap SDNC ip address. It is of type STRING.
4423  -k | --port            Onap SDNC port. It is of type STRING.
4424  -r | --protocal        Onap SDNC protocal. It is of type STRING.
4425  -i | --username        Onap SDNC username. It is of type STRING.
4426  -j | --password        Onap SDNC password. It is of type STRING.
4427  -z | --product-name    Onap SDNC product-name. It is of type STRING.
4428  -u | --onap-username   Onap user name. It is of type STRING. By default,
4429                         it is read from environment variable
4430                         ONAP_USERNAME.
4431  -p | --onap-password   Onap user password. It is of type STRING. By
4432                         default, it is read from environment variable
4433                         ONAP_PASSWORD. Secured.
4434  -m | --host-url        Onap host url. It is of type URL. By default, it
4435                         is read from environment variable ONAP_HOST_URL.
4436  -h | --help            Onap command help message. It is of type STRING.
4437                         By default, it is false.
4438  -v | --version         Onap command service version. It is of type
4439                         STRING. By default, it is false.
4440  -d | --debug           Enable debug output. It is of type BOOL. By
4441                         default, it is false.
4442  -f | --format          Output formats, supported formats such as table,
4443                         csv, json, yaml. It is of type STRING. By
4444                         default, it is table.
4445  -s | --long            whether to print all attributes or only short
4446                         attributes. It is of type BOOL. By default, it is
4447                         false.
4448  -t | --no-title        whether to print title or not. It is of type
4449                         BOOL. By default, it is false.
4450  -a | --no-auth         whether to authenticate user or not. It is of
4451                         type BOOL. By default, it is false.
4452
4453
4454 Error::
4455
4456  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
4457
4458
4459
4460 [52] sdnc-unregister
4461 -----------------------------------------------
4462
4463
4464 usage: onap sdnc-unregister
4465
4466 Un-register a VNFM in Onap
4467
4468 Onap service: aai v11
4469
4470 Options::
4471
4472  [-x | --sdnc-id] [-u | --onap-username] [-p | --onap-password]
4473  [-m | --host-url] [-h | --help] [-v | --version]
4474  [-d | --debug] [-f | --format] [-s | --long]
4475  [-t | --no-title] [-a | --no-auth]
4476
4477 where::
4478
4479  -x | --sdnc-id         Onap VNFM unique id. It is of type STRING.
4480  -u | --onap-username   Onap user name. It is of type STRING. By default,
4481                         it is read from environment variable
4482                         ONAP_USERNAME.
4483  -p | --onap-password   Onap user password. It is of type STRING. By
4484                         default, it is read from environment variable
4485                         ONAP_PASSWORD. Secured.
4486  -m | --host-url        Onap host url. It is of type URL. By default, it
4487                         is read from environment variable ONAP_HOST_URL.
4488  -h | --help            Onap command help message. It is of type STRING.
4489                         By default, it is false.
4490  -v | --version         Onap command service version. It is of type
4491                         STRING. By default, it is false.
4492  -d | --debug           Enable debug output. It is of type BOOL. By
4493                         default, it is false.
4494  -f | --format          Output formats, supported formats such as table,
4495                         csv, json, yaml. It is of type STRING. By
4496                         default, it is table.
4497  -s | --long            whether to print all attributes or only short
4498                         attributes. It is of type BOOL. By default, it is
4499                         false.
4500  -t | --no-title        whether to print title or not. It is of type
4501                         BOOL. By default, it is false.
4502  -a | --no-auth         whether to authenticate user or not. It is of
4503                         type BOOL. By default, it is false.
4504
4505
4506 Error::
4507
4508  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
4509
4510
4511
4512 [53] vnfm-show
4513 -----------------------------------------------
4514
4515
4516 usage: onap vnfm-show
4517
4518 Show the VNFM in Onap
4519
4520 Onap service: aai v11
4521
4522 Options::
4523
4524  [-x | --vnfm-id] [-u | --onap-username] [-p | --onap-password]
4525  [-m | --host-url] [-h | --help] [-v | --version]
4526  [-d | --debug] [-f | --format] [-s | --long]
4527  [-t | --no-title] [-a | --no-auth]
4528
4529 where::
4530
4531  -x | --vnfm-id         Onap VNFM unique id. It is of type UUID. By
4532                         default, it is
4533                         16d1e277-973c-409c-b221-5fd57cc7100a.
4534  -u | --onap-username   Onap user name. It is of type STRING. By default,
4535                         it is read from environment variable
4536                         ONAP_USERNAME.
4537  -p | --onap-password   Onap user password. It is of type STRING. By
4538                         default, it is read from environment variable
4539                         ONAP_PASSWORD. Secured.
4540  -m | --host-url        Onap host url. It is of type URL. By default, it
4541                         is read from environment variable ONAP_HOST_URL.
4542  -h | --help            Onap command help message. It is of type STRING.
4543                         By default, it is false.
4544  -v | --version         Onap command service version. It is of type
4545                         STRING. By default, it is false.
4546  -d | --debug           Enable debug output. It is of type BOOL. By
4547                         default, it is false.
4548  -f | --format          Output formats, supported formats such as table,
4549                         csv, json, yaml. It is of type STRING. By
4550                         default, it is table.
4551  -s | --long            whether to print all attributes or only short
4552                         attributes. It is of type BOOL. By default, it is
4553                         false.
4554  -t | --no-title        whether to print title or not. It is of type
4555                         BOOL. By default, it is false.
4556  -a | --no-auth         whether to authenticate user or not. It is of
4557                         type BOOL. By default, it is false.
4558
4559
4560 Results::
4561
4562  name       Onap vnfm name and is of type STRING.
4563  type       Onap vnfm type and is of type STRING.
4564  vendor     Onap vnfm vendor and is of type STRING.
4565  version    Onap vnfm version and is of type STRING.
4566  url        Onap vnfm url and is of type STRING.
4567  username   Onap vnfm username and is of type STRING.
4568
4569
4570 Error::
4571
4572  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
4573
4574
4575
4576 [54] vnfm-unregister
4577 -----------------------------------------------
4578
4579
4580 usage: onap vnfm-unregister
4581
4582 Un-register a VNFM in Onap
4583
4584 Onap service: aai v11
4585
4586 Options::
4587
4588  [-x | --vnfm-id] [-y | --resource-version] [-u | --onap-username]
4589  [-p | --onap-password] [-m | --host-url] [-h | --help]
4590  [-v | --version] [-d | --debug] [-f | --format]
4591  [-s | --long] [-t | --no-title] [-a | --no-auth]
4592
4593 where::
4594
4595  -x | --vnfm-id           Onap VNFM unique id. It is of type UUID. By
4596                           default, it is
4597                           b6271696-01e3-43eb-a7f2-11d3b24746c4.
4598  -y | --resource-version  Onap vim resource version. It is of type STRING.
4599                           It is optional.
4600  -u | --onap-username     Onap user name. It is of type STRING. By default,
4601                           it is read from environment variable
4602                           ONAP_USERNAME.
4603  -p | --onap-password     Onap user password. It is of type STRING. By
4604                           default, it is read from environment variable
4605                           ONAP_PASSWORD. Secured.
4606  -m | --host-url          Onap host url. It is of type URL. By default, it
4607                           is read from environment variable ONAP_HOST_URL.
4608  -h | --help              Onap command help message. It is of type STRING.
4609                           By default, it is false.
4610  -v | --version           Onap command service version. It is of type
4611                           STRING. By default, it is false.
4612  -d | --debug             Enable debug output. It is of type BOOL. By
4613                           default, it is false.
4614  -f | --format            Output formats, supported formats such as table,
4615                           csv, json, yaml. It is of type STRING. By
4616                           default, it is table.
4617  -s | --long              whether to print all attributes or only short
4618                           attributes. It is of type BOOL. By default, it is
4619                           false.
4620  -t | --no-title          whether to print title or not. It is of type
4621                           BOOL. By default, it is false.
4622  -a | --no-auth           whether to authenticate user or not. It is of
4623                           type BOOL. By default, it is false.
4624
4625
4626 Error::
4627
4628  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
4629
4630
4631
4632 [55] vnfm-register
4633 -----------------------------------------------
4634
4635
4636 usage: onap vnfm-register
4637
4638 Register a VNFM in Onap
4639
4640 Onap service: aai v11
4641
4642 Options::
4643
4644  [-x | --vim-id] [-y | --vnfm-id] [-b | --name]
4645  [-c | --type] [-e | --vendor] [-q | --vnfm-version]
4646  [-g | --url] [-i | --username] [-j | --password]
4647  [-z | --certificate-url] [-u | --onap-username] [-p | --onap-password]
4648  [-m | --host-url] [-h | --help] [-v | --version]
4649  [-d | --debug] [-f | --format] [-s | --long]
4650  [-t | --no-title] [-a | --no-auth]
4651
4652 where::
4653
4654  -x | --vim-id            Onap VIM unique id. It is of type UUID. By
4655                           default, it is
4656                           061e5c37-2a9a-4775-80e4-d15891a22ae4.
4657  -y | --vnfm-id           Onap VNFM unique id. It is of type UUID. By
4658                           default, it is
4659                           2e8957a6-75af-4508-9949-bf17eb7cf76a.
4660  -b | --name              Onap VNFM name. It is of type STRING.
4661  -c | --type              Onap VNFM type. It is of type STRING.
4662  -e | --vendor            Onap VNFM vendor. It is of type STRING.
4663  -q | --vnfm-version      Onap VNFM version. It is of type STRING.
4664  -g | --url               Onap VNFM URL. It is of type STRING.
4665  -i | --username          Onap VNFM username. It is of type STRING.
4666  -j | --password          Onap VNFM password. It is of type STRING.
4667  -z | --certificate-url   Onap VNFM certificate-url. It is of type STRING.
4668                           It is optional.
4669  -u | --onap-username     Onap user name. It is of type STRING. By default,
4670                           it is read from environment variable
4671                           ONAP_USERNAME.
4672  -p | --onap-password     Onap user password. It is of type STRING. By
4673                           default, it is read from environment variable
4674                           ONAP_PASSWORD. Secured.
4675  -m | --host-url          Onap host url. It is of type URL. By default, it
4676                           is read from environment variable ONAP_HOST_URL.
4677  -h | --help              Onap command help message. It is of type STRING.
4678                           By default, it is false.
4679  -v | --version           Onap command service version. It is of type
4680                           STRING. By default, it is false.
4681  -d | --debug             Enable debug output. It is of type BOOL. By
4682                           default, it is false.
4683  -f | --format            Output formats, supported formats such as table,
4684                           csv, json, yaml. It is of type STRING. By
4685                           default, it is table.
4686  -s | --long              whether to print all attributes or only short
4687                           attributes. It is of type BOOL. By default, it is
4688                           false.
4689  -t | --no-title          whether to print title or not. It is of type
4690                           BOOL. By default, it is false.
4691  -a | --no-auth           whether to authenticate user or not. It is of
4692                           type BOOL. By default, it is false.
4693
4694
4695 Error::
4696
4697  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
4698
4699
4700
4701 [56] vnfm-list
4702 -----------------------------------------------
4703
4704
4705 usage: onap vnfm-list
4706
4707 List the configured vnfm
4708
4709 Onap service: aai v11
4710
4711 Options::
4712
4713  [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
4714  [-h | --help] [-v | --version] [-d | --debug]
4715  [-f | --format] [-s | --long] [-t | --no-title]
4716  [-a | --no-auth]
4717
4718 where::
4719
4720  -u | --onap-username   Onap user name. It is of type STRING. By default,
4721                         it is read from environment variable
4722                         ONAP_USERNAME.
4723  -p | --onap-password   Onap user password. It is of type STRING. By
4724                         default, it is read from environment variable
4725                         ONAP_PASSWORD. Secured.
4726  -m | --host-url        Onap host url. It is of type URL. By default, it
4727                         is read from environment variable ONAP_HOST_URL.
4728  -h | --help            Onap command help message. It is of type STRING.
4729                         By default, it is false.
4730  -v | --version         Onap command service version. It is of type
4731                         STRING. By default, it is false.
4732  -d | --debug           Enable debug output. It is of type BOOL. By
4733                         default, it is false.
4734  -f | --format          Output formats, supported formats such as table,
4735                         csv, json, yaml. It is of type STRING. By
4736                         default, it is table.
4737  -s | --long            whether to print all attributes or only short
4738                         attributes. It is of type BOOL. By default, it is
4739                         false.
4740  -t | --no-title        whether to print title or not. It is of type
4741                         BOOL. By default, it is false.
4742  -a | --no-auth         whether to authenticate user or not. It is of
4743                         type BOOL. By default, it is false.
4744
4745
4746 Results::
4747
4748  vnfm-id            Onap vnfm id and is of type STRING.
4749  vim-id             Onap vnfm id and is of type STRING.
4750  certificate-url    Onap vnfm certificate-url and is of type STRING.
4751  resource-version   Onap vnfm resource version and is of type STRING.
4752
4753
4754 Error::
4755
4756  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
4757
4758
4759
4760 [57] vim-register
4761 -----------------------------------------------
4762
4763
4764 usage: onap vim-register
4765
4766 Register a VIM under a given cloud region in Onap
4767
4768 Onap service: aai v11
4769
4770 Options::
4771
4772  [-x | --cloud-name] [-y | --region-name] [-z | --vim-id]
4773  [-b | --name] [-c | --type] [-e | --vendor]
4774  [-q | --vim-version] [-g | --url] [-i | --username]
4775  [-j | --password] [-k | --ssl-cacert] [-l | --ssl-insecure]
4776  [-n | --cloud-domain] [-o | --default-tenant] [-u | --onap-username]
4777  [-p | --onap-password] [-m | --host-url] [-h | --help]
4778  [-v | --version] [-d | --debug] [-f | --format]
4779  [-s | --long] [-t | --no-title] [-a | --no-auth]
4780
4781 where::
4782
4783  -x | --cloud-name      Onap cloud name. It is of type STRING.
4784  -y | --region-name     Onap  region name. It is of type STRING.
4785  -z | --vim-id          Onap VIM unique id. It is of type UUID. By
4786                         default, it is
4787                         545935b3-ca9c-4cbf-bfb4-4a7297010aff.
4788  -b | --name            Onap VIM name. It is of type STRING.
4789  -c | --type            Onap VIM type. It is of type STRING.
4790  -e | --vendor          Onap VIM vendor. It is of type STRING.
4791  -q | --vim-version     Onap VIM version. It is of type STRING.
4792  -g | --url             Onap VIM URL. It is of type STRING.
4793  -i | --username        Onap VIM username. It is of type STRING.
4794  -j | --password        Onap VIM password. It is of type STRING.
4795  -k | --ssl-cacert      Onap VIM SSL certificate. It is of type TEXT. It
4796                         is optional.
4797  -l | --ssl-insecure    Onap VIM insecure. It is of type BOOL. It is
4798                         optional. By default, it is false.
4799  -n | --cloud-domain    Onap VIM cloud domain. It is of type STRING.
4800  -o | --default-tenant  Onap VIM default tenant. It is of type STRING.
4801  -u | --onap-username   Onap user name. It is of type STRING. By default,
4802                         it is read from environment variable
4803                         ONAP_USERNAME.
4804  -p | --onap-password   Onap user password. It is of type STRING. By
4805                         default, it is read from environment variable
4806                         ONAP_PASSWORD. Secured.
4807  -m | --host-url        Onap host url. It is of type URL. By default, it
4808                         is read from environment variable ONAP_HOST_URL.
4809  -h | --help            Onap command help message. It is of type STRING.
4810                         By default, it is false.
4811  -v | --version         Onap command service version. It is of type
4812                         STRING. By default, it is false.
4813  -d | --debug           Enable debug output. It is of type BOOL. By
4814                         default, it is false.
4815  -f | --format          Output formats, supported formats such as table,
4816                         csv, json, yaml. It is of type STRING. By
4817                         default, it is table.
4818  -s | --long            whether to print all attributes or only short
4819                         attributes. It is of type BOOL. By default, it is
4820                         false.
4821  -t | --no-title        whether to print title or not. It is of type
4822                         BOOL. By default, it is false.
4823  -a | --no-auth         whether to authenticate user or not. It is of
4824                         type BOOL. By default, it is false.
4825
4826
4827 Error::
4828
4829  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
4830
4831
4832
4833 [58] vim-unregister
4834 -----------------------------------------------
4835
4836
4837 usage: onap vim-unregister
4838
4839 Un-register a VIM under from cloud region in Onap
4840
4841 Onap service: aai v11
4842
4843 Options::
4844
4845  [-x | --cloud-name] [-y | --region-name] [-z | --vim-id]
4846  [-b | --resource-version] [-u | --onap-username] [-p | --onap-password]
4847  [-m | --host-url] [-h | --help] [-v | --version]
4848  [-d | --debug] [-f | --format] [-s | --long]
4849  [-t | --no-title] [-a | --no-auth]
4850
4851 where::
4852
4853  -x | --cloud-name        Onap cloud name. It is of type STRING.
4854  -y | --region-name       Onap  region name. It is of type STRING.
4855  -z | --vim-id            Onap VIM unique id. It is of type UUID. By
4856                           default, it is
4857                           0e129921-5700-48e2-ab9a-e4e4208d8b6b.
4858  -b | --resource-version  Onap vim resource version. It is of type STRING.
4859                           It is optional.
4860  -u | --onap-username     Onap user name. It is of type STRING. By default,
4861                           it is read from environment variable
4862                           ONAP_USERNAME.
4863  -p | --onap-password     Onap user password. It is of type STRING. By
4864                           default, it is read from environment variable
4865                           ONAP_PASSWORD. Secured.
4866  -m | --host-url          Onap host url. It is of type URL. By default, it
4867                           is read from environment variable ONAP_HOST_URL.
4868  -h | --help              Onap command help message. It is of type STRING.
4869                           By default, it is false.
4870  -v | --version           Onap command service version. It is of type
4871                           STRING. By default, it is false.
4872  -d | --debug             Enable debug output. It is of type BOOL. By
4873                           default, it is false.
4874  -f | --format            Output formats, supported formats such as table,
4875                           csv, json, yaml. It is of type STRING. By
4876                           default, it is table.
4877  -s | --long              whether to print all attributes or only short
4878                           attributes. It is of type BOOL. By default, it is
4879                           false.
4880  -t | --no-title          whether to print title or not. It is of type
4881                           BOOL. By default, it is false.
4882  -a | --no-auth           whether to authenticate user or not. It is of
4883                           type BOOL. By default, it is false.
4884
4885
4886 Error::
4887
4888  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
4889
4890
4891
4892 [59] vim-list
4893 -----------------------------------------------
4894
4895
4896 usage: onap vim-list
4897
4898 List the configured vims
4899
4900 Onap service: aai v11
4901
4902 Options::
4903
4904  [-x | --cloud-name] [-y | --region-name] [-u | --onap-username]
4905  [-p | --onap-password] [-m | --host-url] [-h | --help]
4906  [-v | --version] [-d | --debug] [-f | --format]
4907  [-s | --long] [-t | --no-title] [-a | --no-auth]
4908
4909 where::
4910
4911  -x | --cloud-name      Onap cloud name. It is of type STRING.
4912  -y | --region-name     Onap  region name. It is of type STRING.
4913  -u | --onap-username   Onap user name. It is of type STRING. By default,
4914                         it is read from environment variable
4915                         ONAP_USERNAME.
4916  -p | --onap-password   Onap user password. It is of type STRING. By
4917                         default, it is read from environment variable
4918                         ONAP_PASSWORD. Secured.
4919  -m | --host-url        Onap host url. It is of type URL. By default, it
4920                         is read from environment variable ONAP_HOST_URL.
4921  -h | --help            Onap command help message. It is of type STRING.
4922                         By default, it is false.
4923  -v | --version         Onap command service version. It is of type
4924                         STRING. By default, it is false.
4925  -d | --debug           Enable debug output. It is of type BOOL. By
4926                         default, it is false.
4927  -f | --format          Output formats, supported formats such as table,
4928                         csv, json, yaml. It is of type STRING. By
4929                         default, it is table.
4930  -s | --long            whether to print all attributes or only short
4931                         attributes. It is of type BOOL. By default, it is
4932                         false.
4933  -t | --no-title        whether to print title or not. It is of type
4934                         BOOL. By default, it is false.
4935  -a | --no-auth         whether to authenticate user or not. It is of
4936                         type BOOL. By default, it is false.
4937
4938
4939 Results::
4940
4941  vim-id             Onap vim id and is of type STRING.
4942  name               Onap vim name and is of type STRING.
4943  type               Onap vim type and is of type STRING.
4944  vendor             Onap vim vendor and is of type STRING.
4945  version            Onap vim version and is of type STRING.
4946  url                Onap vim url and is of type STRING.
4947  username           Onap vim username and is of type STRING.
4948  cloud-domain       Onap vim cloud domain and is of type STRING.
4949  default-tenant     Onap vim tenant and is of type STRING.
4950  resource-version   Onap vim resource version and is of type STRING.
4951
4952
4953 Error::
4954
4955  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
4956
4957
4958
4959 [60] ems-list
4960 -----------------------------------------------
4961
4962
4963 usage: onap ems-list
4964
4965 List the configured ems
4966
4967 Onap service: aai v11
4968
4969 Options::
4970
4971  [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
4972  [-h | --help] [-v | --version] [-d | --debug]
4973  [-f | --format] [-s | --long] [-t | --no-title]
4974  [-a | --no-auth]
4975
4976 where::
4977
4978  -u | --onap-username   Onap user name. It is of type STRING. By default,
4979                         it is read from environment variable
4980                         ONAP_USERNAME.
4981  -p | --onap-password   Onap user password. It is of type STRING. By
4982                         default, it is read from environment variable
4983                         ONAP_PASSWORD. Secured.
4984  -m | --host-url        Onap host url. It is of type URL. By default, it
4985                         is read from environment variable ONAP_HOST_URL.
4986  -h | --help            Onap command help message. It is of type STRING.
4987                         By default, it is false.
4988  -v | --version         Onap command service version. It is of type
4989                         STRING. By default, it is false.
4990  -d | --debug           Enable debug output. It is of type BOOL. By
4991                         default, it is false.
4992  -f | --format          Output formats, supported formats such as table,
4993                         csv, json, yaml. It is of type STRING. By
4994                         default, it is table.
4995  -s | --long            whether to print all attributes or only short
4996                         attributes. It is of type BOOL. By default, it is
4997                         false.
4998  -t | --no-title        whether to print title or not. It is of type
4999                         BOOL. By default, it is false.
5000  -a | --no-auth         whether to authenticate user or not. It is of
5001                         type BOOL. By default, it is false.
5002
5003
5004 Results::
5005
5006  ems-id             Onap ems id and is of type STRING.
5007  resource-version   Onap ems resource version and is of type STRING.
5008
5009
5010 Error::
5011
5012  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
5013
5014
5015
5016 [61] ems-register
5017 -----------------------------------------------
5018
5019
5020 usage: onap ems-register
5021
5022 Register a EMS in Onap
5023
5024 Onap service: aai v11
5025
5026 Options::
5027
5028  [-z | --ems-id] [-b | --name] [-c | --type]
5029  [-e | --vendor] [-q | --ems-version] [-g | --url]
5030  [-i | --username] [-j | --password] [-x | --remote-path]
5031  [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
5032  [-h | --help] [-v | --version] [-d | --debug]
5033  [-f | --format] [-s | --long] [-t | --no-title]
5034  [-a | --no-auth]
5035
5036 where::
5037
5038  -z | --ems-id          Onap EMS unique id. It is of type UUID. By
5039                         default, it is
5040                         0f51b629-46dd-4c1d-bc23-c76d84e72bc2.
5041  -b | --name            Onap EMS name. It is of type STRING.
5042  -c | --type            Onap EMS type. It is of type STRING.
5043  -e | --vendor          Onap EMS vendor. It is of type STRING.
5044  -q | --ems-version     Onap EMS version. It is of type STRING.
5045  -g | --url             Onap EMS URL. It is of type STRING.
5046  -i | --username        Onap EMS username. It is of type STRING.
5047  -j | --password        Onap EMS password. It is of type STRING.
5048  -x | --remote-path     Onap EMS remote-path. It is of type STRING.
5049  -u | --onap-username   Onap user name. It is of type STRING. By default,
5050                         it is read from environment variable
5051                         ONAP_USERNAME.
5052  -p | --onap-password   Onap user password. It is of type STRING. By
5053                         default, it is read from environment variable
5054                         ONAP_PASSWORD. Secured.
5055  -m | --host-url        Onap host url. It is of type URL. By default, it
5056                         is read from environment variable ONAP_HOST_URL.
5057  -h | --help            Onap command help message. It is of type STRING.
5058                         By default, it is false.
5059  -v | --version         Onap command service version. It is of type
5060                         STRING. By default, it is false.
5061  -d | --debug           Enable debug output. It is of type BOOL. By
5062                         default, it is false.
5063  -f | --format          Output formats, supported formats such as table,
5064                         csv, json, yaml. It is of type STRING. By
5065                         default, it is table.
5066  -s | --long            whether to print all attributes or only short
5067                         attributes. It is of type BOOL. By default, it is
5068                         false.
5069  -t | --no-title        whether to print title or not. It is of type
5070                         BOOL. By default, it is false.
5071  -a | --no-auth         whether to authenticate user or not. It is of
5072                         type BOOL. By default, it is false.
5073
5074
5075 Error::
5076
5077  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
5078
5079
5080
5081 [62] ems-show
5082 -----------------------------------------------
5083
5084
5085 usage: onap ems-show
5086
5087 Show the details of configured ems
5088
5089 Onap service: aai v11
5090
5091 Options::
5092
5093  [-x | --ems-id] [-u | --onap-username] [-p | --onap-password]
5094  [-m | --host-url] [-h | --help] [-v | --version]
5095  [-d | --debug] [-f | --format] [-s | --long]
5096  [-t | --no-title] [-a | --no-auth]
5097
5098 where::
5099
5100  -x | --ems-id          Onap EMS unique id. It is of type UUID. By
5101                         default, it is
5102                         9b59cd0e-43c1-47d3-b943-4c9c23f49732.
5103  -u | --onap-username   Onap user name. It is of type STRING. By default,
5104                         it is read from environment variable
5105                         ONAP_USERNAME.
5106  -p | --onap-password   Onap user password. It is of type STRING. By
5107                         default, it is read from environment variable
5108                         ONAP_PASSWORD. Secured.
5109  -m | --host-url        Onap host url. It is of type URL. By default, it
5110                         is read from environment variable ONAP_HOST_URL.
5111  -h | --help            Onap command help message. It is of type STRING.
5112                         By default, it is false.
5113  -v | --version         Onap command service version. It is of type
5114                         STRING. By default, it is false.
5115  -d | --debug           Enable debug output. It is of type BOOL. By
5116                         default, it is false.
5117  -f | --format          Output formats, supported formats such as table,
5118                         csv, json, yaml. It is of type STRING. By
5119                         default, it is table.
5120  -s | --long            whether to print all attributes or only short
5121                         attributes. It is of type BOOL. By default, it is
5122                         false.
5123  -t | --no-title        whether to print title or not. It is of type
5124                         BOOL. By default, it is false.
5125  -a | --no-auth         whether to authenticate user or not. It is of
5126                         type BOOL. By default, it is false.
5127
5128
5129 Results::
5130
5131  name       Onap ems name and is of type STRING.
5132  type       Onap ems type and is of type STRING.
5133  vendor     Onap ems vendor and is of type STRING.
5134  version    Onap ems version and is of type STRING.
5135  url        Onap ems url and is of type STRING.
5136  username   Onap ems username and is of type STRING.
5137
5138
5139 Error::
5140
5141  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
5142
5143
5144
5145 [63] cloud-delete
5146 -----------------------------------------------
5147
5148
5149 usage: onap cloud-delete
5150
5151 Delete a cloud region from Onap
5152
5153 Onap service: aai v11
5154
5155 Options::
5156
5157  [-x | --cloud-name] [-y | --region-name] [-z | --resource-version]
5158  [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
5159  [-h | --help] [-v | --version] [-d | --debug]
5160  [-f | --format] [-s | --long] [-t | --no-title]
5161  [-a | --no-auth]
5162
5163 where::
5164
5165  -x | --cloud-name        Onap cloud name. It is of type STRING.
5166  -y | --region-name       Onap cloud region name. It is of type STRING.
5167  -z | --resource-version  Onap cloud region version. It is of type UUID. It
5168                           is optional. By default, it is
5169                           efef37f1-f030-4bd2-b699-0a0e9c0ceb54.
5170  -u | --onap-username     Onap user name. It is of type STRING. By default,
5171                           it is read from environment variable
5172                           ONAP_USERNAME.
5173  -p | --onap-password     Onap user password. It is of type STRING. By
5174                           default, it is read from environment variable
5175                           ONAP_PASSWORD. Secured.
5176  -m | --host-url          Onap host url. It is of type URL. By default, it
5177                           is read from environment variable ONAP_HOST_URL.
5178  -h | --help              Onap command help message. It is of type STRING.
5179                           By default, it is false.
5180  -v | --version           Onap command service version. It is of type
5181                           STRING. By default, it is false.
5182  -d | --debug             Enable debug output. It is of type BOOL. By
5183                           default, it is false.
5184  -f | --format            Output formats, supported formats such as table,
5185                           csv, json, yaml. It is of type STRING. By
5186                           default, it is table.
5187  -s | --long              whether to print all attributes or only short
5188                           attributes. It is of type BOOL. By default, it is
5189                           false.
5190  -t | --no-title          whether to print title or not. It is of type
5191                           BOOL. By default, it is false.
5192  -a | --no-auth           whether to authenticate user or not. It is of
5193                           type BOOL. By default, it is false.
5194
5195
5196 Error::
5197
5198  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
5199
5200
5201
5202 [64] ems-unregister
5203 -----------------------------------------------
5204
5205
5206 usage: onap ems-unregister
5207
5208 Un-register a EMS in Onap
5209
5210 Onap service: aai v11
5211
5212 Options::
5213
5214  [-x | --ems-id] [-y | --resource-version] [-u | --onap-username]
5215  [-p | --onap-password] [-m | --host-url] [-h | --help]
5216  [-v | --version] [-d | --debug] [-f | --format]
5217  [-s | --long] [-t | --no-title] [-a | --no-auth]
5218
5219 where::
5220
5221  -x | --ems-id            Onap EMS unique id. It is of type UUID. By
5222                           default, it is
5223                           3158d92f-e37b-450c-a86e-55c19309c3d3.
5224  -y | --resource-version  Onap vim resource version. It is of type STRING.
5225                           It is optional.
5226  -u | --onap-username     Onap user name. It is of type STRING. By default,
5227                           it is read from environment variable
5228                           ONAP_USERNAME.
5229  -p | --onap-password     Onap user password. It is of type STRING. By
5230                           default, it is read from environment variable
5231                           ONAP_PASSWORD. Secured.
5232  -m | --host-url          Onap host url. It is of type URL. By default, it
5233                           is read from environment variable ONAP_HOST_URL.
5234  -h | --help              Onap command help message. It is of type STRING.
5235                           By default, it is false.
5236  -v | --version           Onap command service version. It is of type
5237                           STRING. By default, it is false.
5238  -d | --debug             Enable debug output. It is of type BOOL. By
5239                           default, it is false.
5240  -f | --format            Output formats, supported formats such as table,
5241                           csv, json, yaml. It is of type STRING. By
5242                           default, it is table.
5243  -s | --long              whether to print all attributes or only short
5244                           attributes. It is of type BOOL. By default, it is
5245                           false.
5246  -t | --no-title          whether to print title or not. It is of type
5247                           BOOL. By default, it is false.
5248  -a | --no-auth           whether to authenticate user or not. It is of
5249                           type BOOL. By default, it is false.
5250
5251
5252 Error::
5253
5254  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
5255
5256
5257
5258 [65] subscription-list
5259 -----------------------------------------------
5260
5261
5262 usage: onap subscription-list
5263
5264 Lists the subscription for a given customer in Onap
5265
5266 Onap service: aai v11
5267
5268 Options::
5269
5270  [-x | --customer-name] [-u | --onap-username] [-p | --onap-password]
5271  [-m | --host-url] [-h | --help] [-v | --version]
5272  [-d | --debug] [-f | --format] [-s | --long]
5273  [-t | --no-title] [-a | --no-auth]
5274
5275 where::
5276
5277  -x | --customer-name   Onap customer name. It is of type STRING.
5278  -u | --onap-username   Onap user name. It is of type STRING. By default,
5279                         it is read from environment variable
5280                         ONAP_USERNAME.
5281  -p | --onap-password   Onap user password. It is of type STRING. By
5282                         default, it is read from environment variable
5283                         ONAP_PASSWORD. Secured.
5284  -m | --host-url        Onap host url. It is of type URL. By default, it
5285                         is read from environment variable ONAP_HOST_URL.
5286  -h | --help            Onap command help message. It is of type STRING.
5287                         By default, it is false.
5288  -v | --version         Onap command service version. It is of type
5289                         STRING. By default, it is false.
5290  -d | --debug           Enable debug output. It is of type BOOL. By
5291                         default, it is false.
5292  -f | --format          Output formats, supported formats such as table,
5293                         csv, json, yaml. It is of type STRING. By
5294                         default, it is table.
5295  -s | --long            whether to print all attributes or only short
5296                         attributes. It is of type BOOL. By default, it is
5297                         false.
5298  -t | --no-title        whether to print title or not. It is of type
5299                         BOOL. By default, it is false.
5300  -a | --no-auth         whether to authenticate user or not. It is of
5301                         type BOOL. By default, it is false.
5302
5303
5304 Results::
5305
5306  service-type       Onap service type and is of type STRING.
5307  resource-version   Onap subscription resource version and is of type
5308                     STRING.
5309  tenant             Onap tenant name and is of type STRING.
5310  region             Onap region name and is of type STRING.
5311  cloud              Onap cloud name and is of type STRING.
5312
5313
5314 Error::
5315
5316  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
5317
5318
5319
5320 [66] subscription-create
5321 -----------------------------------------------
5322
5323
5324 usage: onap subscription-create
5325
5326 Create a subscription of a customer for given service in specific cloud region in Onap
5327
5328 Onap service: aai v11
5329
5330 Options::
5331
5332  [-x | --customer-name] [-z | --cloud-name] [-r | --cloud-region]
5333  [-c | --cloud-tenant-id] [-e | --service-type] [-u | --onap-username]
5334  [-p | --onap-password] [-m | --host-url] [-h | --help]
5335  [-v | --version] [-d | --debug] [-f | --format]
5336  [-s | --long] [-t | --no-title] [-a | --no-auth]
5337
5338 where::
5339
5340  -x | --customer-name     Onap customer name. It is of type STRING.
5341  -z | --cloud-name        Onap cloud name. It is of type STRING.
5342  -r | --cloud-region      Onap cloud region. It is of type STRING.
5343  -c | --cloud-tenant-id   Onap cloud tenant id. It is of type STRING.
5344  -e | --service-type      Onap service type. It is of type STRING.
5345  -u | --onap-username     Onap user name. It is of type STRING. By default,
5346                           it is read from environment variable
5347                           ONAP_USERNAME.
5348  -p | --onap-password     Onap user password. It is of type STRING. By
5349                           default, it is read from environment variable
5350                           ONAP_PASSWORD. Secured.
5351  -m | --host-url          Onap host url. It is of type URL. By default, it
5352                           is read from environment variable ONAP_HOST_URL.
5353  -h | --help              Onap command help message. It is of type STRING.
5354                           By default, it is false.
5355  -v | --version           Onap command service version. It is of type
5356                           STRING. By default, it is false.
5357  -d | --debug             Enable debug output. It is of type BOOL. By
5358                           default, it is false.
5359  -f | --format            Output formats, supported formats such as table,
5360                           csv, json, yaml. It is of type STRING. By
5361                           default, it is table.
5362  -s | --long              whether to print all attributes or only short
5363                           attributes. It is of type BOOL. By default, it is
5364                           false.
5365  -t | --no-title          whether to print title or not. It is of type
5366                           BOOL. By default, it is false.
5367  -a | --no-auth           whether to authenticate user or not. It is of
5368                           type BOOL. By default, it is false.
5369
5370
5371 Error::
5372
5373  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
5374
5375
5376
5377 [67] subscription-delete
5378 -----------------------------------------------
5379
5380
5381 usage: onap subscription-delete
5382
5383 Delete the subscription for a given customer in Onap
5384
5385 Onap service: aai v11
5386
5387 Options::
5388
5389  [-x | --customer-name] [-y | --service-type] [-g | --resource-version]
5390  [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
5391  [-h | --help] [-v | --version] [-d | --debug]
5392  [-f | --format] [-s | --long] [-t | --no-title]
5393  [-a | --no-auth]
5394
5395 where::
5396
5397  -x | --customer-name     Onap customer name. It is of type STRING.
5398  -y | --service-type      Onap subscribtion id. It is of type STRING.
5399  -g | --resource-version  Onap subscription resource version. It is of type
5400                           STRING. It is optional.
5401  -u | --onap-username     Onap user name. It is of type STRING. By default,
5402                           it is read from environment variable
5403                           ONAP_USERNAME.
5404  -p | --onap-password     Onap user password. It is of type STRING. By
5405                           default, it is read from environment variable
5406                           ONAP_PASSWORD. Secured.
5407  -m | --host-url          Onap host url. It is of type URL. By default, it
5408                           is read from environment variable ONAP_HOST_URL.
5409  -h | --help              Onap command help message. It is of type STRING.
5410                           By default, it is false.
5411  -v | --version           Onap command service version. It is of type
5412                           STRING. By default, it is false.
5413  -d | --debug             Enable debug output. It is of type BOOL. By
5414                           default, it is false.
5415  -f | --format            Output formats, supported formats such as table,
5416                           csv, json, yaml. It is of type STRING. By
5417                           default, it is table.
5418  -s | --long              whether to print all attributes or only short
5419                           attributes. It is of type BOOL. By default, it is
5420                           false.
5421  -t | --no-title          whether to print title or not. It is of type
5422                           BOOL. By default, it is false.
5423  -a | --no-auth           whether to authenticate user or not. It is of
5424                           type BOOL. By default, it is false.
5425
5426
5427 Error::
5428
5429  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
5430
5431
5432
5433 [68] customer-show
5434 -----------------------------------------------
5435
5436
5437 usage: onap customer-show
5438
5439 Lists the registetred customers in Onap
5440
5441 Onap service: aai v11
5442
5443 Options::
5444
5445  [-x | --customer-name] [-u | --onap-username] [-p | --onap-password]
5446  [-m | --host-url] [-h | --help] [-v | --version]
5447  [-d | --debug] [-f | --format] [-s | --long]
5448  [-t | --no-title] [-a | --no-auth]
5449
5450 where::
5451
5452  -x | --customer-name   Onap customer name. It is of type STRING.
5453  -u | --onap-username   Onap user name. It is of type STRING. By default,
5454                         it is read from environment variable
5455                         ONAP_USERNAME.
5456  -p | --onap-password   Onap user password. It is of type STRING. By
5457                         default, it is read from environment variable
5458                         ONAP_PASSWORD. Secured.
5459  -m | --host-url        Onap host url. It is of type URL. By default, it
5460                         is read from environment variable ONAP_HOST_URL.
5461  -h | --help            Onap command help message. It is of type STRING.
5462                         By default, it is false.
5463  -v | --version         Onap command service version. It is of type
5464                         STRING. By default, it is false.
5465  -d | --debug           Enable debug output. It is of type BOOL. By
5466                         default, it is false.
5467  -f | --format          Output formats, supported formats such as table,
5468                         csv, json, yaml. It is of type STRING. By
5469                         default, it is table.
5470  -s | --long            whether to print all attributes or only short
5471                         attributes. It is of type BOOL. By default, it is
5472                         false.
5473  -t | --no-title        whether to print title or not. It is of type
5474                         BOOL. By default, it is false.
5475  -a | --no-auth         whether to authenticate user or not. It is of
5476                         type BOOL. By default, it is false.
5477
5478
5479 Results::
5480
5481  name               Onap customer name and is of type STRING.
5482  subscriber-name    Onap subscriber name and is of type STRING.
5483  resource-version   Onap subscriber resource version and is of type
5484                     STRING.
5485  subscriber-type    Onap subscriber type and is of type STRING.
5486
5487
5488 Error::
5489
5490  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
5491
5492
5493
5494 [69] customer-create
5495 -----------------------------------------------
5496
5497
5498 usage: onap customer-create
5499
5500 Create a customer in Onap
5501
5502 Onap service: aai v11
5503
5504 Options::
5505
5506  [-x | --customer-name] [-y | --subscriber-name] [-u | --onap-username]
5507  [-p | --onap-password] [-m | --host-url] [-h | --help]
5508  [-v | --version] [-d | --debug] [-f | --format]
5509  [-s | --long] [-t | --no-title] [-a | --no-auth]
5510
5511 where::
5512
5513  -x | --customer-name     Onap customer name. It is of type STRING.
5514  -y | --subscriber-name   Onap subscriber name. It is of type STRING.
5515  -u | --onap-username     Onap user name. It is of type STRING. By default,
5516                           it is read from environment variable
5517                           ONAP_USERNAME.
5518  -p | --onap-password     Onap user password. It is of type STRING. By
5519                           default, it is read from environment variable
5520                           ONAP_PASSWORD. Secured.
5521  -m | --host-url          Onap host url. It is of type URL. By default, it
5522                           is read from environment variable ONAP_HOST_URL.
5523  -h | --help              Onap command help message. It is of type STRING.
5524                           By default, it is false.
5525  -v | --version           Onap command service version. It is of type
5526                           STRING. By default, it is false.
5527  -d | --debug             Enable debug output. It is of type BOOL. By
5528                           default, it is false.
5529  -f | --format            Output formats, supported formats such as table,
5530                           csv, json, yaml. It is of type STRING. By
5531                           default, it is table.
5532  -s | --long              whether to print all attributes or only short
5533                           attributes. It is of type BOOL. By default, it is
5534                           false.
5535  -t | --no-title          whether to print title or not. It is of type
5536                           BOOL. By default, it is false.
5537  -a | --no-auth           whether to authenticate user or not. It is of
5538                           type BOOL. By default, it is false.
5539
5540
5541 Error::
5542
5543  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
5544
5545
5546
5547 [70] customer-delete
5548 -----------------------------------------------
5549
5550
5551 usage: onap customer-delete
5552
5553 Delete a customer from Onap
5554
5555 Onap service: aai v11
5556
5557 Options::
5558
5559  [-x | --customer-name] [-y | --resource-version] [-u | --onap-username]
5560  [-p | --onap-password] [-m | --host-url] [-h | --help]
5561  [-v | --version] [-d | --debug] [-f | --format]
5562  [-s | --long] [-t | --no-title] [-a | --no-auth]
5563
5564 where::
5565
5566  -x | --customer-name     Onap customer name. It is of type STRING.
5567  -y | --resource-version  Onap customer resource version. It is of type
5568                           UUID. It is optional. By default, it is
5569                           99d76614-2e73-4aa2-9839-40cac60ccdd2.
5570  -u | --onap-username     Onap user name. It is of type STRING. By default,
5571                           it is read from environment variable
5572                           ONAP_USERNAME.
5573  -p | --onap-password     Onap user password. It is of type STRING. By
5574                           default, it is read from environment variable
5575                           ONAP_PASSWORD. Secured.
5576  -m | --host-url          Onap host url. It is of type URL. By default, it
5577                           is read from environment variable ONAP_HOST_URL.
5578  -h | --help              Onap command help message. It is of type STRING.
5579                           By default, it is false.
5580  -v | --version           Onap command service version. It is of type
5581                           STRING. By default, it is false.
5582  -d | --debug             Enable debug output. It is of type BOOL. By
5583                           default, it is false.
5584  -f | --format            Output formats, supported formats such as table,
5585                           csv, json, yaml. It is of type STRING. By
5586                           default, it is table.
5587  -s | --long              whether to print all attributes or only short
5588                           attributes. It is of type BOOL. By default, it is
5589                           false.
5590  -t | --no-title          whether to print title or not. It is of type
5591                           BOOL. By default, it is false.
5592  -a | --no-auth           whether to authenticate user or not. It is of
5593                           type BOOL. By default, it is false.
5594
5595
5596 Error::
5597
5598  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
5599
5600
5601
5602 [71] customer-list
5603 -----------------------------------------------
5604
5605
5606 usage: onap customer-list
5607
5608 Lists the registetred customers in Onap
5609
5610 Onap service: aai v11
5611
5612 Options::
5613
5614  [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
5615  [-h | --help] [-v | --version] [-d | --debug]
5616  [-f | --format] [-s | --long] [-t | --no-title]
5617  [-a | --no-auth]
5618
5619 where::
5620
5621  -u | --onap-username   Onap user name. It is of type STRING. By default,
5622                         it is read from environment variable
5623                         ONAP_USERNAME.
5624  -p | --onap-password   Onap user password. It is of type STRING. By
5625                         default, it is read from environment variable
5626                         ONAP_PASSWORD. Secured.
5627  -m | --host-url        Onap host url. It is of type URL. By default, it
5628                         is read from environment variable ONAP_HOST_URL.
5629  -h | --help            Onap command help message. It is of type STRING.
5630                         By default, it is false.
5631  -v | --version         Onap command service version. It is of type
5632                         STRING. By default, it is false.
5633  -d | --debug           Enable debug output. It is of type BOOL. By
5634                         default, it is false.
5635  -f | --format          Output formats, supported formats such as table,
5636                         csv, json, yaml. It is of type STRING. By
5637                         default, it is table.
5638  -s | --long            whether to print all attributes or only short
5639                         attributes. It is of type BOOL. By default, it is
5640                         false.
5641  -t | --no-title        whether to print title or not. It is of type
5642                         BOOL. By default, it is false.
5643  -a | --no-auth         whether to authenticate user or not. It is of
5644                         type BOOL. By default, it is false.
5645
5646
5647 Results::
5648
5649  name               Onap customer name and is of type STRING.
5650  resource-version   Onap customer resource version and is of type
5651                     STRING.
5652
5653
5654 Error::
5655
5656  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
5657
5658
5659
5660 [72] vf-list
5661 -----------------------------------------------
5662
5663
5664 usage: onap vf-list
5665
5666 List created VF instances for a service instance
5667
5668 Onap service: aai v11
5669
5670 Options::
5671
5672  [-x | --customer-name] [-y | --service-type] [-z | --service-id]
5673  [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
5674  [-h | --help] [-v | --version] [-d | --debug]
5675  [-f | --format] [-s | --long] [-t | --no-title]
5676  [-a | --no-auth]
5677
5678 where::
5679
5680  -x | --customer-name   customer name. It is of type STRING.
5681  -y | --service-type    service subscription type. It is of type STRING.
5682  -z | --service-id      service ID. It is of type STRING.
5683  -u | --onap-username   Onap user name. It is of type STRING. By default,
5684                         it is read from environment variable
5685                         ONAP_USERNAME.
5686  -p | --onap-password   Onap user password. It is of type STRING. By
5687                         default, it is read from environment variable
5688                         ONAP_PASSWORD. Secured.
5689  -m | --host-url        Onap host url. It is of type URL. By default, it
5690                         is read from environment variable ONAP_HOST_URL.
5691  -h | --help            Onap command help message. It is of type STRING.
5692                         By default, it is false.
5693  -v | --version         Onap command service version. It is of type
5694                         STRING. By default, it is false.
5695  -d | --debug           Enable debug output. It is of type BOOL. By
5696                         default, it is false.
5697  -f | --format          Output formats, supported formats such as table,
5698                         csv, json, yaml. It is of type STRING. By
5699                         default, it is table.
5700  -s | --long            whether to print all attributes or only short
5701                         attributes. It is of type BOOL. By default, it is
5702                         false.
5703  -t | --no-title        whether to print title or not. It is of type
5704                         BOOL. By default, it is false.
5705  -a | --no-auth         whether to authenticate user or not. It is of
5706                         type BOOL. By default, it is false.
5707
5708
5709 Results::
5710
5711  vf-id    VF ID for the given service and is of type STRING.
5712  vf-name  VF name and is of type STRING.
5713
5714
5715 Error::
5716
5717  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
5718
5719
5720
5721 [73] service-list
5722 -----------------------------------------------
5723
5724
5725 usage: onap service-list
5726
5727 List created service instance
5728
5729 Onap service: aai v11
5730
5731 Options::
5732
5733  [-x | --customer-name] [-y | --service-type] [-u | --onap-username]
5734  [-p | --onap-password] [-m | --host-url] [-h | --help]
5735  [-v | --version] [-d | --debug] [-f | --format]
5736  [-s | --long] [-t | --no-title] [-a | --no-auth]
5737
5738 where::
5739
5740  -x | --customer-name   customer name. It is of type STRING.
5741  -y | --service-type    service subscription type. It is of type STRING.
5742  -u | --onap-username   Onap user name. It is of type STRING. By default,
5743                         it is read from environment variable
5744                         ONAP_USERNAME.
5745  -p | --onap-password   Onap user password. It is of type STRING. By
5746                         default, it is read from environment variable
5747                         ONAP_PASSWORD. Secured.
5748  -m | --host-url        Onap host url. It is of type URL. By default, it
5749                         is read from environment variable ONAP_HOST_URL.
5750  -h | --help            Onap command help message. It is of type STRING.
5751                         By default, it is false.
5752  -v | --version         Onap command service version. It is of type
5753                         STRING. By default, it is false.
5754  -d | --debug           Enable debug output. It is of type BOOL. By
5755                         default, it is false.
5756  -f | --format          Output formats, supported formats such as table,
5757                         csv, json, yaml. It is of type STRING. By
5758                         default, it is table.
5759  -s | --long            whether to print all attributes or only short
5760                         attributes. It is of type BOOL. By default, it is
5761                         false.
5762  -t | --no-title        whether to print title or not. It is of type
5763                         BOOL. By default, it is false.
5764  -a | --no-auth         whether to authenticate user or not. It is of
5765                         type BOOL. By default, it is false.
5766
5767
5768 Results::
5769
5770  service-id           instance id of service and is of type STRING.
5771  service-name         Service name and is of type STRING.
5772  model-invariant-id   Model invariant id of service model and is of
5773                       type STRING.
5774  model-uuid           Model uuid for service model and is of type
5775                       STRING.
5776  description          service description and is of type STRING.
5777
5778
5779 Error::
5780
5781  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
5782
5783
5784
5785 [74] vf-show
5786 -----------------------------------------------
5787
5788
5789 usage: onap vf-show
5790
5791 Show details for VF
5792
5793 Onap service: aai v11
5794
5795 Options::
5796
5797  [-x | --vf-id] [-u | --onap-username] [-p | --onap-password]
5798  [-m | --host-url] [-h | --help] [-v | --version]
5799  [-d | --debug] [-f | --format] [-s | --long]
5800  [-t | --no-title] [-a | --no-auth]
5801
5802 where::
5803
5804  -x | --vf-id           VF identifier. It is of type STRING.
5805  -u | --onap-username   Onap user name. It is of type STRING. By default,
5806                         it is read from environment variable
5807                         ONAP_USERNAME.
5808  -p | --onap-password   Onap user password. It is of type STRING. By
5809                         default, it is read from environment variable
5810                         ONAP_PASSWORD. Secured.
5811  -m | --host-url        Onap host url. It is of type URL. By default, it
5812                         is read from environment variable ONAP_HOST_URL.
5813  -h | --help            Onap command help message. It is of type STRING.
5814                         By default, it is false.
5815  -v | --version         Onap command service version. It is of type
5816                         STRING. By default, it is false.
5817  -d | --debug           Enable debug output. It is of type BOOL. By
5818                         default, it is false.
5819  -f | --format          Output formats, supported formats such as table,
5820                         csv, json, yaml. It is of type STRING. By
5821                         default, it is table.
5822  -s | --long            whether to print all attributes or only short
5823                         attributes. It is of type BOOL. By default, it is
5824                         false.
5825  -t | --no-title        whether to print title or not. It is of type
5826                         BOOL. By default, it is false.
5827  -a | --no-auth         whether to authenticate user or not. It is of
5828                         type BOOL. By default, it is false.
5829
5830
5831 Results::
5832
5833  vf-id                    VF ID for the given service and is of type STRING.
5834  vf-name                  VF name and is of type STRING.
5835  vf-type                  VF name and is of type STRING.
5836  model-invariant-id       VF name and is of type STRING.
5837  model-uuid               model uuid and is of type STRING.
5838  model-customization-id   Model customization id and is of type STRING.
5839  service-id               Service ID of parent service and is of type
5840                           STRING.
5841
5842
5843 Error::
5844
5845  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
5846
5847
5848
5849 [75] tenant-create
5850 -----------------------------------------------
5851
5852
5853 usage: onap tenant-create
5854
5855 Create a tenant under given cloud region in Onap
5856
5857 Onap service: aai v11
5858
5859 Options::
5860
5861  [-x | --cloud] [-y | --region] [-z | --tenant-id]
5862  [-r | --tenant-name] [-u | --onap-username] [-p | --onap-password]
5863  [-m | --host-url] [-h | --help] [-v | --version]
5864  [-d | --debug] [-f | --format] [-s | --long]
5865  [-t | --no-title] [-a | --no-auth]
5866
5867 where::
5868
5869  -x | --cloud           Onap cloud. It is of type STRING.
5870  -y | --region          Onap cloud region. It is of type STRING.
5871  -z | --tenant-id       Onap cloud tenant id. It is of type STRING.
5872  -r | --tenant-name     Onap cloud tenant name. It is of type STRING.
5873  -u | --onap-username   Onap user name. It is of type STRING. By default,
5874                         it is read from environment variable
5875                         ONAP_USERNAME.
5876  -p | --onap-password   Onap user password. It is of type STRING. By
5877                         default, it is read from environment variable
5878                         ONAP_PASSWORD. Secured.
5879  -m | --host-url        Onap host url. It is of type URL. By default, it
5880                         is read from environment variable ONAP_HOST_URL.
5881  -h | --help            Onap command help message. It is of type STRING.
5882                         By default, it is false.
5883  -v | --version         Onap command service version. It is of type
5884                         STRING. By default, it is false.
5885  -d | --debug           Enable debug output. It is of type BOOL. By
5886                         default, it is false.
5887  -f | --format          Output formats, supported formats such as table,
5888                         csv, json, yaml. It is of type STRING. By
5889                         default, it is table.
5890  -s | --long            whether to print all attributes or only short
5891                         attributes. It is of type BOOL. By default, it is
5892                         false.
5893  -t | --no-title        whether to print title or not. It is of type
5894                         BOOL. By default, it is false.
5895  -a | --no-auth         whether to authenticate user or not. It is of
5896                         type BOOL. By default, it is false.
5897
5898
5899 Error::
5900
5901  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
5902
5903
5904
5905 [76] tenant-list
5906 -----------------------------------------------
5907
5908
5909 usage: onap tenant-list
5910
5911 Lists the tenants under given cloud region in Onap
5912
5913 Onap service: aai v11
5914
5915 Options::
5916
5917  [-x | --cloud] [-y | --region] [-u | --onap-username]
5918  [-p | --onap-password] [-m | --host-url] [-h | --help]
5919  [-v | --version] [-d | --debug] [-f | --format]
5920  [-s | --long] [-t | --no-title] [-a | --no-auth]
5921
5922 where::
5923
5924  -x | --cloud           Onap cloud. It is of type STRING.
5925  -y | --region          Onap cloud region. It is of type STRING.
5926  -u | --onap-username   Onap user name. It is of type STRING. By default,
5927                         it is read from environment variable
5928                         ONAP_USERNAME.
5929  -p | --onap-password   Onap user password. It is of type STRING. By
5930                         default, it is read from environment variable
5931                         ONAP_PASSWORD. Secured.
5932  -m | --host-url        Onap host url. It is of type URL. By default, it
5933                         is read from environment variable ONAP_HOST_URL.
5934  -h | --help            Onap command help message. It is of type STRING.
5935                         By default, it is false.
5936  -v | --version         Onap command service version. It is of type
5937                         STRING. By default, it is false.
5938  -d | --debug           Enable debug output. It is of type BOOL. By
5939                         default, it is false.
5940  -f | --format          Output formats, supported formats such as table,
5941                         csv, json, yaml. It is of type STRING. By
5942                         default, it is table.
5943  -s | --long            whether to print all attributes or only short
5944                         attributes. It is of type BOOL. By default, it is
5945                         false.
5946  -t | --no-title        whether to print title or not. It is of type
5947                         BOOL. By default, it is false.
5948  -a | --no-auth         whether to authenticate user or not. It is of
5949                         type BOOL. By default, it is false.
5950
5951
5952 Results::
5953
5954  tenant-id          Onap tenant-id and is of type STRING.
5955  tenant-name        Onap tenant name and is of type STRING.
5956  resource-version   Onap tenant resource version and is of type
5957                     STRING.
5958
5959
5960 Error::
5961
5962  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
5963
5964
5965
5966 [77] tenant-delete
5967 -----------------------------------------------
5968
5969
5970 usage: onap tenant-delete
5971
5972 Delete tenant under given cloud region in Onap
5973
5974 Onap service: aai v11
5975
5976 Options::
5977
5978  [-x | --cloud] [-y | --region] [-z | --tenant-id]
5979  [-r | --resource-version] [-u | --onap-username] [-p | --onap-password]
5980  [-m | --host-url] [-h | --help] [-v | --version]
5981  [-d | --debug] [-f | --format] [-s | --long]
5982  [-t | --no-title] [-a | --no-auth]
5983
5984 where::
5985
5986  -x | --cloud             Onap cloud. It is of type STRING.
5987  -y | --region            Onap cloud region. It is of type STRING.
5988  -z | --tenant-id         Onap cloud tenant id. It is of type STRING.
5989  -r | --resource-version  Onap cloud tenant version. It is of type UUID. It
5990                           is optional. By default, it is
5991                           c22f376e-03fb-49f9-982c-9887b4e5da10.
5992  -u | --onap-username     Onap user name. It is of type STRING. By default,
5993                           it is read from environment variable
5994                           ONAP_USERNAME.
5995  -p | --onap-password     Onap user password. It is of type STRING. By
5996                           default, it is read from environment variable
5997                           ONAP_PASSWORD. Secured.
5998  -m | --host-url          Onap host url. It is of type URL. By default, it
5999                           is read from environment variable ONAP_HOST_URL.
6000  -h | --help              Onap command help message. It is of type STRING.
6001                           By default, it is false.
6002  -v | --version           Onap command service version. It is of type
6003                           STRING. By default, it is false.
6004  -d | --debug             Enable debug output. It is of type BOOL. By
6005                           default, it is false.
6006  -f | --format            Output formats, supported formats such as table,
6007                           csv, json, yaml. It is of type STRING. By
6008                           default, it is table.
6009  -s | --long              whether to print all attributes or only short
6010                           attributes. It is of type BOOL. By default, it is
6011                           false.
6012  -t | --no-title          whether to print title or not. It is of type
6013                           BOOL. By default, it is false.
6014  -a | --no-auth           whether to authenticate user or not. It is of
6015                           type BOOL. By default, it is false.
6016
6017
6018 Error::
6019
6020  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
6021
6022
6023
6024 [78] service-type-list
6025 -----------------------------------------------
6026
6027
6028 usage: onap service-type-list
6029
6030 List the service types configured in Onap
6031
6032 Onap service: aai v11
6033
6034 Options::
6035
6036  [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
6037  [-h | --help] [-v | --version] [-d | --debug]
6038  [-f | --format] [-s | --long] [-t | --no-title]
6039  [-a | --no-auth]
6040
6041 where::
6042
6043  -u | --onap-username   Onap user name. It is of type STRING. By default,
6044                         it is read from environment variable
6045                         ONAP_USERNAME.
6046  -p | --onap-password   Onap user password. It is of type STRING. By
6047                         default, it is read from environment variable
6048                         ONAP_PASSWORD. Secured.
6049  -m | --host-url        Onap host url. It is of type URL. By default, it
6050                         is read from environment variable ONAP_HOST_URL.
6051  -h | --help            Onap command help message. It is of type STRING.
6052                         By default, it is false.
6053  -v | --version         Onap command service version. It is of type
6054                         STRING. By default, it is false.
6055  -d | --debug           Enable debug output. It is of type BOOL. By
6056                         default, it is false.
6057  -f | --format          Output formats, supported formats such as table,
6058                         csv, json, yaml. It is of type STRING. By
6059                         default, it is table.
6060  -s | --long            whether to print all attributes or only short
6061                         attributes. It is of type BOOL. By default, it is
6062                         false.
6063  -t | --no-title        whether to print title or not. It is of type
6064                         BOOL. By default, it is false.
6065  -a | --no-auth         whether to authenticate user or not. It is of
6066                         type BOOL. By default, it is false.
6067
6068
6069 Results::
6070
6071  service-type-id    Onap cloud service and is of type STRING.
6072  service-type       Onap cloud service and is of type STRING.
6073  resource-version   Onap cloud service resource version and is of
6074                     type STRING.
6075
6076
6077 Error::
6078
6079  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
6080
6081
6082
6083 [79] service-type-create
6084 -----------------------------------------------
6085
6086
6087 usage: onap service-type-create
6088
6089 Add a service type in Onap
6090
6091 Onap service: aai v11
6092
6093 Options::
6094
6095  [-x | --service-type] [-y | --service-type-id] [-u | --onap-username]
6096  [-p | --onap-password] [-m | --host-url] [-h | --help]
6097  [-v | --version] [-d | --debug] [-f | --format]
6098  [-s | --long] [-t | --no-title] [-a | --no-auth]
6099
6100 where::
6101
6102  -x | --service-type      Onap service type. It is of type STRING.
6103  -y | --service-type-id   Onap service type uuid. It is of type UUID. It is
6104                           optional. By default, it is
6105                           d4445250-ef8d-4d78-a1b8-21719383acf7.
6106  -u | --onap-username     Onap user name. It is of type STRING. By default,
6107                           it is read from environment variable
6108                           ONAP_USERNAME.
6109  -p | --onap-password     Onap user password. It is of type STRING. By
6110                           default, it is read from environment variable
6111                           ONAP_PASSWORD. Secured.
6112  -m | --host-url          Onap host url. It is of type URL. By default, it
6113                           is read from environment variable ONAP_HOST_URL.
6114  -h | --help              Onap command help message. It is of type STRING.
6115                           By default, it is false.
6116  -v | --version           Onap command service version. It is of type
6117                           STRING. By default, it is false.
6118  -d | --debug             Enable debug output. It is of type BOOL. By
6119                           default, it is false.
6120  -f | --format            Output formats, supported formats such as table,
6121                           csv, json, yaml. It is of type STRING. By
6122                           default, it is table.
6123  -s | --long              whether to print all attributes or only short
6124                           attributes. It is of type BOOL. By default, it is
6125                           false.
6126  -t | --no-title          whether to print title or not. It is of type
6127                           BOOL. By default, it is false.
6128  -a | --no-auth           whether to authenticate user or not. It is of
6129                           type BOOL. By default, it is false.
6130
6131
6132 Error::
6133
6134  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
6135
6136
6137
6138 [80] service-type-delete
6139 -----------------------------------------------
6140
6141
6142 usage: onap service-type-delete
6143
6144 Delete a service type from Onap
6145
6146 Onap service: aai v11
6147
6148 Options::
6149
6150  [-x | --service-type-id] [-y | --resource-version] [-u | --onap-username]
6151  [-p | --onap-password] [-m | --host-url] [-h | --help]
6152  [-v | --version] [-d | --debug] [-f | --format]
6153  [-s | --long] [-t | --no-title] [-a | --no-auth]
6154
6155 where::
6156
6157  -x | --service-type-id   Onap service type uuid. It is of type UUID. It is
6158                           optional. By default, it is
6159                           bb1938c7-1609-40fe-b4ba-75a3282ad3ad.
6160  -y | --resource-version  Onap service resource version. It is of type
6161                           UUID. It is optional. By default, it is
6162                           12b1a7c7-f8be-49cb-b320-dc103a24f00e.
6163  -u | --onap-username     Onap user name. It is of type STRING. By default,
6164                           it is read from environment variable
6165                           ONAP_USERNAME.
6166  -p | --onap-password     Onap user password. It is of type STRING. By
6167                           default, it is read from environment variable
6168                           ONAP_PASSWORD. Secured.
6169  -m | --host-url          Onap host url. It is of type URL. By default, it
6170                           is read from environment variable ONAP_HOST_URL.
6171  -h | --help              Onap command help message. It is of type STRING.
6172                           By default, it is false.
6173  -v | --version           Onap command service version. It is of type
6174                           STRING. By default, it is false.
6175  -d | --debug             Enable debug output. It is of type BOOL. By
6176                           default, it is false.
6177  -f | --format            Output formats, supported formats such as table,
6178                           csv, json, yaml. It is of type STRING. By
6179                           default, it is table.
6180  -s | --long              whether to print all attributes or only short
6181                           attributes. It is of type BOOL. By default, it is
6182                           false.
6183  -t | --no-title          whether to print title or not. It is of type
6184                           BOOL. By default, it is false.
6185  -a | --no-auth           whether to authenticate user or not. It is of
6186                           type BOOL. By default, it is false.
6187
6188
6189 Error::
6190
6191  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
6192
6193
6194
6195 [81] cloud-create
6196 -----------------------------------------------
6197
6198
6199 usage: onap cloud-create
6200
6201 Create a cloud region in Onap
6202
6203 Onap service: aai v11
6204
6205 Options::
6206
6207  [-x | --cloud-name] [-y | --region-name] [-u | --onap-username]
6208  [-p | --onap-password] [-m | --host-url] [-h | --help]
6209  [-v | --version] [-d | --debug] [-f | --format]
6210  [-s | --long] [-t | --no-title] [-a | --no-auth]
6211
6212 where::
6213
6214  -x | --cloud-name      Onap cloud name. It is of type STRING.
6215  -y | --region-name     Onap  region name. It is of type STRING.
6216  -u | --onap-username   Onap user name. It is of type STRING. By default,
6217                         it is read from environment variable
6218                         ONAP_USERNAME.
6219  -p | --onap-password   Onap user password. It is of type STRING. By
6220                         default, it is read from environment variable
6221                         ONAP_PASSWORD. Secured.
6222  -m | --host-url        Onap host url. It is of type URL. By default, it
6223                         is read from environment variable ONAP_HOST_URL.
6224  -h | --help            Onap command help message. It is of type STRING.
6225                         By default, it is false.
6226  -v | --version         Onap command service version. It is of type
6227                         STRING. By default, it is false.
6228  -d | --debug           Enable debug output. It is of type BOOL. By
6229                         default, it is false.
6230  -f | --format          Output formats, supported formats such as table,
6231                         csv, json, yaml. It is of type STRING. By
6232                         default, it is table.
6233  -s | --long            whether to print all attributes or only short
6234                         attributes. It is of type BOOL. By default, it is
6235                         false.
6236  -t | --no-title        whether to print title or not. It is of type
6237                         BOOL. By default, it is false.
6238  -a | --no-auth         whether to authenticate user or not. It is of
6239                         type BOOL. By default, it is false.
6240
6241
6242 Error::
6243
6244  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
6245
6246
6247
6248 [82] service-delete
6249 -----------------------------------------------
6250
6251
6252 usage: onap service-delete
6253
6254 Delete service instance (experimental)
6255
6256 Onap service: so v3
6257
6258 Options::
6259
6260  [-x | --service-instace-id] [-b | --model-invariant-id] [-i | --model-uuid]
6261  [-e | --model-name] [-g | --model-version] [-c | --customer-name]
6262  [-j | --cloud-region] [-k | --tenant-id] [-u | --onap-username]
6263  [-p | --onap-password] [-m | --host-url] [-h | --help]
6264  [-v | --version] [-d | --debug] [-f | --format]
6265  [-s | --long] [-t | --no-title] [-a | --no-auth]
6266
6267 where::
6268
6269  -x | --service-instace-id  unique id for service instance. It is of type
6270                             STRING.
6271  -b | --model-invariant-id  model invariant id for service in SDC catalog. It
6272                             is of type STRING.
6273  -i | --model-uuid          model uuid for service in SDC catalog. It is of
6274                             type STRING.
6275  -e | --model-name          model name available in SDC catalog. It is of
6276                             type STRING.
6277  -g | --model-version       model version of service (eg. 1.0). It is of type
6278                             STRING.
6279  -c | --customer-name       unique id for customer. It is of type STRING.
6280  -j | --cloud-region        cloud region id. It is of type STRING.
6281  -k | --tenant-id           tenant id. It is of type STRING.
6282  -u | --onap-username       Onap user name. It is of type STRING. By default,
6283                             it is read from environment variable
6284                             ONAP_USERNAME.
6285  -p | --onap-password       Onap user password. It is of type STRING. By
6286                             default, it is read from environment variable
6287                             ONAP_PASSWORD. Secured.
6288  -m | --host-url            Onap host url. It is of type URL. By default, it
6289                             is read from environment variable ONAP_HOST_URL.
6290  -h | --help                Onap command help message. It is of type STRING.
6291                             By default, it is false.
6292  -v | --version             Onap command service version. It is of type
6293                             STRING. By default, it is false.
6294  -d | --debug               Enable debug output. It is of type BOOL. By
6295                             default, it is false.
6296  -f | --format              Output formats, supported formats such as table,
6297                             csv, json, yaml. It is of type STRING. By
6298                             default, it is table.
6299  -s | --long                whether to print all attributes or only short
6300                             attributes. It is of type BOOL. By default, it is
6301                             false.
6302  -t | --no-title            whether to print title or not. It is of type
6303                             BOOL. By default, it is false.
6304  -a | --no-auth             whether to authenticate user or not. It is of
6305                             type BOOL. By default, it is false.
6306
6307
6308 Error::
6309
6310  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
6311
6312
6313
6314 [83] vfmodule-delete
6315 -----------------------------------------------
6316
6317
6318 usage: onap vfmodule-delete
6319
6320 delete a VF module (experimental)
6321
6322 Onap service: so v3
6323
6324 Options::
6325
6326  [-x | --vfmodule-id] [-j | --service-id] [-y | --vf-id]
6327  [-k | --vf-model-invariant-id] [-e | --vfmodule-name] [-g | --vfmodule-version]
6328  [-l | --cloud-region] [-z | --tenant-id] [-u | --onap-username]
6329  [-p | --onap-password] [-m | --host-url] [-h | --help]
6330  [-v | --version] [-d | --debug] [-f | --format]
6331  [-s | --long] [-t | --no-title] [-a | --no-auth]
6332
6333 where::
6334
6335  -x | --vfmodule-id             VF module Id. It is of type STRING.
6336  -j | --service-id              unique id for service. It is of type STRING.
6337  -y | --vf-id                   unique id for related VF. It is of type STRING.
6338  -k | --vf-model-invariant-id   vf model invariant id. It is of type STRING.
6339  -e | --vfmodule-name           vfmodule model name. It is of type STRING.
6340  -g | --vfmodule-version        vf module version. It is of type STRING.
6341  -l | --cloud-region            cloud region identifier. It is of type STRING.
6342  -z | --tenant-id               openstack tenant id. It is of type STRING.
6343  -u | --onap-username           Onap user name. It is of type STRING. By default,
6344                                 it is read from environment variable
6345                                 ONAP_USERNAME.
6346  -p | --onap-password           Onap user password. It is of type STRING. By
6347                                 default, it is read from environment variable
6348                                 ONAP_PASSWORD. Secured.
6349  -m | --host-url                Onap host url. It is of type URL. By default, it
6350                                 is read from environment variable ONAP_HOST_URL.
6351  -h | --help                    Onap command help message. It is of type STRING.
6352                                 By default, it is false.
6353  -v | --version                 Onap command service version. It is of type
6354                                 STRING. By default, it is false.
6355  -d | --debug                   Enable debug output. It is of type BOOL. By
6356                                 default, it is false.
6357  -f | --format                  Output formats, supported formats such as table,
6358                                 csv, json, yaml. It is of type STRING. By
6359                                 default, it is table.
6360  -s | --long                    whether to print all attributes or only short
6361                                 attributes. It is of type BOOL. By default, it is
6362                                 false.
6363  -t | --no-title                whether to print title or not. It is of type
6364                                 BOOL. By default, it is false.
6365  -a | --no-auth                 whether to authenticate user or not. It is of
6366                                 type BOOL. By default, it is false.
6367
6368
6369 Error::
6370
6371  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
6372
6373
6374
6375 [84] vfmodule-create
6376 -----------------------------------------------
6377
6378
6379 usage: onap vfmodule-create
6380
6381 Create a VF module
6382
6383 Onap service: so v3
6384
6385 Options::
6386
6387  [-l | --cloud-region] [-B | --tenant-id] [-b | --vfmodule-invariant-id]
6388  [-c | --vfmodule-uuid] [-e | --vfmodule-name] [-g | --vfmodule-version]
6389  [-i | --module-name] [-j | --service-id] [-y | --vf-id]
6390  [-k | --vf-model-invariant-id] [-A | --vf-model-uuid] [-n | --vf-model-name]
6391  [-o | --vf-model-version] [-q | --vf-model-customization-id] [-r | --service-model-invariant-id]
6392  [-w | --service-model-uuid] [-x | --service-model-name] [-z | --service-model-version]
6393  [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
6394  [-h | --help] [-v | --version] [-d | --debug]
6395  [-f | --format] [-s | --long] [-t | --no-title]
6396  [-a | --no-auth]
6397
6398 where::
6399
6400  -l | --cloud-region                cloud region identifier. It is of type STRING.
6401  -B | --tenant-id                   openstack tenant id. It is of type STRING.
6402  -b | --vfmodule-invariant-id       vfmodule model invariant id. It is of type STRING.
6403  -c | --vfmodule-uuid               model uuid for vfmodule. It is of type STRING.
6404  -e | --vfmodule-name               vfmodule model name. It is of type STRING.
6405  -g | --vfmodule-version            vf module version. It is of type STRING.
6406  -i | --module-name                 vfmodule name. It is of type STRING.
6407  -j | --service-id                  unique id for service. It is of type STRING.
6408  -y | --vf-id                       unique id for related VF. It is of type STRING.
6409  -k | --vf-model-invariant-id       vf model invariant id. It is of type STRING.
6410  -A | --vf-model-uuid               model uuid for vf. It is of type STRING.
6411  -n | --vf-model-name               vf model name. It is of type STRING.
6412  -o | --vf-model-version            vf model version. It is of type STRING.
6413  -q | --vf-model-customization-id   vf model customization id. This can be obtained
6414                                     using SDC portal (Home -> service:xxx ->
6415                                     Composition -> click on VF for customization id).
6416                                     It is of type STRING.
6417  -r | --service-model-invariant-id  model invariant id. It is of type STRING.
6418  -w | --service-model-uuid          model name version id. It is of type STRING.
6419  -x | --service-model-name          service model name. It is of type STRING.
6420  -z | --service-model-version       service model version. It is of type STRING.
6421  -u | --onap-username               Onap user name. It is of type STRING. By default,
6422                                     it is read from environment variable
6423                                     ONAP_USERNAME.
6424  -p | --onap-password               Onap user password. It is of type STRING. By
6425                                     default, it is read from environment variable
6426                                     ONAP_PASSWORD. Secured.
6427  -m | --host-url                    Onap host url. It is of type URL. By default, it
6428                                     is read from environment variable ONAP_HOST_URL.
6429  -h | --help                        Onap command help message. It is of type STRING.
6430                                     By default, it is false.
6431  -v | --version                     Onap command service version. It is of type
6432                                     STRING. By default, it is false.
6433  -d | --debug                       Enable debug output. It is of type BOOL. By
6434                                     default, it is false.
6435  -f | --format                      Output formats, supported formats such as table,
6436                                     csv, json, yaml. It is of type STRING. By
6437                                     default, it is table.
6438  -s | --long                        whether to print all attributes or only short
6439                                     attributes. It is of type BOOL. By default, it is
6440                                     false.
6441  -t | --no-title                    whether to print title or not. It is of type
6442                                     BOOL. By default, it is false.
6443  -a | --no-auth                     whether to authenticate user or not. It is of
6444                                     type BOOL. By default, it is false.
6445
6446
6447 Results::
6448
6449  vfmodule-id  id for the created vnf and is of type STRING.
6450
6451
6452 Error::
6453
6454  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
6455
6456
6457
6458 [85] service-create
6459 -----------------------------------------------
6460
6461
6462 usage: onap service-create
6463
6464 Create a service instance using MSO
6465
6466 Onap service: so v3
6467
6468 Options::
6469
6470  [-l | --cloud-region] [-b | --tenant-id] [-e | --model-invariant-id]
6471  [-g | --model-uuid] [-i | --model-name] [-j | --model-version]
6472  [-c | --customer] [-k | --instance-name] [-r | --supress-rollback]
6473  [-w | --service-type] [-u | --onap-username] [-p | --onap-password]
6474  [-m | --host-url] [-h | --help] [-v | --version]
6475  [-d | --debug] [-f | --format] [-s | --long]
6476  [-t | --no-title] [-a | --no-auth]
6477
6478 where::
6479
6480  -l | --cloud-region        cloud region identifier. It is of type STRING.
6481  -b | --tenant-id           tenant id. It is of type STRING.
6482  -e | --model-invariant-id  model invariant id generated by ASDC. It is of
6483                             type STRING.
6484  -g | --model-uuid          model uuid generated by ASDC. It is of type
6485                             STRING.
6486  -i | --model-name          model name as provided in ASDC design time. It is
6487                             of type STRING.
6488  -j | --model-version       model-version. It is of type STRING.
6489  -c | --customer            unique id for customer. It is of type STRING.
6490  -k | --instance-name       service instance name. It is of type STRING.
6491  -r | --supress-rollback    rollback changes if instantiation fails. It is of
6492                             type BOOL. It is optional. By default, it is
6493                             false.
6494  -w | --service-type     subscription service type. It is of type STRING.
6495  -u | --onap-username       Onap user name. It is of type STRING. By default,
6496                             it is read from environment variable
6497                             ONAP_USERNAME.
6498  -p | --onap-password       Onap user password. It is of type STRING. By
6499                             default, it is read from environment variable
6500                             ONAP_PASSWORD. Secured.
6501  -m | --host-url            Onap host url. It is of type URL. By default, it
6502                             is read from environment variable ONAP_HOST_URL.
6503  -h | --help                Onap command help message. It is of type STRING.
6504                             By default, it is false.
6505  -v | --version             Onap command service version. It is of type
6506                             STRING. By default, it is false.
6507  -d | --debug               Enable debug output. It is of type BOOL. By
6508                             default, it is false.
6509  -f | --format              Output formats, supported formats such as table,
6510                             csv, json, yaml. It is of type STRING. By
6511                             default, it is table.
6512  -s | --long                whether to print all attributes or only short
6513                             attributes. It is of type BOOL. By default, it is
6514                             false.
6515  -t | --no-title            whether to print title or not. It is of type
6516                             BOOL. By default, it is false.
6517  -a | --no-auth             whether to authenticate user or not. It is of
6518                             type BOOL. By default, it is false.
6519
6520
6521 Results::
6522
6523  service-id   instance id for the created service. and is of
6524               type STRING.
6525
6526
6527 Error::
6528
6529  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
6530
6531
6532
6533 [86] vf-delete
6534 -----------------------------------------------
6535
6536
6537 usage: onap vf-delete (experimental)
6538
6539 delete a VF
6540
6541 Onap service: so v3
6542
6543 Options::
6544
6545  [-x | --vf-id] [-y | --service-instance-id] [-l | --cloud-region]
6546  [-z | --tenant-id] [-b | --model-invariant-id] [-c | --model-uuid]
6547  [-e | --model-name] [-g | --model-version] [-u | --onap-username]
6548  [-p | --onap-password] [-m | --host-url] [-h | --help]
6549  [-v | --version] [-d | --debug] [-f | --format]
6550  [-s | --long] [-t | --no-title] [-a | --no-auth]
6551
6552 where::
6553
6554  -x | --vf-id                 id for vnf. It is of type STRING.
6555  -y | --service-instance-id   unique id for service instance. It is of type
6556                               STRING.
6557  -l | --cloud-region          Cloud region ID. It is of type STRING.
6558  -z | --tenant-id             openstack tenant id (uuid). It is of type STRING.
6559  -b | --model-invariant-id    model invariant id for service in SDC catalog. It
6560                               is of type STRING.
6561  -c | --model-uuid            model uuid for service in SDC catalog. It is of
6562                               type STRING.
6563  -e | --model-name            model name available in SDC catalog. It is of
6564                               type STRING.
6565  -g | --model-version         model version of service (eg. 1.0). It is of type
6566                               STRING.
6567  -u | --onap-username         Onap user name. It is of type STRING. By default,
6568                               it is read from environment variable
6569                               ONAP_USERNAME.
6570  -p | --onap-password         Onap user password. It is of type STRING. By
6571                               default, it is read from environment variable
6572                               ONAP_PASSWORD. Secured.
6573  -m | --host-url              Onap host url. It is of type URL. By default, it
6574                               is read from environment variable ONAP_HOST_URL.
6575  -h | --help                  Onap command help message. It is of type STRING.
6576                               By default, it is false.
6577  -v | --version               Onap command service version. It is of type
6578                               STRING. By default, it is false.
6579  -d | --debug                 Enable debug output. It is of type BOOL. By
6580                               default, it is false.
6581  -f | --format                Output formats, supported formats such as table,
6582                               csv, json, yaml. It is of type STRING. By
6583                               default, it is table.
6584  -s | --long                  whether to print all attributes or only short
6585                               attributes. It is of type BOOL. By default, it is
6586                               false.
6587  -t | --no-title              whether to print title or not. It is of type
6588                               BOOL. By default, it is false.
6589  -a | --no-auth               whether to authenticate user or not. It is of
6590                               type BOOL. By default, it is false.
6591
6592
6593 Error::
6594
6595  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
6596
6597
6598
6599 [87] vf-create
6600 -----------------------------------------------
6601
6602
6603 usage: onap vf-create
6604
6605 Create a VF
6606
6607 Onap service: so v3
6608
6609 Options::
6610
6611  [-l | --cloud-region] [-z | --tenant-id] [-w | --product-family]
6612  [-o | --instance-name] [-y | --service-instance-id] [-b | --vf-model-invariant-id]
6613  [-c | --vf-model-uuid] [-e | --vf-model-name] [-g | --vf-model-version]
6614  [-i | --vf-model-customization-id] [-j | --service-model-invariant-id] [-k | --service-model-uuid]
6615  [-q | --service-model-name] [-n | --service-model-version] [-u | --onap-username]
6616  [-p | --onap-password] [-m | --host-url] [-h | --help]
6617  [-v | --version] [-d | --debug] [-f | --format]
6618  [-s | --long] [-t | --no-title] [-a | --no-auth]
6619
6620 where::
6621
6622  -l | --cloud-region                cloud region identifier. It is of type STRING.
6623  -z | --tenant-id                   openstack tenant id. It is of type STRING.
6624  -w | --product-family              service type for serivce (e.g. vLB). It is of
6625                                     type STRING.
6626  -o | --instance-name               service instance name. It is of type STRING.
6627  -y | --service-instance-id         unique id for service instance. It is of type
6628                                     STRING.
6629  -b | --vf-model-invariant-id       vf model invariant id. It is of type STRING.
6630  -c | --vf-model-uuid               model uuid for vf. It is of type STRING.
6631  -e | --vf-model-name               vf model name. It is of type STRING.
6632  -g | --vf-model-version            vf model version. It is of type STRING.
6633  -i | --vf-model-customization-id   vf model customization id. It is of type STRING.
6634  -j | --service-model-invariant-id  model invariant id. It is of type STRING.
6635  -k | --service-model-uuid          model name version id. It is of type STRING.
6636  -q | --service-model-name          service model name. It is of type STRING.
6637  -n | --service-model-version       service model version. It is of type STRING.
6638  -u | --onap-username               Onap user name. It is of type STRING. By default,
6639                                     it is read from environment variable
6640                                     ONAP_USERNAME.
6641  -p | --onap-password               Onap user password. It is of type STRING. By
6642                                     default, it is read from environment variable
6643                                     ONAP_PASSWORD. Secured.
6644  -m | --host-url                    Onap host url. It is of type URL. By default, it
6645                                     is read from environment variable ONAP_HOST_URL.
6646  -h | --help                        Onap command help message. It is of type STRING.
6647                                     By default, it is false.
6648  -v | --version                     Onap command service version. It is of type
6649                                     STRING. By default, it is false.
6650  -d | --debug                       Enable debug output. It is of type BOOL. By
6651                                     default, it is false.
6652  -f | --format                      Output formats, supported formats such as table,
6653                                     csv, json, yaml. It is of type STRING. By
6654                                     default, it is table.
6655  -s | --long                        whether to print all attributes or only short
6656                                     attributes. It is of type BOOL. By default, it is
6657                                     false.
6658  -t | --no-title                    whether to print title or not. It is of type
6659                                     BOOL. By default, it is false.
6660  -a | --no-auth                     whether to authenticate user or not. It is of
6661                                     type BOOL. By default, it is false.
6662
6663
6664 Results::
6665
6666  vf-id  id for the created vnf and is of type STRING.
6667
6668
6669 Error::
6670
6671  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
6672
6673
6674
6675 onap-1.0
6676 ==========================
6677
6678
6679 [1] license-group-create
6680 -----------------------------------------------
6681
6682
6683 usage: onap license-group-create
6684
6685 Create License Group
6686
6687 Onap service: sdc v1.0
6688
6689 Options::
6690
6691  [-x | --group-name] [-y | --license-model-id] [-z | --license-group-description]
6692  [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
6693  [-h | --help] [-v | --version] [-d | --debug]
6694  [-f | --format] [-s | --long] [-t | --no-title]
6695  [-a | --no-auth]
6696
6697 where::
6698
6699  -x | --group-name                  group name. It is of type STRING.
6700  -y | --license-model-id            License Model ID. It is of type STRING.
6701  -z | --license-group-description   Description for License Group. It is of type
6702                                     STRING. It is optional.
6703  -u | --onap-username               Onap user name. It is of type STRING. By default,
6704                                     it is read from environment variable
6705                                     ONAP_USERNAME.
6706  -p | --onap-password               Onap user password. It is of type STRING. By
6707                                     default, it is read from environment variable
6708                                     ONAP_PASSWORD. Secured.
6709  -m | --host-url                    Onap host url. It is of type URL. By default, it
6710                                     is read from environment variable ONAP_HOST_URL.
6711  -h | --help                        Onap command help message. It is of type STRING.
6712                                     By default, it is false.
6713  -v | --version                     Onap command service version. It is of type
6714                                     STRING. By default, it is false.
6715  -d | --debug                       Enable debug output. It is of type BOOL. By
6716                                     default, it is false.
6717  -f | --format                      Output formats, supported formats such as table,
6718                                     csv, json, yaml. It is of type STRING. By
6719                                     default, it is table.
6720  -s | --long                        whether to print all attributes or only short
6721                                     attributes. It is of type BOOL. By default, it is
6722                                     false.
6723  -t | --no-title                    whether to print title or not. It is of type
6724                                     BOOL. By default, it is false.
6725  -a | --no-auth                     whether to authenticate user or not. It is of
6726                                     type BOOL. By default, it is false.
6727
6728
6729 Results::
6730
6731  ID   License Group ID and is of type STRING.
6732
6733
6734 Error::
6735
6736  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
6737
6738
6739
6740 [2] ep-show
6741 -----------------------------------------------
6742
6743
6744 usage: onap ep-show
6745
6746 Details of the Entitlement Pool
6747
6748 Onap service: sdc v1.0
6749
6750 Options::
6751
6752  [-x | --license-model-id] [-y | --pool-id] [-u | --onap-username]
6753  [-p | --onap-password] [-m | --host-url] [-h | --help]
6754  [-v | --version] [-d | --debug] [-f | --format]
6755  [-s | --long] [-t | --no-title] [-a | --no-auth]
6756
6757 where::
6758
6759  -x | --license-model-id  Onap License Model ID. It is of type STRING.
6760  -y | --pool-id           Onap Entitlement Pool ID. It is of type STRING.
6761  -u | --onap-username     Onap user name. It is of type STRING. By default,
6762                           it is read from environment variable
6763                           ONAP_USERNAME.
6764  -p | --onap-password     Onap user password. It is of type STRING. By
6765                           default, it is read from environment variable
6766                           ONAP_PASSWORD. Secured.
6767  -m | --host-url          Onap host url. It is of type URL. By default, it
6768                           is read from environment variable ONAP_HOST_URL.
6769  -h | --help              Onap command help message. It is of type STRING.
6770                           By default, it is false.
6771  -v | --version           Onap command service version. It is of type
6772                           STRING. By default, it is false.
6773  -d | --debug             Enable debug output. It is of type BOOL. By
6774                           default, it is false.
6775  -f | --format            Output formats, supported formats such as table,
6776                           csv, json, yaml. It is of type STRING. By
6777                           default, it is table.
6778  -s | --long              whether to print all attributes or only short
6779                           attributes. It is of type BOOL. By default, it is
6780                           false.
6781  -t | --no-title          whether to print title or not. It is of type
6782                           BOOL. By default, it is false.
6783  -a | --no-auth           whether to authenticate user or not. It is of
6784                           type BOOL. By default, it is false.
6785
6786
6787 Results::
6788
6789  name         Entitlement Pool Name and is of type STRING.
6790  ID           Entitlement Pool ID and is of type STRING.
6791  description  Description for the Entitlement Pool and is of
6792               type STRING.
6793
6794
6795 Error::
6796
6797  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
6798
6799
6800
6801 [3] license-model-create
6802 -----------------------------------------------
6803
6804
6805 usage: onap license-model-create
6806
6807 Create License Model
6808
6809 Onap service: sdc v1.0
6810
6811 Options::
6812
6813  [-x | --vendor-name] [-y | --license-model-description] [-u | --onap-username]
6814  [-p | --onap-password] [-m | --host-url] [-h | --help]
6815  [-v | --version] [-d | --debug] [-f | --format]
6816  [-s | --long] [-t | --no-title] [-a | --no-auth]
6817
6818 where::
6819
6820  -x | --vendor-name                 vendor name. It is of type STRING.
6821  -y | --license-model-description   Description for License Model. It is of type
6822                                     STRING. It is optional.
6823  -u | --onap-username               Onap user name. It is of type STRING. By default,
6824                                     it is read from environment variable
6825                                     ONAP_USERNAME.
6826  -p | --onap-password               Onap user password. It is of type STRING. By
6827                                     default, it is read from environment variable
6828                                     ONAP_PASSWORD. Secured.
6829  -m | --host-url                    Onap host url. It is of type URL. By default, it
6830                                     is read from environment variable ONAP_HOST_URL.
6831  -h | --help                        Onap command help message. It is of type STRING.
6832                                     By default, it is false.
6833  -v | --version                     Onap command service version. It is of type
6834                                     STRING. By default, it is false.
6835  -d | --debug                       Enable debug output. It is of type BOOL. By
6836                                     default, it is false.
6837  -f | --format                      Output formats, supported formats such as table,
6838                                     csv, json, yaml. It is of type STRING. By
6839                                     default, it is table.
6840  -s | --long                        whether to print all attributes or only short
6841                                     attributes. It is of type BOOL. By default, it is
6842                                     false.
6843  -t | --no-title                    whether to print title or not. It is of type
6844                                     BOOL. By default, it is false.
6845  -a | --no-auth                     whether to authenticate user or not. It is of
6846                                     type BOOL. By default, it is false.
6847
6848
6849 Results::
6850
6851  ID   License Model ID and is of type STRING.
6852
6853
6854 Error::
6855
6856  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
6857
6858
6859
6860 [4] license-group-show
6861 -----------------------------------------------
6862
6863
6864 usage: onap license-group-show
6865
6866 Details of the License Group
6867
6868 Onap service: sdc v1.0
6869
6870 Options::
6871
6872  [-x | --license-model-id] [-y | --license-group-id] [-u | --onap-username]
6873  [-p | --onap-password] [-m | --host-url] [-h | --help]
6874  [-v | --version] [-d | --debug] [-f | --format]
6875  [-s | --long] [-t | --no-title] [-a | --no-auth]
6876
6877 where::
6878
6879  -x | --license-model-id  Onap License Model ID. It is of type STRING.
6880  -y | --license-group-id  Onap License Group ID. It is of type STRING.
6881  -u | --onap-username     Onap user name. It is of type STRING. By default,
6882                           it is read from environment variable
6883                           ONAP_USERNAME.
6884  -p | --onap-password     Onap user password. It is of type STRING. By
6885                           default, it is read from environment variable
6886                           ONAP_PASSWORD. Secured.
6887  -m | --host-url          Onap host url. It is of type URL. By default, it
6888                           is read from environment variable ONAP_HOST_URL.
6889  -h | --help              Onap command help message. It is of type STRING.
6890                           By default, it is false.
6891  -v | --version           Onap command service version. It is of type
6892                           STRING. By default, it is false.
6893  -d | --debug             Enable debug output. It is of type BOOL. By
6894                           default, it is false.
6895  -f | --format            Output formats, supported formats such as table,
6896                           csv, json, yaml. It is of type STRING. By
6897                           default, it is table.
6898  -s | --long              whether to print all attributes or only short
6899                           attributes. It is of type BOOL. By default, it is
6900                           false.
6901  -t | --no-title          whether to print title or not. It is of type
6902                           BOOL. By default, it is false.
6903  -a | --no-auth           whether to authenticate user or not. It is of
6904                           type BOOL. By default, it is false.
6905
6906
6907 Results::
6908
6909  name         License Group Name and is of type STRING.
6910  ID           License Group ID and is of type STRING.
6911  description  Description for the License Group and is of type
6912               STRING.
6913
6914
6915 Error::
6916
6917  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
6918
6919
6920
6921 [5] vsp-upload
6922 -----------------------------------------------
6923
6924
6925 usage: onap vsp-upload
6926
6927 Upload the CSAR file to VSP
6928
6929 Onap service: sdc v1.0
6930
6931 Options::
6932
6933  [-x | --vsp-id] [-y | --vsp-file] [-u | --onap-username]
6934  [-p | --onap-password] [-m | --host-url] [-h | --help]
6935  [-v | --version] [-d | --debug] [-f | --format]
6936  [-s | --long] [-t | --no-title] [-a | --no-auth]
6937
6938 where::
6939
6940  -x | --vsp-id          Onap VSP ID. It is of type STRING.
6941  -y | --vsp-file        CSAR File path. It is of type BINARY.
6942  -u | --onap-username   Onap user name. It is of type STRING. By default,
6943                         it is read from environment variable
6944                         ONAP_USERNAME.
6945  -p | --onap-password   Onap user password. It is of type STRING. By
6946                         default, it is read from environment variable
6947                         ONAP_PASSWORD. Secured.
6948  -m | --host-url        Onap host url. It is of type URL. By default, it
6949                         is read from environment variable ONAP_HOST_URL.
6950  -h | --help            Onap command help message. It is of type STRING.
6951                         By default, it is false.
6952  -v | --version         Onap command service version. It is of type
6953                         STRING. By default, it is false.
6954  -d | --debug           Enable debug output. It is of type BOOL. By
6955                         default, it is false.
6956  -f | --format          Output formats, supported formats such as table,
6957                         csv, json, yaml. It is of type STRING. By
6958                         default, it is table.
6959  -s | --long            whether to print all attributes or only short
6960                         attributes. It is of type BOOL. By default, it is
6961                         false.
6962  -t | --no-title        whether to print title or not. It is of type
6963                         BOOL. By default, it is false.
6964  -a | --no-auth         whether to authenticate user or not. It is of
6965                         type BOOL. By default, it is false.
6966
6967
6968 Error::
6969
6970  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
6971
6972
6973
6974 [6] vsp-create
6975 -----------------------------------------------
6976
6977
6978 usage: onap vsp-create
6979
6980 Create Vendor Software Product
6981
6982 Onap service: sdc v1.0
6983
6984 Options::
6985
6986  [-x | --vsp-name] [-y | --vsp-description] [-b | --vsp-category]
6987  [-c | --vsp-subcategory] [-e | --vlm-version] [-g | --vlm-vendor]
6988  [-i | --vlm-id] [-j | --vlm-agreement-id] [-k | --vlm-feature-group-id]
6989  [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
6990  [-h | --help] [-v | --version] [-d | --debug]
6991  [-f | --format] [-s | --long] [-t | --no-title]
6992  [-a | --no-auth]
6993
6994 where::
6995
6996  -x | --vsp-name              Onap VSP Name. It is of type STRING.
6997  -y | --vsp-description       Description for VSP. It is of type STRING. It is
6998                               optional.
6999  -b | --vsp-category          Category of the VSP. It is of type STRING. It is
7000                               optional. By default, it is
7001                               resourceNewCategory.generic.
7002  -c | --vsp-subcategory       Sub Category of VSP. It is of type STRING. It is
7003                               optional. By default, it is
7004                               resourceNewCategory.generic.abstract.
7005  -e | --vlm-version           License version. It is of type STRING. It is
7006                               optional. By default, it is 1.0.
7007  -g | --vlm-vendor            License Model Name. It is of type STRING.
7008  -i | --vlm-id                License Model ID. It is of type STRING.
7009  -j | --vlm-agreement-id      License Agreement ID. It is of type STRING.
7010  -k | --vlm-feature-group-id  Feature Group ID. It is of type STRING.
7011  -u | --onap-username         Onap user name. It is of type STRING. By default,
7012                               it is read from environment variable
7013                               ONAP_USERNAME.
7014  -p | --onap-password         Onap user password. It is of type STRING. By
7015                               default, it is read from environment variable
7016                               ONAP_PASSWORD. Secured.
7017  -m | --host-url              Onap host url. It is of type URL. By default, it
7018                               is read from environment variable ONAP_HOST_URL.
7019  -h | --help                  Onap command help message. It is of type STRING.
7020                               By default, it is false.
7021  -v | --version               Onap command service version. It is of type
7022                               STRING. By default, it is false.
7023  -d | --debug                 Enable debug output. It is of type BOOL. By
7024                               default, it is false.
7025  -f | --format                Output formats, supported formats such as table,
7026                               csv, json, yaml. It is of type STRING. By
7027                               default, it is table.
7028  -s | --long                  whether to print all attributes or only short
7029                               attributes. It is of type BOOL. By default, it is
7030                               false.
7031  -t | --no-title              whether to print title or not. It is of type
7032                               BOOL. By default, it is false.
7033  -a | --no-auth               whether to authenticate user or not. It is of
7034                               type BOOL. By default, it is false.
7035
7036
7037 Results::
7038
7039  ID   VSP ID and is of type STRING.
7040
7041
7042 Error::
7043
7044  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
7045
7046
7047
7048 [7] vsp-list
7049 -----------------------------------------------
7050
7051
7052 usage: onap vsp-list
7053
7054 List of the Vendor Software Products
7055
7056 Onap service: sdc v1.0
7057
7058 Options::
7059
7060  [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
7061  [-h | --help] [-v | --version] [-d | --debug]
7062  [-f | --format] [-s | --long] [-t | --no-title]
7063  [-a | --no-auth]
7064
7065 where::
7066
7067  -u | --onap-username   Onap user name. It is of type STRING. By default,
7068                         it is read from environment variable
7069                         ONAP_USERNAME.
7070  -p | --onap-password   Onap user password. It is of type STRING. By
7071                         default, it is read from environment variable
7072                         ONAP_PASSWORD. Secured.
7073  -m | --host-url        Onap host url. It is of type URL. By default, it
7074                         is read from environment variable ONAP_HOST_URL.
7075  -h | --help            Onap command help message. It is of type STRING.
7076                         By default, it is false.
7077  -v | --version         Onap command service version. It is of type
7078                         STRING. By default, it is false.
7079  -d | --debug           Enable debug output. It is of type BOOL. By
7080                         default, it is false.
7081  -f | --format          Output formats, supported formats such as table,
7082                         csv, json, yaml. It is of type STRING. By
7083                         default, it is table.
7084  -s | --long            whether to print all attributes or only short
7085                         attributes. It is of type BOOL. By default, it is
7086                         false.
7087  -t | --no-title        whether to print title or not. It is of type
7088                         BOOL. By default, it is false.
7089  -a | --no-auth         whether to authenticate user or not. It is of
7090                         type BOOL. By default, it is false.
7091
7092
7093 Results::
7094
7095  ID     VSP ID and is of type STRING.
7096  name   VSP Name and is of type STRING.
7097
7098
7099 Error::
7100
7101  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
7102
7103
7104
7105 [8] vsp-show
7106 -----------------------------------------------
7107
7108
7109 usage: onap vsp-show
7110
7111 Details of the Vendor Software Product
7112
7113 Onap service: sdc v1.0
7114
7115 Options::
7116
7117  [-x | --vsp-id] [-u | --onap-username] [-p | --onap-password]
7118  [-m | --host-url] [-h | --help] [-v | --version]
7119  [-d | --debug] [-f | --format] [-s | --long]
7120  [-t | --no-title] [-a | --no-auth]
7121
7122 where::
7123
7124  -x | --vsp-id          Onap VSP ID. It is of type STRING.
7125  -u | --onap-username   Onap user name. It is of type STRING. By default,
7126                         it is read from environment variable
7127                         ONAP_USERNAME.
7128  -p | --onap-password   Onap user password. It is of type STRING. By
7129                         default, it is read from environment variable
7130                         ONAP_PASSWORD. Secured.
7131  -m | --host-url        Onap host url. It is of type URL. By default, it
7132                         is read from environment variable ONAP_HOST_URL.
7133  -h | --help            Onap command help message. It is of type STRING.
7134                         By default, it is false.
7135  -v | --version         Onap command service version. It is of type
7136                         STRING. By default, it is false.
7137  -d | --debug           Enable debug output. It is of type BOOL. By
7138                         default, it is false.
7139  -f | --format          Output formats, supported formats such as table,
7140                         csv, json, yaml. It is of type STRING. By
7141                         default, it is table.
7142  -s | --long            whether to print all attributes or only short
7143                         attributes. It is of type BOOL. By default, it is
7144                         false.
7145  -t | --no-title        whether to print title or not. It is of type
7146                         BOOL. By default, it is false.
7147  -a | --no-auth         whether to authenticate user or not. It is of
7148                         type BOOL. By default, it is false.
7149
7150
7151 Results::
7152
7153  name         VSP Name and is of type STRING.
7154  ID           VSP ID and is of type STRING.
7155  description  Description for the VSP and is of type STRING.
7156
7157
7158 Error::
7159
7160  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
7161
7162
7163
7164 [9] vsp-submit
7165 -----------------------------------------------
7166
7167
7168 usage: onap vsp-submit
7169
7170 Submit Vendor Software Product
7171
7172 Onap service: sdc v1.0
7173
7174 Options::
7175
7176  [-x | --vsp-id] [-u | --onap-username] [-p | --onap-password]
7177  [-m | --host-url] [-h | --help] [-v | --version]
7178  [-d | --debug] [-f | --format] [-s | --long]
7179  [-t | --no-title] [-a | --no-auth]
7180
7181 where::
7182
7183  -x | --vsp-id          Onap VSP ID. It is of type STRING.
7184  -u | --onap-username   Onap user name. It is of type STRING. By default,
7185                         it is read from environment variable
7186                         ONAP_USERNAME.
7187  -p | --onap-password   Onap user password. It is of type STRING. By
7188                         default, it is read from environment variable
7189                         ONAP_PASSWORD. Secured.
7190  -m | --host-url        Onap host url. It is of type URL. By default, it
7191                         is read from environment variable ONAP_HOST_URL.
7192  -h | --help            Onap command help message. It is of type STRING.
7193                         By default, it is false.
7194  -v | --version         Onap command service version. It is of type
7195                         STRING. By default, it is false.
7196  -d | --debug           Enable debug output. It is of type BOOL. By
7197                         default, it is false.
7198  -f | --format          Output formats, supported formats such as table,
7199                         csv, json, yaml. It is of type STRING. By
7200                         default, it is table.
7201  -s | --long            whether to print all attributes or only short
7202                         attributes. It is of type BOOL. By default, it is
7203                         false.
7204  -t | --no-title        whether to print title or not. It is of type
7205                         BOOL. By default, it is false.
7206  -a | --no-auth         whether to authenticate user or not. It is of
7207                         type BOOL. By default, it is false.
7208
7209
7210 Error::
7211
7212  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
7213
7214
7215
7216 [10] vsp-checkin
7217 -----------------------------------------------
7218
7219
7220 usage: onap vsp-checkin
7221
7222 Checkin Vendor Software Product
7223
7224 Onap service: sdc v1.0
7225
7226 Options::
7227
7228  [-x | --vsp-id] [-u | --onap-username] [-p | --onap-password]
7229  [-m | --host-url] [-h | --help] [-v | --version]
7230  [-d | --debug] [-f | --format] [-s | --long]
7231  [-t | --no-title] [-a | --no-auth]
7232
7233 where::
7234
7235  -x | --vsp-id          Onap VSP ID. It is of type STRING.
7236  -u | --onap-username   Onap user name. It is of type STRING. By default,
7237                         it is read from environment variable
7238                         ONAP_USERNAME.
7239  -p | --onap-password   Onap user password. It is of type STRING. By
7240                         default, it is read from environment variable
7241                         ONAP_PASSWORD. Secured.
7242  -m | --host-url        Onap host url. It is of type URL. By default, it
7243                         is read from environment variable ONAP_HOST_URL.
7244  -h | --help            Onap command help message. It is of type STRING.
7245                         By default, it is false.
7246  -v | --version         Onap command service version. It is of type
7247                         STRING. By default, it is false.
7248  -d | --debug           Enable debug output. It is of type BOOL. By
7249                         default, it is false.
7250  -f | --format          Output formats, supported formats such as table,
7251                         csv, json, yaml. It is of type STRING. By
7252                         default, it is table.
7253  -s | --long            whether to print all attributes or only short
7254                         attributes. It is of type BOOL. By default, it is
7255                         false.
7256  -t | --no-title        whether to print title or not. It is of type
7257                         BOOL. By default, it is false.
7258  -a | --no-auth         whether to authenticate user or not. It is of
7259                         type BOOL. By default, it is false.
7260
7261
7262 Error::
7263
7264  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
7265
7266
7267
7268 [11] license-model-show
7269 -----------------------------------------------
7270
7271
7272 usage: onap license-model-show
7273
7274 Details of the License Model
7275
7276 Onap service: sdc v1.0
7277
7278 Options::
7279
7280  [-x | --license-model-id] [-u | --onap-username] [-p | --onap-password]
7281  [-m | --host-url] [-h | --help] [-v | --version]
7282  [-d | --debug] [-f | --format] [-s | --long]
7283  [-t | --no-title] [-a | --no-auth]
7284
7285 where::
7286
7287  -x | --license-model-id  Onap License Model ID. It is of type STRING.
7288  -u | --onap-username     Onap user name. It is of type STRING. By default,
7289                           it is read from environment variable
7290                           ONAP_USERNAME.
7291  -p | --onap-password     Onap user password. It is of type STRING. By
7292                           default, it is read from environment variable
7293                           ONAP_PASSWORD. Secured.
7294  -m | --host-url          Onap host url. It is of type URL. By default, it
7295                           is read from environment variable ONAP_HOST_URL.
7296  -h | --help              Onap command help message. It is of type STRING.
7297                           By default, it is false.
7298  -v | --version           Onap command service version. It is of type
7299                           STRING. By default, it is false.
7300  -d | --debug             Enable debug output. It is of type BOOL. By
7301                           default, it is false.
7302  -f | --format            Output formats, supported formats such as table,
7303                           csv, json, yaml. It is of type STRING. By
7304                           default, it is table.
7305  -s | --long              whether to print all attributes or only short
7306                           attributes. It is of type BOOL. By default, it is
7307                           false.
7308  -t | --no-title          whether to print title or not. It is of type
7309                           BOOL. By default, it is false.
7310  -a | --no-auth           whether to authenticate user or not. It is of
7311                           type BOOL. By default, it is false.
7312
7313
7314 Results::
7315
7316  name         License Model  Name and is of type STRING.
7317  ID           License Model ID and is of type STRING.
7318  description  Description for the License Model and is of type
7319               STRING.
7320  status       Status of the License Model and is of type STRING.
7321
7322
7323 Error::
7324
7325  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
7326
7327
7328
7329 [12] ep-create
7330 -----------------------------------------------
7331
7332
7333 usage: onap ep-create
7334
7335 Create Entitlement Pool
7336
7337 Onap service: sdc v1.0
7338
7339 Options::
7340
7341  [-x | --ep-name] [-y | --license-model-id] [-z | --ep-description]
7342  [-q | --threshold-value] [-b | --threshold-unit] [-c | --entitlement-metric]
7343  [-e | --aggregation-function] [-g | --operational-scope] [-k | --reference-number]
7344  [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
7345  [-h | --help] [-v | --version] [-d | --debug]
7346  [-f | --format] [-s | --long] [-t | --no-title]
7347  [-a | --no-auth]
7348
7349 where::
7350
7351  -x | --ep-name               Entitlement Pool name. It is of type STRING.
7352  -y | --license-model-id      License Model ID. It is of type STRING.
7353  -z | --ep-description        Description for Entitlement Pool. It is of type
7354                               STRING.
7355  -q | --threshold-value       threshold. It is of type STRING.
7356  -b | --threshold-unit        threshold. It is of type STRING.
7357  -c | --entitlement-metric    Entitlement Metric. It is of type STRING.
7358  -e | --aggregation-function  Aggregation Function. It is of type STRING.
7359  -g | --operational-scope     Operational Scope. It is of type STRING.
7360  -k | --reference-number      Reference Number. It is of type STRING.
7361  -u | --onap-username         Onap user name. It is of type STRING. By default,
7362                               it is read from environment variable
7363                               ONAP_USERNAME.
7364  -p | --onap-password         Onap user password. It is of type STRING. By
7365                               default, it is read from environment variable
7366                               ONAP_PASSWORD. Secured.
7367  -m | --host-url              Onap host url. It is of type URL. By default, it
7368                               is read from environment variable ONAP_HOST_URL.
7369  -h | --help                  Onap command help message. It is of type STRING.
7370                               By default, it is false.
7371  -v | --version               Onap command service version. It is of type
7372                               STRING. By default, it is false.
7373  -d | --debug                 Enable debug output. It is of type BOOL. By
7374                               default, it is false.
7375  -f | --format                Output formats, supported formats such as table,
7376                               csv, json, yaml. It is of type STRING. By
7377                               default, it is table.
7378  -s | --long                  whether to print all attributes or only short
7379                               attributes. It is of type BOOL. By default, it is
7380                               false.
7381  -t | --no-title              whether to print title or not. It is of type
7382                               BOOL. By default, it is false.
7383  -a | --no-auth               whether to authenticate user or not. It is of
7384                               type BOOL. By default, it is false.
7385
7386
7387 Results::
7388
7389 <<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
7390  ID   Entitlement Pool ID and is of type STRING.
7391 =======
7392 <<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
7393  ID   License Model ID and is of type STRING.
7394 =======
7395  -x | --vsp-id          Onap VSP ID. It is of type STRING.
7396  -y | --vsp-file        CSAR File path. It is of type BINARY.
7397  -u | --onap-username   Onap user name. It is of type STRING. By default,
7398                         it is read from environment variable
7399                         OPEN_USERNAME.
7400  -p | --onap-password   Onap user password. It is of type STRING. By
7401                         default, it is read from environment variable
7402                         OPEN_PASSWORD. Secured.
7403  -m | --host-url        Onap host url. It is of type URL. By default, it
7404                         is read from environment variable OPEN_HOST_URL.
7405  -h | --help            Onap command help message. It is of type STRING.
7406                         By default, it is false.
7407  -v | --version         Onap command service version. It is of type
7408                         STRING. By default, it is false.
7409  -d | --debug           Enable debug output. It is of type BOOL. By
7410                         default, it is false.
7411  -f | --format          Output formats, supported formats such as table,
7412                         csv, json, yaml. It is of type STRING. By
7413                         default, it is table.
7414  -s | --long            whether to print all attributes or only short
7415                         attributes. It is of type BOOL. By default, it is
7416                         false.
7417  -t | --no-title        whether to print title or not. It is of type
7418                         BOOL. By default, it is false.
7419  -a | --no-auth         whether to authenticate user or not. It is of
7420                         type BOOL. By default, it is false.
7421 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
7422 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
7423
7424
7425 Error::
7426
7427  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
7428
7429
7430
7431 [13] subscription-list
7432 -----------------------------------------------
7433
7434
7435 usage: onap subscription-list
7436
7437 Lists the subscription for a given customer in Onap
7438
7439 Onap service: aai v8
7440
7441 Options::
7442
7443  [-x | --customer-name] [-u | --onap-username] [-p | --onap-password]
7444  [-m | --host-url] [-h | --help] [-v | --version]
7445  [-d | --debug] [-f | --format] [-s | --long]
7446  [-t | --no-title] [-a | --no-auth]
7447
7448 where::
7449
7450  -x | --customer-name   Onap customer name. It is of type STRING.
7451  -u | --onap-username   Onap user name. It is of type STRING. By default,
7452                         it is read from environment variable
7453                         ONAP_USERNAME.
7454  -p | --onap-password   Onap user password. It is of type STRING. By
7455                         default, it is read from environment variable
7456                         ONAP_PASSWORD. Secured.
7457  -m | --host-url        Onap host url. It is of type URL. By default, it
7458                         is read from environment variable ONAP_HOST_URL.
7459  -h | --help            Onap command help message. It is of type STRING.
7460                         By default, it is false.
7461  -v | --version         Onap command service version. It is of type
7462                         STRING. By default, it is false.
7463  -d | --debug           Enable debug output. It is of type BOOL. By
7464                         default, it is false.
7465  -f | --format          Output formats, supported formats such as table,
7466                         csv, json, yaml. It is of type STRING. By
7467                         default, it is table.
7468  -s | --long            whether to print all attributes or only short
7469                         attributes. It is of type BOOL. By default, it is
7470                         false.
7471  -t | --no-title        whether to print title or not. It is of type
7472                         BOOL. By default, it is false.
7473  -a | --no-auth         whether to authenticate user or not. It is of
7474                         type BOOL. By default, it is false.
7475
7476
7477 Results::
7478
7479  service-type   Onap service type and is of type STRING.
7480
7481
7482 Error::
7483
7484  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
7485
7486
7487
7488 [14] subscription-create
7489 -----------------------------------------------
7490
7491
7492 usage: onap subscription-create
7493
7494 Create a subscription for a customer in Onap
7495
7496 Onap service: aai v8
7497
7498 Options::
7499
7500  [-x | --customer-name] [-y | --subscriber-name] [-z | --cloud-type]
7501  [-r | --cloud-region] [-c | --cloud-tenant-id] [-e | --service-type]
7502  [-g | --resource-version] [-u | --onap-username] [-p | --onap-password]
7503  [-m | --host-url] [-h | --help] [-v | --version]
7504  [-d | --debug] [-f | --format] [-s | --long]
7505  [-t | --no-title] [-a | --no-auth]
7506
7507 where::
7508
7509  -x | --customer-name     Onap customer name. It is of type STRING.
7510  -y | --subscriber-name   Onap subscriber name. It is of type STRING.
7511  -z | --cloud-type        Onap cloud type (openstack, rackspace). It is of
7512                           type STRING.
7513  -r | --cloud-region      Onap cloud region. It is of type STRING.
7514  -c | --cloud-tenant-id   Onap cloud tenant id. It is of type STRING.
7515  -e | --service-type      Onap service type. It is of type STRING.
7516  -g | --resource-version  Onap subscription resource version. It is
7517                           mandatory for existing customer to create a new
7518                           subscription. It is of type STRING. It is
7519                           optional.
7520  -u | --onap-username     Onap user name. It is of type STRING. By default,
7521                           it is read from environment variable
7522                           OPEN_USERNAME.
7523  -p | --onap-password     Onap user password. It is of type STRING. By
7524                           default, it is read from environment variable
7525                           OPEN_PASSWORD. Secured.
7526  -m | --host-url          Onap host url. It is of type URL. By default, it
7527                           is read from environment variable OPEN_HOST_URL.
7528  -h | --help              Onap command help message. It is of type STRING.
7529                           By default, it is false.
7530  -v | --version           Onap command service version. It is of type
7531                           STRING. By default, it is false.
7532  -d | --debug             Enable debug output. It is of type BOOL. By
7533                           default, it is false.
7534  -f | --format            Output formats, supported formats such as table,
7535                           csv, json, yaml. It is of type STRING. By
7536                           default, it is table.
7537  -s | --long              whether to print all attributes or only short
7538                           attributes. It is of type BOOL. By default, it is
7539                           false.
7540  -t | --no-title          whether to print title or not. It is of type
7541                           BOOL. By default, it is false.
7542  -a | --no-auth           whether to authenticate user or not. It is of
7543                           type BOOL. By default, it is false.
7544
7545
7546 Error::
7547
7548  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
7549
7550
7551
7552 [15] customer-show
7553 -----------------------------------------------
7554
7555
7556 usage: onap customer-show
7557
7558 Lists the registetred customers in Onap
7559
7560 Onap service: aai v8
7561
7562 Options::
7563
7564  [-x | --customer-name] [-u | --onap-username] [-p | --onap-password]
7565  [-m | --host-url] [-h | --help] [-v | --version]
7566  [-d | --debug] [-f | --format] [-s | --long]
7567  [-t | --no-title] [-a | --no-auth]
7568
7569 where::
7570
7571  -x | --customer-name   Onap customer name. It is of type STRING.
7572  -u | --onap-username   Onap user name. It is of type STRING. By default,
7573                         it is read from environment variable
7574                         ONAP_USERNAME.
7575  -p | --onap-password   Onap user password. It is of type STRING. By
7576                         default, it is read from environment variable
7577                         ONAP_PASSWORD. Secured.
7578  -m | --host-url        Onap host url. It is of type URL. By default, it
7579                         is read from environment variable ONAP_HOST_URL.
7580  -h | --help            Onap command help message. It is of type STRING.
7581                         By default, it is false.
7582  -v | --version         Onap command service version. It is of type
7583                         STRING. By default, it is false.
7584  -d | --debug           Enable debug output. It is of type BOOL. By
7585                         default, it is false.
7586  -f | --format          Output formats, supported formats such as table,
7587                         csv, json, yaml. It is of type STRING. By
7588                         default, it is table.
7589  -s | --long            whether to print all attributes or only short
7590                         attributes. It is of type BOOL. By default, it is
7591                         false.
7592  -t | --no-title        whether to print title or not. It is of type
7593                         BOOL. By default, it is false.
7594  -a | --no-auth         whether to authenticate user or not. It is of
7595                         type BOOL. By default, it is false.
7596
7597
7598 Results::
7599
7600  name               Onap customer name and is of type STRING.
7601  subscriber-name    Onap subscriber name and is of type STRING.
7602  resource-version   Onap subscriber resource version and is of type
7603                     STRING.
7604  subscriber-type    Onap subscriber type and is of type STRING.
7605
7606
7607 Error::
7608
7609  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
7610
7611
7612
7613 [16] customer-list
7614 -----------------------------------------------
7615
7616
7617 usage: onap customer-list
7618
7619 Lists the registetred customers in Onap
7620
7621 Onap service: aai v8
7622
7623 Options::
7624
7625  [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
7626  [-h | --help] [-v | --version] [-d | --debug]
7627  [-f | --format] [-s | --long] [-t | --no-title]
7628  [-a | --no-auth]
7629
7630 where::
7631
7632  -u | --onap-username   Onap user name. It is of type STRING. By default,
7633                         it is read from environment variable
7634                         OPEN_USERNAME.
7635  -p | --onap-password   Onap user password. It is of type STRING. By
7636                         default, it is read from environment variable
7637                         OPEN_PASSWORD. Secured.
7638  -m | --host-url        Onap host url. It is of type URL. By default, it
7639                         is read from environment variable OPEN_HOST_URL.
7640  -h | --help            Onap command help message. It is of type STRING.
7641                         By default, it is false.
7642  -v | --version         Onap command service version. It is of type
7643                         STRING. By default, it is false.
7644  -d | --debug           Enable debug output. It is of type BOOL. By
7645                         default, it is false.
7646  -f | --format          Output formats, supported formats such as table,
7647                         csv, json, yaml. It is of type STRING. By
7648                         default, it is table.
7649  -s | --long            whether to print all attributes or only short
7650                         attributes. It is of type BOOL. By default, it is
7651                         false.
7652  -t | --no-title        whether to print title or not. It is of type
7653                         BOOL. By default, it is false.
7654  -a | --no-auth         whether to authenticate user or not. It is of
7655                         type BOOL. By default, it is false.
7656
7657
7658 Results::
7659
7660  name               Onap customer name and is of type STRING.
7661  resource-version   Onap customer resource version and is of type
7662                     STRING.
7663
7664
7665 Error::
7666
7667  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
7668
7669
7670
7671 [17] customer-delete
7672 -----------------------------------------------
7673
7674
7675 usage: onap customer-delete
7676
7677 Delete a customer from Onap
7678
7679 Onap service: aai v8
7680
7681 Options::
7682
7683  [-x | --customer-name] [-y | --resource-version] [-u | --onap-username]
7684  [-p | --onap-password] [-m | --host-url] [-h | --help]
7685  [-v | --version] [-d | --debug] [-f | --format]
7686  [-s | --long] [-t | --no-title] [-a | --no-auth]
7687
7688 where::
7689
7690  -x | --customer-name     Onap customer name. It is of type STRING.
7691  -y | --resource-version  Onap customer resource version. It is of type
7692                           UUID. It is optional. By default, it is
7693                           6dc30068-de3c-483a-a9a8-7d483a39425d.
7694  -u | --onap-username     Onap user name. It is of type STRING. By default,
7695                           it is read from environment variable
7696                           OPEN_USERNAME.
7697  -p | --onap-password     Onap user password. It is of type STRING. By
7698                           default, it is read from environment variable
7699                           OPEN_PASSWORD. Secured.
7700  -m | --host-url          Onap host url. It is of type URL. By default, it
7701                           is read from environment variable OPEN_HOST_URL.
7702  -h | --help              Onap command help message. It is of type STRING.
7703                           By default, it is false.
7704  -v | --version           Onap command service version. It is of type
7705                           STRING. By default, it is false.
7706  -d | --debug             Enable debug output. It is of type BOOL. By
7707                           default, it is false.
7708  -f | --format            Output formats, supported formats such as table,
7709                           csv, json, yaml. It is of type STRING. By
7710                           default, it is table.
7711  -s | --long              whether to print all attributes or only short
7712                           attributes. It is of type BOOL. By default, it is
7713                           false.
7714  -t | --no-title          whether to print title or not. It is of type
7715                           BOOL. By default, it is false.
7716  -a | --no-auth           whether to authenticate user or not. It is of
7717                           type BOOL. By default, it is false.
7718
7719
7720 Error::
7721
7722  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
7723
7724
7725
7726 [18] customer-create
7727 -----------------------------------------------
7728
7729
7730 usage: onap customer-create
7731
7732 Create a customer in Onap
7733
7734 Onap service: aai v8
7735
7736 Options::
7737
7738  [-x | --customer-name] [-y | --subscriber-name] [-u | --onap-username]
7739  [-p | --onap-password] [-m | --host-url] [-h | --help]
7740  [-v | --version] [-d | --debug] [-f | --format]
7741  [-s | --long] [-t | --no-title] [-a | --no-auth]
7742
7743 where::
7744
7745  -x | --customer-name     Onap customer name. It is of type STRING.
7746  -y | --subscriber-name   Onap subscriber name. It is of type STRING.
7747  -u | --onap-username     Onap user name. It is of type STRING. By default,
7748                           it is read from environment variable
7749                           OPEN_USERNAME.
7750  -p | --onap-password     Onap user password. It is of type STRING. By
7751                           default, it is read from environment variable
7752                           OPEN_PASSWORD. Secured.
7753  -m | --host-url          Onap host url. It is of type URL. By default, it
7754                           is read from environment variable OPEN_HOST_URL.
7755  -h | --help              Onap command help message. It is of type STRING.
7756                           By default, it is false.
7757  -v | --version           Onap command service version. It is of type
7758                           STRING. By default, it is false.
7759  -d | --debug             Enable debug output. It is of type BOOL. By
7760                           default, it is false.
7761  -f | --format            Output formats, supported formats such as table,
7762                           csv, json, yaml. It is of type STRING. By
7763                           default, it is table.
7764  -s | --long              whether to print all attributes or only short
7765                           attributes. It is of type BOOL. By default, it is
7766                           false.
7767  -t | --no-title          whether to print title or not. It is of type
7768                           BOOL. By default, it is false.
7769  -a | --no-auth           whether to authenticate user or not. It is of
7770                           type BOOL. By default, it is false.
7771
7772
7773 Error::
7774
7775  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
7776
7777
7778
7779 <<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
7780 [19] service-type-create
7781 =======
7782 [16] customer-list
7783 -----------------------------------------------
7784
7785
7786 usage: onap customer-list
7787
7788 Lists the registetred customers in Onap
7789
7790 Onap service: aai v8
7791
7792 Options::
7793
7794  [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
7795  [-h | --help] [-v | --version] [-d | --debug]
7796  [-f | --format] [-s | --long] [-t | --no-title]
7797  [-a | --no-auth]
7798
7799 where::
7800
7801  -u | --onap-username   Onap user name. It is of type STRING. By default,
7802                         it is read from environment variable
7803                         OPEN_USERNAME.
7804  -p | --onap-password   Onap user password. It is of type STRING. By
7805                         default, it is read from environment variable
7806                         OPEN_PASSWORD. Secured.
7807  -m | --host-url        Onap host url. It is of type URL. By default, it
7808                         is read from environment variable OPEN_HOST_URL.
7809  -h | --help            Onap command help message. It is of type STRING.
7810                         By default, it is false.
7811  -v | --version         Onap command service version. It is of type
7812                         STRING. By default, it is false.
7813  -d | --debug           Enable debug output. It is of type BOOL. By
7814                         default, it is false.
7815  -f | --format          Output formats, supported formats such as table,
7816                         csv, json, yaml. It is of type STRING. By
7817                         default, it is table.
7818  -s | --long            whether to print all attributes or only short
7819                         attributes. It is of type BOOL. By default, it is
7820                         false.
7821  -t | --no-title        whether to print title or not. It is of type
7822                         BOOL. By default, it is false.
7823  -a | --no-auth         whether to authenticate user or not. It is of
7824                         type BOOL. By default, it is false.
7825
7826
7827 Results::
7828
7829  name               Onap customer name and is of type STRING.
7830  resource-version   Onap customer resource version and is of type
7831                     STRING.
7832
7833
7834 Error::
7835
7836  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
7837
7838
7839
7840 [17] customer-show
7841 -----------------------------------------------
7842
7843
7844 usage: onap customer-show
7845
7846 Lists the registetred customers in Onap
7847
7848 Onap service: aai v8
7849
7850 Options::
7851
7852  [-x | --customer-name] [-u | --onap-username] [-p | --onap-password]
7853  [-m | --host-url] [-h | --help] [-v | --version]
7854  [-d | --debug] [-f | --format] [-s | --long]
7855  [-t | --no-title] [-a | --no-auth]
7856
7857 where::
7858
7859  -x | --customer-name   Onap customer name. It is of type STRING.
7860  -u | --onap-username   Onap user name. It is of type STRING. By default,
7861                         it is read from environment variable
7862                         OPEN_USERNAME.
7863  -p | --onap-password   Onap user password. It is of type STRING. By
7864                         default, it is read from environment variable
7865                         OPEN_PASSWORD. Secured.
7866  -m | --host-url        Onap host url. It is of type URL. By default, it
7867                         is read from environment variable OPEN_HOST_URL.
7868  -h | --help            Onap command help message. It is of type STRING.
7869                         By default, it is false.
7870  -v | --version         Onap command service version. It is of type
7871                         STRING. By default, it is false.
7872  -d | --debug           Enable debug output. It is of type BOOL. By
7873                         default, it is false.
7874  -f | --format          Output formats, supported formats such as table,
7875                         csv, json, yaml. It is of type STRING. By
7876                         default, it is table.
7877  -s | --long            whether to print all attributes or only short
7878                         attributes. It is of type BOOL. By default, it is
7879                         false.
7880  -t | --no-title        whether to print title or not. It is of type
7881                         BOOL. By default, it is false.
7882  -a | --no-auth         whether to authenticate user or not. It is of
7883                         type BOOL. By default, it is false.
7884
7885
7886 Results::
7887
7888 <<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
7889 =======
7890  service-type   Onap service type and is of type STRING.
7891
7892
7893 Error::
7894
7895  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
7896
7897
7898
7899 customer-list
7900 -----------------------------------------------
7901
7902
7903 usage: onap customer-list
7904
7905 Lists the registetred customers in Onap
7906
7907 Onap service: aai v8
7908
7909 Options::
7910
7911  [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
7912  [-h | --help] [-v | --version] [-d | --debug]
7913  [-f | --format] [-s | --long] [-t | --no-title]
7914  [-a | --no-auth]
7915
7916 where::
7917
7918  -u | --onap-username   Onap user name. It is of type STRING. By default,
7919                         it is read from environment variable
7920                         OPEN_USERNAME.
7921  -p | --onap-password   Onap user password. It is of type STRING. By
7922                         default, it is read from environment variable
7923                         OPEN_PASSWORD. Secured.
7924  -m | --host-url        Onap host url. It is of type URL. By default, it
7925                         is read from environment variable OPEN_HOST_URL.
7926  -h | --help            Onap command help message. It is of type STRING.
7927                         By default, it is false.
7928  -v | --version         Onap command service version. It is of type
7929                         STRING. By default, it is false.
7930  -d | --debug           Enable debug output. It is of type BOOL. By
7931                         default, it is false.
7932  -f | --format          Output formats, supported formats such as table,
7933                         csv, json, yaml. It is of type STRING. By
7934                         default, it is table.
7935  -s | --long            whether to print all attributes or only short
7936                         attributes. It is of type BOOL. By default, it is
7937                         false.
7938  -t | --no-title        whether to print title or not. It is of type
7939                         BOOL. By default, it is false.
7940  -a | --no-auth         whether to authenticate user or not. It is of
7941                         type BOOL. By default, it is false.
7942
7943
7944 Results::
7945
7946 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
7947  name               Onap customer name and is of type STRING.
7948  subscriber-name    Onap subscriber name and is of type STRING.
7949  resource-version   Onap subscriber resource version and is of type
7950                     STRING.
7951  subscriber-type    Onap subscriber type and is of type STRING.
7952
7953
7954 Error::
7955
7956  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
7957
7958
7959
7960 <<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
7961 [18] service-type-create
7962 =======
7963 cloud-list
7964 -----------------------------------------------
7965
7966
7967 usage: onap cloud-list
7968
7969 List the configured clouds and Onap service subscriptions
7970
7971 Onap service: aai v8
7972
7973 Options::
7974
7975  [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
7976  [-h | --help] [-v | --version] [-d | --debug]
7977  [-f | --format] [-s | --long] [-t | --no-title]
7978  [-a | --no-auth]
7979
7980 where::
7981
7982  -u | --onap-username   Onap user name. It is of type STRING. By default,
7983                         it is read from environment variable
7984                         OPEN_USERNAME.
7985  -p | --onap-password   Onap user password. It is of type STRING. By
7986                         default, it is read from environment variable
7987                         OPEN_PASSWORD. Secured.
7988  -m | --host-url        Onap host url. It is of type URL. By default, it
7989                         is read from environment variable OPEN_HOST_URL.
7990  -h | --help            Onap command help message. It is of type STRING.
7991                         By default, it is false.
7992  -v | --version         Onap command service version. It is of type
7993                         STRING. By default, it is false.
7994  -d | --debug           Enable debug output. It is of type BOOL. By
7995                         default, it is false.
7996  -f | --format          Output formats, supported formats such as table,
7997                         csv, json, yaml. It is of type STRING. By
7998                         default, it is table.
7999  -s | --long            whether to print all attributes or only short
8000                         attributes. It is of type BOOL. By default, it is
8001                         false.
8002  -t | --no-title        whether to print title or not. It is of type
8003                         BOOL. By default, it is false.
8004  -a | --no-auth         whether to authenticate user or not. It is of
8005                         type BOOL. By default, it is false.
8006
8007
8008 Results::
8009
8010  cloud      Onap cloud and is of type STRING.
8011  region     Onap cloud region and is of type STRING.
8012  tenant     Onap cloud tenat and is of type STRING.
8013  tenant-id  Onap cloud tenat id and is of type STRING.
8014  customer   Onap cloud customer and is of type STRING.
8015  service    Onap cloud service and is of type STRING.
8016
8017
8018 Error::
8019
8020  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
8021
8022
8023
8024 service-type-create
8025 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
8026 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
8027 -----------------------------------------------
8028
8029
8030 usage: onap service-type-create
8031
8032 Add a service type in Onap
8033
8034 Onap service: aai v8
8035
8036 Options::
8037
8038  [-x | --service-type] [-y | --service-type-id] [-u | --onap-username]
8039  [-p | --onap-password] [-m | --host-url] [-h | --help]
8040  [-v | --version] [-d | --debug] [-f | --format]
8041  [-s | --long] [-t | --no-title] [-a | --no-auth]
8042
8043 where::
8044
8045  -x | --service-type      Onap service type. It is of type STRING.
8046  -y | --service-type-id   Onap service type uuid. It is of type UUID. It is
8047                           optional. By default, it is
8048                           eb4a0d54-0e29-4174-8a3c-2c98e904a5f6.
8049  -u | --onap-username     Onap user name. It is of type STRING. By default,
8050                           it is read from environment variable
8051                           OPEN_USERNAME.
8052  -p | --onap-password     Onap user password. It is of type STRING. By
8053                           default, it is read from environment variable
8054                           OPEN_PASSWORD. Secured.
8055  -m | --host-url          Onap host url. It is of type URL. By default, it
8056                           is read from environment variable OPEN_HOST_URL.
8057  -h | --help              Onap command help message. It is of type STRING.
8058                           By default, it is false.
8059  -v | --version           Onap command service version. It is of type
8060                           STRING. By default, it is false.
8061  -d | --debug             Enable debug output. It is of type BOOL. By
8062                           default, it is false.
8063  -f | --format            Output formats, supported formats such as table,
8064                           csv, json, yaml. It is of type STRING. By
8065                           default, it is table.
8066  -s | --long              whether to print all attributes or only short
8067                           attributes. It is of type BOOL. By default, it is
8068                           false.
8069  -t | --no-title          whether to print title or not. It is of type
8070                           BOOL. By default, it is false.
8071  -a | --no-auth           whether to authenticate user or not. It is of
8072                           type BOOL. By default, it is false.
8073
8074
8075 Error::
8076
8077  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
8078
8079
8080
8081 [20] service-type-delete
8082 -----------------------------------------------
8083
8084
8085 usage: onap service-type-delete
8086
8087 Delete a service type from Onap
8088
8089 Onap service: aai v8
8090
8091 Options::
8092
8093  [-x | --service-type-id] [-y | --resource-version] [-u | --onap-username]
8094  [-p | --onap-password] [-m | --host-url] [-h | --help]
8095  [-v | --version] [-d | --debug] [-f | --format]
8096  [-s | --long] [-t | --no-title] [-a | --no-auth]
8097
8098 where::
8099
8100  -x | --service-type-id   Onap service type uuid. It is of type UUID. It is
8101                           optional. By default, it is
8102                           31d3a8cb-d4ff-4b4e-a0d3-5f79f3062686.
8103  -y | --resource-version  Onap service resource version. It is of type
8104                           UUID. It is optional. By default, it is
8105                           b06576ca-74b8-42f2-815b-6f7b80f9941c.
8106  -u | --onap-username     Onap user name. It is of type STRING. By default,
8107                           it is read from environment variable
8108                           OPEN_USERNAME.
8109  -p | --onap-password     Onap user password. It is of type STRING. By
8110                           default, it is read from environment variable
8111                           OPEN_PASSWORD. Secured.
8112  -m | --host-url          Onap host url. It is of type URL. By default, it
8113                           is read from environment variable OPEN_HOST_URL.
8114  -h | --help              Onap command help message. It is of type STRING.
8115                           By default, it is false.
8116  -v | --version           Onap command service version. It is of type
8117                           STRING. By default, it is false.
8118  -d | --debug             Enable debug output. It is of type BOOL. By
8119                           default, it is false.
8120  -f | --format            Output formats, supported formats such as table,
8121                           csv, json, yaml. It is of type STRING. By
8122                           default, it is table.
8123  -s | --long              whether to print all attributes or only short
8124                           attributes. It is of type BOOL. By default, it is
8125                           false.
8126  -t | --no-title          whether to print title or not. It is of type
8127                           BOOL. By default, it is false.
8128  -a | --no-auth           whether to authenticate user or not. It is of
8129                           type BOOL. By default, it is false.
8130
8131
8132 Error::
8133
8134  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
8135
8136
8137
8138 [21] service-type-list
8139 -----------------------------------------------
8140
8141
8142 usage: onap service-type-list
8143
8144 List the service types configured in Onap
8145
8146 Onap service: aai v8
8147
8148 Options::
8149
8150  [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
8151  [-h | --help] [-v | --version] [-d | --debug]
8152  [-f | --format] [-s | --long] [-t | --no-title]
8153  [-a | --no-auth]
8154
8155 where::
8156
8157  -u | --onap-username   Onap user name. It is of type STRING. By default,
8158                         it is read from environment variable
8159                         OPEN_USERNAME.
8160  -p | --onap-password   Onap user password. It is of type STRING. By
8161                         default, it is read from environment variable
8162                         OPEN_PASSWORD. Secured.
8163  -m | --host-url        Onap host url. It is of type URL. By default, it
8164                         is read from environment variable OPEN_HOST_URL.
8165  -h | --help            Onap command help message. It is of type STRING.
8166                         By default, it is false.
8167  -v | --version         Onap command service version. It is of type
8168                         STRING. By default, it is false.
8169  -d | --debug           Enable debug output. It is of type BOOL. By
8170                         default, it is false.
8171  -f | --format          Output formats, supported formats such as table,
8172                         csv, json, yaml. It is of type STRING. By
8173                         default, it is table.
8174  -s | --long            whether to print all attributes or only short
8175                         attributes. It is of type BOOL. By default, it is
8176                         false.
8177  -t | --no-title        whether to print title or not. It is of type
8178                         BOOL. By default, it is false.
8179  -a | --no-auth         whether to authenticate user or not. It is of
8180                         type BOOL. By default, it is false.
8181
8182
8183 Results::
8184
8185  service-type-id    Onap cloud service and is of type STRING.
8186  service-type       Onap cloud service and is of type STRING.
8187  resource-version   Onap cloud service resource version and is of
8188                     type STRING.
8189
8190
8191 Error::
8192
8193  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
8194
8195
8196
8197 <<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
8198 [22] cloud-list
8199 =======
8200 [21] subscription-create
8201 -----------------------------------------------
8202
8203
8204 usage: onap subscription-create
8205
8206 Create a subscription for a customer in Onap
8207
8208 Onap service: aai v8
8209
8210 Options::
8211
8212  [-x | --customer-name] [-y | --subscriber-name] [-z | --cloud-type]
8213  [-r | --cloud-region] [-c | --cloud-tenant-id] [-e | --service-type]
8214  [-g | --resource-version] [-u | --onap-username] [-p | --onap-password]
8215  [-m | --host-url] [-h | --help] [-v | --version]
8216  [-d | --debug] [-f | --format] [-s | --long]
8217  [-t | --no-title] [-a | --no-auth]
8218
8219 where::
8220
8221  -x | --customer-name     Onap customer name. It is of type STRING.
8222  -y | --subscriber-name   Onap subscriber name. It is of type STRING.
8223  -z | --cloud-type        Onap cloud type (openstack, rackspace). It is of
8224                           type STRING.
8225  -r | --cloud-region      Onap cloud region. It is of type STRING.
8226  -c | --cloud-tenant-id   Onap cloud tenant id. It is of type STRING.
8227  -e | --service-type      Onap service type. It is of type STRING.
8228  -g | --resource-version  Onap subscription resource version. It is
8229                           mandatory for existing customer to create a new
8230                           subscription. It is of type STRING. It is
8231                           optional.
8232  -u | --onap-username     Onap user name. It is of type STRING. By default,
8233                           it is read from environment variable
8234                           OPEN_USERNAME.
8235  -p | --onap-password     Onap user password. It is of type STRING. By
8236                           default, it is read from environment variable
8237                           OPEN_PASSWORD. Secured.
8238  -m | --host-url          Onap host url. It is of type URL. By default, it
8239                           is read from environment variable OPEN_HOST_URL.
8240  -h | --help              Onap command help message. It is of type STRING.
8241                           By default, it is false.
8242  -v | --version           Onap command service version. It is of type
8243                           STRING. By default, it is false.
8244  -d | --debug             Enable debug output. It is of type BOOL. By
8245                           default, it is false.
8246  -f | --format            Output formats, supported formats such as table,
8247                           csv, json, yaml. It is of type STRING. By
8248                           default, it is table.
8249  -s | --long              whether to print all attributes or only short
8250                           attributes. It is of type BOOL. By default, it is
8251                           false.
8252  -t | --no-title          whether to print title or not. It is of type
8253                           BOOL. By default, it is false.
8254  -a | --no-auth           whether to authenticate user or not. It is of
8255                           type BOOL. By default, it is false.
8256
8257
8258 Error::
8259
8260  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
8261
8262
8263
8264 <<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
8265 [22] subscription-list
8266 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
8267 -----------------------------------------------
8268
8269
8270 usage: onap cloud-list
8271
8272 List the configured clouds and Onap service subscriptions
8273
8274 Onap service: aai v8
8275
8276 Options::
8277
8278  [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
8279  [-h | --help] [-v | --version] [-d | --debug]
8280  [-f | --format] [-s | --long] [-t | --no-title]
8281  [-a | --no-auth]
8282
8283 where::
8284
8285  -u | --onap-username   Onap user name. It is of type STRING. By default,
8286                         it is read from environment variable
8287                         ONAP_USERNAME.
8288  -p | --onap-password   Onap user password. It is of type STRING. By
8289                         default, it is read from environment variable
8290                         ONAP_PASSWORD. Secured.
8291  -m | --host-url        Onap host url. It is of type URL. By default, it
8292                         is read from environment variable ONAP_HOST_URL.
8293  -h | --help            Onap command help message. It is of type STRING.
8294                         By default, it is false.
8295  -v | --version         Onap command service version. It is of type
8296                         STRING. By default, it is false.
8297  -d | --debug           Enable debug output. It is of type BOOL. By
8298                         default, it is false.
8299  -f | --format          Output formats, supported formats such as table,
8300                         csv, json, yaml. It is of type STRING. By
8301                         default, it is table.
8302  -s | --long            whether to print all attributes or only short
8303                         attributes. It is of type BOOL. By default, it is
8304                         false.
8305  -t | --no-title        whether to print title or not. It is of type
8306                         BOOL. By default, it is false.
8307  -a | --no-auth         whether to authenticate user or not. It is of
8308                         type BOOL. By default, it is false.
8309
8310
8311 Results::
8312
8313  cloud      Onap cloud and is of type STRING.
8314  region     Onap cloud region and is of type STRING.
8315  tenant     Onap cloud tenat and is of type STRING.
8316  tenant-id  Onap cloud tenat id and is of type STRING.
8317  customer   Onap cloud customer and is of type STRING.
8318  service    Onap cloud service and is of type STRING.
8319
8320
8321 Error::
8322
8323  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
8324
8325
8326
8327 cli-1.0
8328 =======
8329 open-cli
8330 >>>>>>> Migrate docs to use OPEN_ instead of ONAP_
8331 ==========================
8332
8333
8334 [1] schema-validate
8335 -----------------------------------------------
8336
8337
8338 usage: onap schema-validate
8339
8340 Onap command to validate schema
8341
8342 Onap service: onap-cli 1.0.0
8343
8344 Options::
8345
8346  [-l | --schema-location] [-i | --internal-schema] [-h | --help]
8347  [-v | --version] [-d | --debug] [-f | --format]
8348  [-s | --long] [-t | --no-title]
8349
8350 where::
8351
8352  -l | --schema-location   Schema file location. It is of type URL.
8353  -i | --internal-schema   Validate existing schema file. It is of type
8354                           BOOL. By default, it is false.
8355  -h | --help              Onap command help message. It is of type STRING.
8356                           By default, it is false.
8357  -v | --version           Onap command service version. It is of type
8358                           STRING. By default, it is false.
8359  -d | --debug             Enable debug output. It is of type BOOL. By
8360                           default, it is false.
8361  -f | --format            Output formats, supported formats such as table,
8362                           csv, json, yaml. It is of type STRING. By
8363                           default, it is table.
8364  -s | --long              whether to print all attributes or only short
8365                           attributes. It is of type BOOL. By default, it is
8366                           false.
8367  -t | --no-title          whether to print title or not. It is of type
8368                           BOOL. By default, it is false.
8369
8370
8371 Results::
8372
8373  sl-no  Serial Number of error and is of type STRING.
8374  error  Schema validation error and is of type STRING.
8375
8376
8377 Error::
8378
8379  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
8380
8381
8382
8383 [2] schema-refresh
8384 -----------------------------------------------
8385
8386
8387 usage: onap schema-refresh
8388
8389 Onap command to refresh schemas stored in onap_cli_schema folders.
8390
8391 Onap service: onap-cli 1.0.0
8392
8393 Options::
8394
8395  [-h | --help] [-v | --version] [-d | --debug]
8396  [-f | --format] [-s | --long] [-t | --no-title]
8397
8398 where::
8399
8400  -h | --help      Onap command help message. It is of type STRING.
8401                   By default, it is false.
8402  -v | --version   Onap command service version. It is of type
8403                   STRING. By default, it is false.
8404  -d | --debug     Enable debug output. It is of type BOOL. By
8405                   default, it is false.
8406  -f | --format    Output formats, supported formats such as table,
8407                   csv, json, yaml. It is of type STRING. By
8408                   default, it is table.
8409  -s | --long      whether to print all attributes or only short
8410                   attributes. It is of type BOOL. By default, it is
8411                   false.
8412  -t | --no-title  whether to print title or not. It is of type
8413                   BOOL. By default, it is false.
8414
8415
8416 Results::
8417
8418  sl-no            Serial Number and is of type STRING.
8419  command          Command name and is of type STRING.
8420  product-version  Command product version and is of type STRING.
8421  schema           Schema name and is of type STRING.
8422  version          Schema version and is of type STRING.
8423
8424
8425 Error::
8426
8427  On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>