docs/cmd_help.rst

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