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