docs/cmd_help_onap_beijing.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. Copyright 2018 Huawei Technologies Co., Ltd.
   4
   5
   6 .. toctree::
   7    :maxdepth: 2
   8
   9
  10 .. _cli_cmd_help_onap_beijing:
  11
  12
  13 onap-beijing
  14 ==============
  15
  16 [1] basic-login
  17 -----------------------------------------------
  18
  19
  20 usage: oclip basic-login
  21
  22 ONAP basic login auth command
  23
  24 Product: onap-beijing
  25 Service: basic-auth
  26 Author: ONAP CLI Team onap-discuss@lists.onap.org
  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 override 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  X-TransactionId  X-TransactionId and is of type STRING.
  71  X-FromAppId      X-FromAppId and is of type STRING.
  72
  73
  74 Error::
  75
  76  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
  77
  78
  79
  80 [2] basic-logout
  81 -----------------------------------------------
  82
  83
  84 usage: oclip basic-logout
  85
  86 ONAP basic logout auth command
  87
  88 Product: onap-beijing
  89 Service: basic-auth
  90 Author: ONAP CLI Team onap-discuss@lists.onap.org
  91
  92 Options::
  93
  94  [-m | --host-url] [-C | --no-catalog] [-h | --help]
  95  [-f | --format] [-t | --no-title] [-V | --verify]
  96  [-v | --version] [-d | --debug] [-s | --long]
  97  [-D | --context]
  98
  99 where::
 100
 101  -m | --host-url    host url in http(s). It is of type URL. By
 102                     default, it is read from environment variable
 103                     OPEN_CLI_HOST_URL.
 104  -C | --no-catalog  whether to use given host-url directly without
 105                     looking into catalog, it will override the
 106                     service->mode. It is of type BOOL. It is
 107                     optional.
 108  -h | --help        print help message. It is of type BOOL.
 109  -f | --format      Output formats, supported formats such as table,
 110                     csv, json, yaml. It is of type STRING.
 111  -t | --no-title    whether to print title or not. It is of type BOOL.
 112  -V | --verify      verify the command using available command sample
 113                     file and mocking file. By default it goes with
 114                     mock style. To enable the verification in real
 115                     time, set DISABLE_MOCKING=true in the context
 116                     param. It is of type BOOL. It is optional.
 117  -v | --version     print service version. It is of type BOOL.
 118  -d | --debug       Enable debug output. It is of type BOOL.
 119  -s | --long        whether to print all attributes or only short
 120                     attributes. It is of type BOOL.
 121  -D | --context     command context. It is of type MAP. It is
 122                     optional.
 123
 124
 125 Error::
 126
 127  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
 128
 129
 130
 131 [3] catalog
 132 -----------------------------------------------
 133
 134
 135 usage: oclip catalog
 136
 137 ONAP catalog command to find the base path for service.
 138
 139 Product: onap-beijing
 140 Service: msb
 141 Author: ONAP CLI Team onap-discuss@lists.onap.org
 142
 143 Options::
 144
 145  [-m | --host-url] [-C | --no-catalog] [-l | --catalog-service-name]
 146  [-h | --help] [-f | --format] [-t | --no-title]
 147  [-V | --verify] [-v | --version] [-d | --debug]
 148  [-s | --long] [-D | --context] [-i | --catalog-service-version]
 149
 150 where::
 151
 152  -m | --host-url                  host url in http(s). It is of type URL. By
 153                                   default, it is read from environment variable
 154                                   OPEN_CLI_HOST_URL.
 155  -C | --no-catalog                whether to use given host-url directly without
 156                                   looking into catalog, it will override the
 157                                   service->mode. It is of type BOOL. It is
 158                                   optional.
 159  -l | --catalog-service-name      service name registered in catalog service. It is
 160                                   of type STRING. By default, it is .
 161  -h | --help                      print help message. It is of type BOOL.
 162  -f | --format                    Output formats, supported formats such as table,
 163                                   csv, json, yaml. It is of type STRING.
 164  -t | --no-title                  whether to print title or not. It is of type BOOL.
 165  -V | --verify                    verify the command using available command sample
 166                                   file and mocking file. By default it goes with
 167                                   mock style. To enable the verification in real
 168                                   time, set DISABLE_MOCKING=true in the context
 169                                   param. It is of type BOOL. It is optional.
 170  -v | --version                   print service version. It is of type BOOL.
 171  -d | --debug                     Enable debug output. It is of type BOOL.
 172  -s | --long                      whether to print all attributes or only short
 173                                   attributes. It is of type BOOL.
 174  -D | --context                   command context. It is of type MAP. It is
 175                                   optional.
 176  -i | --catalog-service-version   service version registered in catalog service. It
 177                                   is of type STRING. By default, it is .
 178
 179
 180 Results::
 181
 182  catalog-service-host-url   Service connection url and is of type STRING.
 183  catalog-service-base-path  service base path, to append with host-url for
 184                             connecting the service. and is of type STRING.
 185
 186
 187 Error::
 188
 189  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
 190
 191
 192
 193 [4] cloud-create
 194 -----------------------------------------------
 195
 196
 197 usage: oclip cloud-create
 198
 199 Create a cloud region in Onap
 200
 201 Product: onap-beijing
 202 Service: aai
 203 Author: ONAP CLI Team onap-discuss@lists.onap.org
 204
 205 Options::
 206
 207  [-m | --host-url] [-C | --no-catalog] [-h | --help]
 208  [-f | --format] [-t | --no-title] [-V | --verify]
 209  [-v | --version] [-d | --debug] [-x | --cloud-name]
 210  [-s | --long] [-D | --context] [-y | --region-name]
 211  [-u | --host-username] [-a | --no-auth] [-p | --host-password]
 212
 213 where::
 214
 215  -m | --host-url        host url in http(s). It is of type URL. By
 216                         default, it is read from environment variable
 217                         OPEN_CLI_HOST_URL.
 218  -C | --no-catalog      whether to use given host-url directly without
 219                         looking into catalog, it will override the
 220                         service->mode. It is of type BOOL. It is
 221                         optional.
 222  -h | --help            print help message. It is of type BOOL.
 223  -f | --format          Output formats, supported formats such as table,
 224                         csv, json, yaml. It is of type STRING.
 225  -t | --no-title        whether to print title or not. It is of type BOOL.
 226  -V | --verify          verify the command using available command sample
 227                         file and mocking file. By default it goes with
 228                         mock style. To enable the verification in real
 229                         time, set DISABLE_MOCKING=true in the context
 230                         param. It is of type BOOL. It is optional.
 231  -v | --version         print service version. It is of type BOOL.
 232  -d | --debug           Enable debug output. It is of type BOOL.
 233  -x | --cloud-name      Onap cloud name. It is of type STRING. By
 234                         default, it is .
 235  -s | --long            whether to print all attributes or only short
 236                         attributes. It is of type BOOL.
 237  -D | --context         command context. It is of type MAP. It is
 238                         optional.
 239  -y | --region-name     Onap region name. It is of type STRING. By
 240                         default, it is .
 241  -u | --host-username   Host user name. It is of type STRING. By default,
 242                         it is read from environment variable
 243                         OPEN_CLI_HOST_USERNAME.
 244  -a | --no-auth         whether to authenticate user or not. It is of
 245                         type BOOL.
 246  -p | --host-password   Host user password. It is of type STRING. By
 247                         default, it is read from environment variable
 248                         OPEN_CLI_HOST_PASSWORD. Secured.
 249
 250
 251 Error::
 252
 253  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
 254
 255
 256
 257 [5] cloud-delete
 258 -----------------------------------------------
 259
 260
 261 usage: oclip cloud-delete
 262
 263 Delete a cloud region from Onap
 264
 265 Product: onap-beijing
 266 Service: aai
 267 Author: ONAP CLI Team onap-discuss@lists.onap.org
 268
 269 Options::
 270
 271  [-m | --host-url] [-C | --no-catalog] [-h | --help]
 272  [-f | --format] [-t | --no-title] [-V | --verify]
 273  [-v | --version] [-d | --debug] [-x | --cloud-name]
 274  [-z | --resource-version] [-s | --long] [-D | --context]
 275  [-y | --region-name] [-u | --host-username] [-a | --no-auth]
 276  [-p | --host-password]
 277
 278 where::
 279
 280  -m | --host-url          host url in http(s). It is of type URL. By
 281                           default, it is read from environment variable
 282                           OPEN_CLI_HOST_URL.
 283  -C | --no-catalog        whether to use given host-url directly without
 284                           looking into catalog, it will override the
 285                           service->mode. It is of type BOOL. It is
 286                           optional.
 287  -h | --help              print help message. It is of type BOOL.
 288  -f | --format            Output formats, supported formats such as table,
 289                           csv, json, yaml. It is of type STRING.
 290  -t | --no-title          whether to print title or not. It is of type BOOL.
 291  -V | --verify            verify the command using available command sample
 292                           file and mocking file. By default it goes with
 293                           mock style. To enable the verification in real
 294                           time, set DISABLE_MOCKING=true in the context
 295                           param. It is of type BOOL. It is optional.
 296  -v | --version           print service version. It is of type BOOL.
 297  -d | --debug             Enable debug output. It is of type BOOL.
 298  -x | --cloud-name        Onap cloud name. It is of type STRING. By
 299                           default, it is .
 300  -z | --resource-version  Onap cloud region version. It is of type UUID. It
 301                           is optional.
 302  -s | --long              whether to print all attributes or only short
 303                           attributes. It is of type BOOL.
 304  -D | --context           command context. It is of type MAP. It is
 305                           optional.
 306  -y | --region-name       Onap cloud region name. It is of type STRING. By
 307                           default, it is .
 308  -u | --host-username     Host user name. It is of type STRING. By default,
 309                           it is read from environment variable
 310                           OPEN_CLI_HOST_USERNAME.
 311  -a | --no-auth           whether to authenticate user or not. It is of
 312                           type BOOL.
 313  -p | --host-password     Host user password. It is of type STRING. By
 314                           default, it is read from environment variable
 315                           OPEN_CLI_HOST_PASSWORD. Secured.
 316
 317
 318 Error::
 319
 320  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
 321
 322
 323
 324 [6] cloud-list
 325 -----------------------------------------------
 326
 327
 328 usage: oclip cloud-list
 329
 330 List the configured clouds and Onap service subscriptions
 331
 332 Product: onap-beijing
 333 Service: aai
 334 Author: ONAP CLI Team onap-discuss@lists.onap.org
 335
 336 Options::
 337
 338  [-m | --host-url] [-C | --no-catalog] [-h | --help]
 339  [-f | --format] [-t | --no-title] [-V | --verify]
 340  [-v | --version] [-d | --debug] [-s | --long]
 341  [-D | --context] [-u | --host-username] [-a | --no-auth]
 342  [-p | --host-password]
 343
 344 where::
 345
 346  -m | --host-url        host url in http(s). It is of type URL. By
 347                         default, it is read from environment variable
 348                         OPEN_CLI_HOST_URL.
 349  -C | --no-catalog      whether to use given host-url directly without
 350                         looking into catalog, it will override the
 351                         service->mode. It is of type BOOL. It is
 352                         optional.
 353  -h | --help            print help message. It is of type BOOL.
 354  -f | --format          Output formats, supported formats such as table,
 355                         csv, json, yaml. It is of type STRING.
 356  -t | --no-title        whether to print title or not. It is of type BOOL.
 357  -V | --verify          verify the command using available command sample
 358                         file and mocking file. By default it goes with
 359                         mock style. To enable the verification in real
 360                         time, set DISABLE_MOCKING=true in the context
 361                         param. It is of type BOOL. It is optional.
 362  -v | --version         print service version. It is of type BOOL.
 363  -d | --debug           Enable debug output. It is of type BOOL.
 364  -s | --long            whether to print all attributes or only short
 365                         attributes. It is of type BOOL.
 366  -D | --context         command context. It is of type MAP. It is
 367                         optional.
 368  -u | --host-username   Host user name. It is of type STRING. By default,
 369                         it is read from environment variable
 370                         OPEN_CLI_HOST_USERNAME.
 371  -a | --no-auth         whether to authenticate user or not. It is of
 372                         type BOOL.
 373  -p | --host-password   Host user password. It is of type STRING. By
 374                         default, it is read from environment variable
 375                         OPEN_CLI_HOST_PASSWORD. Secured.
 376
 377
 378 Results::
 379
 380  cloud              Onap cloud and is of type STRING.
 381  region             Onap cloud region and is of type STRING.
 382  tenant             Onap cloud tenat and is of type STRING.
 383  tenant-id          Onap cloud tenat id and is of type STRING.
 384  customer           Onap cloud customer and is of type STRING.
 385  service            Onap cloud service and is of type STRING.
 386  resource-version   Onap cloud resource version and is of type STRING.
 387
 388
 389 Error::
 390
 391  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
 392
 393
 394
 395 [7] customer-create
 396 -----------------------------------------------
 397
 398
 399 usage: oclip customer-create
 400
 401 Create a customer in Onap
 402
 403 Product: onap-beijing
 404 Service: aai
 405 Author: ONAP CLI Team onap-discuss@lists.onap.org
 406
 407 Options::
 408
 409  [-m | --host-url] [-y | --subscriber-name] [-C | --no-catalog]
 410  [-h | --help] [-f | --format] [-t | --no-title]
 411  [-V | --verify] [-v | --version] [-d | --debug]
 412  [-x | --customer-name] [-s | --long] [-D | --context]
 413  [-u | --host-username] [-a | --no-auth] [-p | --host-password]
 414
 415 where::
 416
 417  -m | --host-url          host url in http(s). It is of type URL. By
 418                           default, it is read from environment variable
 419                           OPEN_CLI_HOST_URL.
 420  -y | --subscriber-name   Onap subscriber name. It is of type STRING. By
 421                           default, it is .
 422  -C | --no-catalog        whether to use given host-url directly without
 423                           looking into catalog, it will override the
 424                           service->mode. It is of type BOOL. It is
 425                           optional.
 426  -h | --help              print help message. It is of type BOOL.
 427  -f | --format            Output formats, supported formats such as table,
 428                           csv, json, yaml. It is of type STRING.
 429  -t | --no-title          whether to print title or not. It is of type BOOL.
 430  -V | --verify            verify the command using available command sample
 431                           file and mocking file. By default it goes with
 432                           mock style. To enable the verification in real
 433                           time, set DISABLE_MOCKING=true in the context
 434                           param. It is of type BOOL. It is optional.
 435  -v | --version           print service version. It is of type BOOL.
 436  -d | --debug             Enable debug output. It is of type BOOL.
 437  -x | --customer-name     Onap customer name. It is of type STRING. By
 438                           default, it is .
 439  -s | --long              whether to print all attributes or only short
 440                           attributes. It is of type BOOL.
 441  -D | --context           command context. It is of type MAP. It is
 442                           optional.
 443  -u | --host-username     Host user name. It is of type STRING. By default,
 444                           it is read from environment variable
 445                           OPEN_CLI_HOST_USERNAME.
 446  -a | --no-auth           whether to authenticate user or not. It is of
 447                           type BOOL.
 448  -p | --host-password     Host user password. It is of type STRING. By
 449                           default, it is read from environment variable
 450                           OPEN_CLI_HOST_PASSWORD. Secured.
 451
 452
 453 Error::
 454
 455  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
 456
 457
 458
 459 [8] customer-delete
 460 -----------------------------------------------
 461
 462
 463 usage: oclip customer-delete
 464
 465 Delete a customer from Onap
 466
 467 Product: onap-beijing
 468 Service: aai
 469 Author: ONAP CLI Team onap-discuss@lists.onap.org
 470
 471 Options::
 472
 473  [-m | --host-url] [-C | --no-catalog] [-h | --help]
 474  [-f | --format] [-t | --no-title] [-V | --verify]
 475  [-v | --version] [-d | --debug] [-x | --customer-name]
 476  [-y | --resource-version] [-s | --long] [-D | --context]
 477  [-u | --host-username] [-a | --no-auth] [-p | --host-password]
 478
 479 where::
 480
 481  -m | --host-url          host url in http(s). It is of type URL. By
 482                           default, it is read from environment variable
 483                           OPEN_CLI_HOST_URL.
 484  -C | --no-catalog        whether to use given host-url directly without
 485                           looking into catalog, it will override the
 486                           service->mode. It is of type BOOL. It is
 487                           optional.
 488  -h | --help              print help message. It is of type BOOL.
 489  -f | --format            Output formats, supported formats such as table,
 490                           csv, json, yaml. It is of type STRING.
 491  -t | --no-title          whether to print title or not. It is of type BOOL.
 492  -V | --verify            verify the command using available command sample
 493                           file and mocking file. By default it goes with
 494                           mock style. To enable the verification in real
 495                           time, set DISABLE_MOCKING=true in the context
 496                           param. It is of type BOOL. It is optional.
 497  -v | --version           print service version. It is of type BOOL.
 498  -d | --debug             Enable debug output. It is of type BOOL.
 499  -x | --customer-name     Onap customer name. It is of type STRING. By
 500                           default, it is .
 501  -y | --resource-version  Onap customer resource version. It is of type
 502                           UUID. It is optional.
 503  -s | --long              whether to print all attributes or only short
 504                           attributes. It is of type BOOL.
 505  -D | --context           command context. It is of type MAP. It is
 506                           optional.
 507  -u | --host-username     Host user name. It is of type STRING. By default,
 508                           it is read from environment variable
 509                           OPEN_CLI_HOST_USERNAME.
 510  -a | --no-auth           whether to authenticate user or not. It is of
 511                           type BOOL.
 512  -p | --host-password     Host user password. It is of type STRING. By
 513                           default, it is read from environment variable
 514                           OPEN_CLI_HOST_PASSWORD. Secured.
 515
 516
 517 Error::
 518
 519  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
 520
 521
 522
 523 [9] customer-list
 524 -----------------------------------------------
 525
 526
 527 usage: oclip customer-list
 528
 529 Lists the registered customers in Onap
 530
 531 Product: onap-beijing
 532 Service: aai
 533 Author: ONAP CLI Team onap-discuss@lists.onap.org
 534
 535 Options::
 536
 537  [-m | --host-url] [-C | --no-catalog] [-h | --help]
 538  [-f | --format] [-t | --no-title] [-V | --verify]
 539  [-v | --version] [-d | --debug] [-s | --long]
 540  [-D | --context] [-u | --host-username] [-a | --no-auth]
 541  [-p | --host-password]
 542
 543 where::
 544
 545  -m | --host-url        host url in http(s). It is of type URL. By
 546                         default, it is read from environment variable
 547                         OPEN_CLI_HOST_URL.
 548  -C | --no-catalog      whether to use given host-url directly without
 549                         looking into catalog, it will override the
 550                         service->mode. It is of type BOOL. It is
 551                         optional.
 552  -h | --help            print help message. It is of type BOOL.
 553  -f | --format          Output formats, supported formats such as table,
 554                         csv, json, yaml. It is of type STRING.
 555  -t | --no-title        whether to print title or not. It is of type BOOL.
 556  -V | --verify          verify the command using available command sample
 557                         file and mocking file. By default it goes with
 558                         mock style. To enable the verification in real
 559                         time, set DISABLE_MOCKING=true in the context
 560                         param. It is of type BOOL. It is optional.
 561  -v | --version         print service version. It is of type BOOL.
 562  -d | --debug           Enable debug output. It is of type BOOL.
 563  -s | --long            whether to print all attributes or only short
 564                         attributes. It is of type BOOL.
 565  -D | --context         command context. It is of type MAP. It is
 566                         optional.
 567  -u | --host-username   Host user name. It is of type STRING. By default,
 568                         it is read from environment variable
 569                         OPEN_CLI_HOST_USERNAME.
 570  -a | --no-auth         whether to authenticate user or not. It is of
 571                         type BOOL.
 572  -p | --host-password   Host user password. It is of type STRING. By
 573                         default, it is read from environment variable
 574                         OPEN_CLI_HOST_PASSWORD. Secured.
 575
 576
 577 Results::
 578
 579  name               Onap customer name and is of type STRING.
 580  resource-version   Onap customer resource version and is of type
 581                     STRING.
 582
 583
 584 Error::
 585
 586  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
 587
 588
 589
 590 [10] customer-show
 591 -----------------------------------------------
 592
 593
 594 usage: oclip customer-show
 595
 596 Retrieves the given registered customer in Onap
 597
 598 Product: onap-beijing
 599 Service: aai
 600 Author: ONAP CLI Team onap-discuss@lists.onap.org
 601
 602 Options::
 603
 604  [-m | --host-url] [-C | --no-catalog] [-h | --help]
 605  [-f | --format] [-t | --no-title] [-V | --verify]
 606  [-v | --version] [-d | --debug] [-x | --customer-name]
 607  [-s | --long] [-D | --context] [-u | --host-username]
 608  [-a | --no-auth] [-p | --host-password]
 609
 610 where::
 611
 612  -m | --host-url        host url in http(s). It is of type URL. By
 613                         default, it is read from environment variable
 614                         OPEN_CLI_HOST_URL.
 615  -C | --no-catalog      whether to use given host-url directly without
 616                         looking into catalog, it will override the
 617                         service->mode. It is of type BOOL. It is
 618                         optional.
 619  -h | --help            print help message. It is of type BOOL.
 620  -f | --format          Output formats, supported formats such as table,
 621                         csv, json, yaml. It is of type STRING.
 622  -t | --no-title        whether to print title or not. It is of type BOOL.
 623  -V | --verify          verify the command using available command sample
 624                         file and mocking file. By default it goes with
 625                         mock style. To enable the verification in real
 626                         time, set DISABLE_MOCKING=true in the context
 627                         param. It is of type BOOL. It is optional.
 628  -v | --version         print service version. It is of type BOOL.
 629  -d | --debug           Enable debug output. It is of type BOOL.
 630  -x | --customer-name   Onap customer name. It is of type STRING. By
 631                         default, it is .
 632  -s | --long            whether to print all attributes or only short
 633                         attributes. It is of type BOOL.
 634  -D | --context         command context. It is of type MAP. It is
 635                         optional.
 636  -u | --host-username   Host user name. It is of type STRING. By default,
 637                         it is read from environment variable
 638                         OPEN_CLI_HOST_USERNAME.
 639  -a | --no-auth         whether to authenticate user or not. It is of
 640                         type BOOL.
 641  -p | --host-password   Host user password. It is of type STRING. By
 642                         default, it is read from environment variable
 643                         OPEN_CLI_HOST_PASSWORD. Secured.
 644
 645
 646 Results::
 647
 648  name               Onap customer name and is of type STRING.
 649  subscriber-name    Onap subscriber name and is of type STRING.
 650  resource-version   Onap subscriber resource version and is of type
 651                     STRING.
 652  subscriber-type    Onap subscriber type and is of type STRING.
 653
 654
 655 Error::
 656
 657  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
 658
 659
 660
 661 [11] ems-list
 662 -----------------------------------------------
 663
 664
 665 usage: oclip ems-list
 666
 667 List the configured ems
 668
 669 Product: onap-beijing
 670 Service: aai
 671 Author: ONAP CLI Team onap-discuss@lists.onap.org
 672
 673 Options::
 674
 675  [-m | --host-url] [-C | --no-catalog] [-h | --help]
 676  [-f | --format] [-t | --no-title] [-V | --verify]
 677  [-v | --version] [-d | --debug] [-s | --long]
 678  [-D | --context] [-u | --host-username] [-a | --no-auth]
 679  [-p | --host-password]
 680
 681 where::
 682
 683  -m | --host-url        host url in http(s). It is of type URL. By
 684                         default, it is read from environment variable
 685                         OPEN_CLI_HOST_URL.
 686  -C | --no-catalog      whether to use given host-url directly without
 687                         looking into catalog, it will override the
 688                         service->mode. It is of type BOOL. It is
 689                         optional.
 690  -h | --help            print help message. It is of type BOOL.
 691  -f | --format          Output formats, supported formats such as table,
 692                         csv, json, yaml. It is of type STRING.
 693  -t | --no-title        whether to print title or not. It is of type BOOL.
 694  -V | --verify          verify the command using available command sample
 695                         file and mocking file. By default it goes with
 696                         mock style. To enable the verification in real
 697                         time, set DISABLE_MOCKING=true in the context
 698                         param. It is of type BOOL. It is optional.
 699  -v | --version         print service version. It is of type BOOL.
 700  -d | --debug           Enable debug output. It is of type BOOL.
 701  -s | --long            whether to print all attributes or only short
 702                         attributes. It is of type BOOL.
 703  -D | --context         command context. It is of type MAP. It is
 704                         optional.
 705  -u | --host-username   Host user name. It is of type STRING. By default,
 706                         it is read from environment variable
 707                         OPEN_CLI_HOST_USERNAME.
 708  -a | --no-auth         whether to authenticate user or not. It is of
 709                         type BOOL.
 710  -p | --host-password   Host user password. It is of type STRING. By
 711                         default, it is read from environment variable
 712                         OPEN_CLI_HOST_PASSWORD. Secured.
 713
 714
 715 Results::
 716
 717  ems-id             Onap ems id and is of type STRING.
 718  resource-version   Onap ems resource version and is of type STRING.
 719
 720
 721 Error::
 722
 723  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
 724
 725
 726
 727 [12] ems-register
 728 -----------------------------------------------
 729
 730
 731 usage: oclip ems-register
 732
 733 Register a EMS in Onap
 734
 735 Product: onap-beijing
 736 Service: aai
 737 Author: ONAP CLI Team onap-discuss@lists.onap.org
 738
 739 Options::
 740
 741  [-m | --host-url] [-C | --no-catalog] [-h | --help]
 742  [-f | --format] [-t | --no-title] [-V | --verify]
 743  [-e | --vendor] [-v | --version] [-d | --debug]
 744  [-c | --type] [-s | --long] [-D | --context]
 745  [-q | --ems-version] [-b | --name] [-i | --username]
 746  [-j | --password] [-u | --host-username] [-g | --url]
 747  [-x | --remote-path] [-a | --no-auth] [-z | --ems-id]
 748  [-p | --host-password]
 749
 750 where::
 751
 752  -m | --host-url        host url in http(s). It is of type URL. By
 753                         default, it is read from environment variable
 754                         OPEN_CLI_HOST_URL.
 755  -C | --no-catalog      whether to use given host-url directly without
 756                         looking into catalog, it will override the
 757                         service->mode. It is of type BOOL. It is
 758                         optional.
 759  -h | --help            print help message. It is of type BOOL.
 760  -f | --format          Output formats, supported formats such as table,
 761                         csv, json, yaml. It is of type STRING.
 762  -t | --no-title        whether to print title or not. It is of type BOOL.
 763  -V | --verify          verify the command using available command sample
 764                         file and mocking file. By default it goes with
 765                         mock style. To enable the verification in real
 766                         time, set DISABLE_MOCKING=true in the context
 767                         param. It is of type BOOL. It is optional.
 768  -e | --vendor          Onap EMS vendor. It is of type STRING. By
 769                         default, it is .
 770  -v | --version         print service version. It is of type BOOL.
 771  -d | --debug           Enable debug output. It is of type BOOL.
 772  -c | --type            Onap EMS type. It is of type STRING. By default,
 773                         it is .
 774  -s | --long            whether to print all attributes or only short
 775                         attributes. It is of type BOOL.
 776  -D | --context         command context. It is of type MAP. It is
 777                         optional.
 778  -q | --ems-version     Onap EMS version. It is of type STRING. By
 779                         default, it is .
 780  -b | --name            Onap EMS name. It is of type STRING. By default,
 781                         it is .
 782  -i | --username        Onap EMS username. It is of type STRING. By
 783                         default, it is .
 784  -j | --password        Onap EMS password. It is of type STRING. By
 785                         default, it is .
 786  -u | --host-username   Host user name. It is of type STRING. By default,
 787                         it is read from environment variable
 788                         OPEN_CLI_HOST_USERNAME.
 789  -g | --url             Onap EMS URL. It is of type STRING. By default,
 790                         it is .
 791  -x | --remote-path     Onap EMS remote-path. It is of type STRING. By
 792                         default, it is .
 793  -a | --no-auth         whether to authenticate user or not. It is of
 794                         type BOOL.
 795  -z | --ems-id          Onap EMS unique id. It is of type UUID.
 796  -p | --host-password   Host user password. It is of type STRING. By
 797                         default, it is read from environment variable
 798                         OPEN_CLI_HOST_PASSWORD. Secured.
 799
 800
 801 Error::
 802
 803  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
 804
 805
 806
 807 [13] ems-show
 808 -----------------------------------------------
 809
 810
 811 usage: oclip ems-show
 812
 813 Show the details of configured ems
 814
 815 Product: onap-beijing
 816 Service: aai
 817 Author: ONAP CLI Team onap-discuss@lists.onap.org
 818
 819 Options::
 820
 821  [-m | --host-url] [-C | --no-catalog] [-h | --help]
 822  [-f | --format] [-t | --no-title] [-V | --verify]
 823  [-v | --version] [-d | --debug] [-x | --ems-id]
 824  [-s | --long] [-D | --context] [-u | --host-username]
 825  [-a | --no-auth] [-p | --host-password]
 826
 827 where::
 828
 829  -m | --host-url        host url in http(s). It is of type URL. By
 830                         default, it is read from environment variable
 831                         OPEN_CLI_HOST_URL.
 832  -C | --no-catalog      whether to use given host-url directly without
 833                         looking into catalog, it will override the
 834                         service->mode. It is of type BOOL. It is
 835                         optional.
 836  -h | --help            print help message. It is of type BOOL.
 837  -f | --format          Output formats, supported formats such as table,
 838                         csv, json, yaml. It is of type STRING.
 839  -t | --no-title        whether to print title or not. It is of type BOOL.
 840  -V | --verify          verify the command using available command sample
 841                         file and mocking file. By default it goes with
 842                         mock style. To enable the verification in real
 843                         time, set DISABLE_MOCKING=true in the context
 844                         param. It is of type BOOL. It is optional.
 845  -v | --version         print service version. It is of type BOOL.
 846  -d | --debug           Enable debug output. It is of type BOOL.
 847  -x | --ems-id          Onap EMS unique id. It is of type UUID.
 848  -s | --long            whether to print all attributes or only short
 849                         attributes. It is of type BOOL.
 850  -D | --context         command context. It is of type MAP. It is
 851                         optional.
 852  -u | --host-username   Host user name. It is of type STRING. By default,
 853                         it is read from environment variable
 854                         OPEN_CLI_HOST_USERNAME.
 855  -a | --no-auth         whether to authenticate user or not. It is of
 856                         type BOOL.
 857  -p | --host-password   Host user password. It is of type STRING. By
 858                         default, it is read from environment variable
 859                         OPEN_CLI_HOST_PASSWORD. Secured.
 860
 861
 862 Results::
 863
 864  name       Onap ems name and is of type STRING.
 865  type       Onap ems type and is of type STRING.
 866  vendor     Onap ems vendor and is of type STRING.
 867  version    Onap ems version and is of type STRING.
 868  url        Onap ems url and is of type STRING.
 869  username   Onap ems username and is of type STRING.
 870
 871
 872 Error::
 873
 874  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
 875
 876
 877
 878 [14] ems-unregister
 879 -----------------------------------------------
 880
 881
 882 usage: oclip ems-unregister
 883
 884 Un-register a EMS in Onap
 885
 886 Product: onap-beijing
 887 Service: aai
 888 Author: ONAP CLI Team onap-discuss@lists.onap.org
 889
 890 Options::
 891
 892  [-m | --host-url] [-C | --no-catalog] [-h | --help]
 893  [-f | --format] [-t | --no-title] [-V | --verify]
 894  [-v | --version] [-d | --debug] [-y | --resource-version]
 895  [-x | --ems-id] [-s | --long] [-D | --context]
 896  [-u | --host-username] [-a | --no-auth] [-p | --host-password]
 897
 898 where::
 899
 900  -m | --host-url          host url in http(s). It is of type URL. By
 901                           default, it is read from environment variable
 902                           OPEN_CLI_HOST_URL.
 903  -C | --no-catalog        whether to use given host-url directly without
 904                           looking into catalog, it will override the
 905                           service->mode. It is of type BOOL. It is
 906                           optional.
 907  -h | --help              print help message. It is of type BOOL.
 908  -f | --format            Output formats, supported formats such as table,
 909                           csv, json, yaml. It is of type STRING.
 910  -t | --no-title          whether to print title or not. It is of type BOOL.
 911  -V | --verify            verify the command using available command sample
 912                           file and mocking file. By default it goes with
 913                           mock style. To enable the verification in real
 914                           time, set DISABLE_MOCKING=true in the context
 915                           param. It is of type BOOL. It is optional.
 916  -v | --version           print service version. It is of type BOOL.
 917  -d | --debug             Enable debug output. It is of type BOOL.
 918  -y | --resource-version  Onap vim resource version. It is of type STRING.
 919                           It is optional. By default, it is .
 920  -x | --ems-id            Onap EMS unique id. It is of type UUID.
 921  -s | --long              whether to print all attributes or only short
 922                           attributes. It is of type BOOL.
 923  -D | --context           command context. It is of type MAP. It is
 924                           optional.
 925  -u | --host-username     Host user name. It is of type STRING. By default,
 926                           it is read from environment variable
 927                           OPEN_CLI_HOST_USERNAME.
 928  -a | --no-auth           whether to authenticate user or not. It is of
 929                           type BOOL.
 930  -p | --host-password     Host user password. It is of type STRING. By
 931                           default, it is read from environment variable
 932                           OPEN_CLI_HOST_PASSWORD. Secured.
 933
 934
 935 Error::
 936
 937  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
 938
 939
 940
 941 [15] ep-create
 942 -----------------------------------------------
 943
 944
 945 usage: oclip ep-create
 946
 947 Create Entitlement Pool
 948
 949 Product: onap-amsterdam
 950 Service: sdc
 951 Author: ONAP CLI Team onap-discuss@lists.onap.org
 952
 953 Options::
 954
 955  [-m | --host-url] [-C | --no-catalog] [-b | --threshold-unit]
 956  [-h | --help] [-f | --format] [-t | --no-title]
 957  [-V | --verify] [-v | --version] [-d | --debug]
 958  [-x | --ep-name] [-k | --reference-number] [-g | --operational-scope]
 959  [-c | --entitlement-metric] [-z | --ep-description] [-s | --long]
 960  [-D | --context] [-e | --aggregation-function] [-y | --license-model-id]
 961  [-u | --host-username] [-a | --no-auth] [-q | --threshold-value]
 962  [-p | --host-password]
 963
 964 where::
 965
 966  -m | --host-url              host url in http(s). It is of type URL. By
 967                               default, it is read from environment variable
 968                               OPEN_CLI_HOST_URL.
 969  -C | --no-catalog            whether to use given host-url directly without
 970                               looking into catalog, it will override the
 971                               service->mode. It is of type BOOL. It is
 972                               optional.
 973  -b | --threshold-unit        threshold. It is of type STRING. By default, it
 974                               is .
 975  -h | --help                  print help message. It is of type BOOL.
 976  -f | --format                Output formats, supported formats such as table,
 977                               csv, json, yaml. It is of type STRING.
 978  -t | --no-title              whether to print title or not. It is of type BOOL.
 979  -V | --verify                verify the command using available command sample
 980                               file and mocking file. By default it goes with
 981                               mock style. To enable the verification in real
 982                               time, set DISABLE_MOCKING=true in the context
 983                               param. It is of type BOOL. It is optional.
 984  -v | --version               print service version. It is of type BOOL.
 985  -d | --debug                 Enable debug output. It is of type BOOL.
 986  -x | --ep-name               Entitlement Pool name. It is of type STRING. By
 987                               default, it is .
 988  -k | --reference-number      Reference Number. It is of type STRING. By
 989                               default, it is .
 990  -g | --operational-scope     Operational Scope. It is of type STRING. By
 991                               default, it is .
 992  -c | --entitlement-metric    Entitlement Metric. It is of type STRING. By
 993                               default, it is .
 994  -z | --ep-description        Description for Entitlement Pool. It is of type
 995                               STRING. By default, it is .
 996  -s | --long                  whether to print all attributes or only short
 997                               attributes. It is of type BOOL.
 998  -D | --context               command context. It is of type MAP. It is
 999                               optional.
1000  -e | --aggregation-function  Aggregation Function. It is of type STRING. By
1001                               default, it is .
1002  -y | --license-model-id      License Model ID. It is of type STRING. By
1003                               default, it is .
1004  -u | --host-username         Host user name. It is of type STRING. By default,
1005                               it is read from environment variable
1006                               OPEN_CLI_HOST_USERNAME.
1007  -a | --no-auth               whether to authenticate user or not. It is of
1008                               type BOOL.
1009  -q | --threshold-value       threshold. It is of type STRING. By default, it
1010                               is .
1011  -p | --host-password         Host user password. It is of type STRING. By
1012                               default, it is read from environment variable
1013                               OPEN_CLI_HOST_PASSWORD. Secured.
1014
1015
1016 Results::
1017
1018  ID   Entitlement Pool ID and is of type STRING.
1019
1020
1021 Error::
1022
1023  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
1024
1025
1026
1027 [16] ep-show
1028 -----------------------------------------------
1029
1030
1031 usage: oclip ep-show
1032
1033 Details of the Entitlement Pool
1034
1035 Product: onap-amsterdam
1036 Service: sdc
1037 Author: ONAP CLI Team onap-discuss@lists.onap.org
1038
1039 Options::
1040
1041  [-m | --host-url] [-C | --no-catalog] [-h | --help]
1042  [-f | --format] [-t | --no-title] [-V | --verify]
1043  [-v | --version] [-d | --debug] [-s | --long]
1044  [-D | --context] [-x | --license-model-id] [-u | --host-username]
1045  [-a | --no-auth] [-p | --host-password] [-y | --pool-id]
1046
1047 where::
1048
1049  -m | --host-url          host url in http(s). It is of type URL. By
1050                           default, it is read from environment variable
1051                           OPEN_CLI_HOST_URL.
1052  -C | --no-catalog        whether to use given host-url directly without
1053                           looking into catalog, it will override the
1054                           service->mode. It is of type BOOL. It is
1055                           optional.
1056  -h | --help              print help message. It is of type BOOL.
1057  -f | --format            Output formats, supported formats such as table,
1058                           csv, json, yaml. It is of type STRING.
1059  -t | --no-title          whether to print title or not. It is of type BOOL.
1060  -V | --verify            verify the command using available command sample
1061                           file and mocking file. By default it goes with
1062                           mock style. To enable the verification in real
1063                           time, set DISABLE_MOCKING=true in the context
1064                           param. It is of type BOOL. It is optional.
1065  -v | --version           print service version. It is of type BOOL.
1066  -d | --debug             Enable debug output. It is of type BOOL.
1067  -s | --long              whether to print all attributes or only short
1068                           attributes. It is of type BOOL.
1069  -D | --context           command context. It is of type MAP. It is
1070                           optional.
1071  -x | --license-model-id  Onap License Model ID. It is of type STRING. By
1072                           default, it is .
1073  -u | --host-username     Host user name. It is of type STRING. By default,
1074                           it is read from environment variable
1075                           OPEN_CLI_HOST_USERNAME.
1076  -a | --no-auth           whether to authenticate user or not. It is of
1077                           type BOOL.
1078  -p | --host-password     Host user password. It is of type STRING. By
1079                           default, it is read from environment variable
1080                           OPEN_CLI_HOST_PASSWORD. Secured.
1081  -y | --pool-id           Onap Entitlement Pool ID. It is of type STRING.
1082                           By default, it is .
1083
1084
1085 Results::
1086
1087  name         Entitlement Pool Name and is of type STRING.
1088  ID           Entitlement Pool ID and is of type STRING.
1089  description  Description for the Entitlement Pool and is of
1090               type STRING.
1091
1092
1093 Error::
1094
1095  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
1096
1097
1098
1099 [17] generic-search
1100 -----------------------------------------------
1101
1102
1103 usage: oclip generic-search
1104
1105 generic-search
1106
1107 Product: onap-beijing
1108 Service: aai
1109 Author: ONAP CLI Team onap-discuss@lists.onap.org
1110
1111 Options::
1112
1113  [-m | --host-url] [-r | --start-node-type] [-C | --no-catalog]
1114  [-h | --help] [-f | --format] [-t | --no-title]
1115  [-V | --verify] [-v | --version] [-d | --debug]
1116  [-k | --key] [-z | --value] [-s | --long]
1117  [-D | --context] [-e | --depth] [-u | --host-username]
1118  [-a | --no-auth] [-p | --host-password]
1119
1120 where::
1121
1122  -m | --host-url          host url in http(s). It is of type URL. By
1123                           default, it is read from environment variable
1124                           OPEN_CLI_HOST_URL.
1125  -r | --start-node-type   start-node-type. It is of type STRING. By
1126                           default, it is .
1127  -C | --no-catalog        whether to use given host-url directly without
1128                           looking into catalog, it will override the
1129                           service->mode. It is of type BOOL. It is
1130                           optional.
1131  -h | --help              print help message. It is of type BOOL.
1132  -f | --format            Output formats, supported formats such as table,
1133                           csv, json, yaml. It is of type STRING.
1134  -t | --no-title          whether to print title or not. It is of type BOOL.
1135  -V | --verify            verify the command using available command sample
1136                           file and mocking file. By default it goes with
1137                           mock style. To enable the verification in real
1138                           time, set DISABLE_MOCKING=true in the context
1139                           param. It is of type BOOL. It is optional.
1140  -v | --version           print service version. It is of type BOOL.
1141  -d | --debug             Enable debug output. It is of type BOOL.
1142  -k | --key               key. It is of type STRING. By default, it is .
1143  -z | --value             value. It is of type STRING. By default, it is .
1144  -s | --long              whether to print all attributes or only short
1145                           attributes. It is of type BOOL.
1146  -D | --context           command context. It is of type MAP. It is
1147                           optional.
1148  -e | --depth             search depth. It is of type DIGIT. By default, it
1149                           is .
1150  -u | --host-username     Host user name. It is of type STRING. By default,
1151                           it is read from environment variable
1152                           OPEN_CLI_HOST_USERNAME.
1153  -a | --no-auth           whether to authenticate user or not. It is of
1154                           type BOOL.
1155  -p | --host-password     Host user password. It is of type STRING. By
1156                           default, it is read from environment variable
1157                           OPEN_CLI_HOST_PASSWORD. Secured.
1158
1159
1160 Results::
1161
1162  resource-type  Onap result-type and is of type STRING.
1163  resource-link  Onap resource-link and is of type STRING.
1164
1165
1166 Error::
1167
1168  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
1169
1170
1171
1172 [18] license-group-create
1173 -----------------------------------------------
1174
1175
1176 usage: oclip license-group-create
1177
1178 Create License Group
1179
1180 Product: onap-amsterdam
1181 Service: sdc
1182 Author: ONAP CLI Team onap-discuss@lists.onap.org
1183
1184 Options::
1185
1186  [-m | --host-url] [-C | --no-catalog] [-h | --help]
1187  [-f | --format] [-t | --no-title] [-V | --verify]
1188  [-v | --version] [-d | --debug] [-z | --license-group-description]
1189  [-x | --group-name] [-s | --long] [-D | --context]
1190  [-y | --license-model-id] [-u | --host-username] [-a | --no-auth]
1191  [-p | --host-password]
1192
1193 where::
1194
1195  -m | --host-url                    host url in http(s). It is of type URL. By
1196                                     default, it is read from environment variable
1197                                     OPEN_CLI_HOST_URL.
1198  -C | --no-catalog                  whether to use given host-url directly without
1199                                     looking into catalog, it will override the
1200                                     service->mode. It is of type BOOL. It is
1201                                     optional.
1202  -h | --help                        print help message. It is of type BOOL.
1203  -f | --format                      Output formats, supported formats such as table,
1204                                     csv, json, yaml. It is of type STRING.
1205  -t | --no-title                    whether to print title or not. It is of type BOOL.
1206  -V | --verify                      verify the command using available command sample
1207                                     file and mocking file. By default it goes with
1208                                     mock style. To enable the verification in real
1209                                     time, set DISABLE_MOCKING=true in the context
1210                                     param. It is of type BOOL. It is optional.
1211  -v | --version                     print service version. It is of type BOOL.
1212  -d | --debug                       Enable debug output. It is of type BOOL.
1213  -z | --license-group-description   Description for License Group. It is of type
1214                                     STRING. It is optional. By default, it is .
1215  -x | --group-name                  group name. It is of type STRING. By default, it
1216                                     is .
1217  -s | --long                        whether to print all attributes or only short
1218                                     attributes. It is of type BOOL.
1219  -D | --context                     command context. It is of type MAP. It is
1220                                     optional.
1221  -y | --license-model-id            License Model ID. It is of type STRING. By
1222                                     default, it is .
1223  -u | --host-username               Host user name. It is of type STRING. By default,
1224                                     it is read from environment variable
1225                                     OPEN_CLI_HOST_USERNAME.
1226  -a | --no-auth                     whether to authenticate user or not. It is of
1227                                     type BOOL.
1228  -p | --host-password               Host user password. It is of type STRING. By
1229                                     default, it is read from environment variable
1230                                     OPEN_CLI_HOST_PASSWORD. Secured.
1231
1232
1233 Results::
1234
1235  ID   License Group ID and is of type STRING.
1236
1237
1238 Error::
1239
1240  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
1241
1242
1243
1244 [19] license-group-show
1245 -----------------------------------------------
1246
1247
1248 usage: oclip license-group-show
1249
1250 Details of the License Group
1251
1252 Product: onap-amsterdam
1253 Service: sdc
1254 Author: ONAP CLI Team onap-discuss@lists.onap.org
1255
1256 Options::
1257
1258  [-m | --host-url] [-C | --no-catalog] [-h | --help]
1259  [-f | --format] [-t | --no-title] [-V | --verify]
1260  [-v | --version] [-d | --debug] [-s | --long]
1261  [-D | --context] [-x | --license-model-id] [-y | --license-group-id]
1262  [-u | --host-username] [-a | --no-auth] [-p | --host-password]
1263
1264 where::
1265
1266  -m | --host-url          host url in http(s). It is of type URL. By
1267                           default, it is read from environment variable
1268                           OPEN_CLI_HOST_URL.
1269  -C | --no-catalog        whether to use given host-url directly without
1270                           looking into catalog, it will override the
1271                           service->mode. It is of type BOOL. It is
1272                           optional.
1273  -h | --help              print help message. It is of type BOOL.
1274  -f | --format            Output formats, supported formats such as table,
1275                           csv, json, yaml. It is of type STRING.
1276  -t | --no-title          whether to print title or not. It is of type BOOL.
1277  -V | --verify            verify the command using available command sample
1278                           file and mocking file. By default it goes with
1279                           mock style. To enable the verification in real
1280                           time, set DISABLE_MOCKING=true in the context
1281                           param. It is of type BOOL. It is optional.
1282  -v | --version           print service version. It is of type BOOL.
1283  -d | --debug             Enable debug output. It is of type BOOL.
1284  -s | --long              whether to print all attributes or only short
1285                           attributes. It is of type BOOL.
1286  -D | --context           command context. It is of type MAP. It is
1287                           optional.
1288  -x | --license-model-id  Onap License Model ID. It is of type STRING. By
1289                           default, it is .
1290  -y | --license-group-id  Onap License Group ID. It is of type STRING. By
1291                           default, it is .
1292  -u | --host-username     Host user name. It is of type STRING. By default,
1293                           it is read from environment variable
1294                           OPEN_CLI_HOST_USERNAME.
1295  -a | --no-auth           whether to authenticate user or not. It is of
1296                           type BOOL.
1297  -p | --host-password     Host user password. It is of type STRING. By
1298                           default, it is read from environment variable
1299                           OPEN_CLI_HOST_PASSWORD. Secured.
1300
1301
1302 Results::
1303
1304  name         License Group Name and is of type STRING.
1305  ID           License Group ID and is of type STRING.
1306  description  Description for the License Group and is of type
1307               STRING.
1308
1309
1310 Error::
1311
1312  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
1313
1314
1315
1316 [20] license-model-create
1317 -----------------------------------------------
1318
1319
1320 usage: oclip license-model-create
1321
1322 Create License Model
1323
1324 Product: onap-amsterdam
1325 Service: sdc
1326 Author: ONAP CLI Team onap-discuss@lists.onap.org
1327
1328 Options::
1329
1330  [-m | --host-url] [-C | --no-catalog] [-h | --help]
1331  [-f | --format] [-t | --no-title] [-V | --verify]
1332  [-v | --version] [-d | --debug] [-y | --license-model-description]
1333  [-s | --long] [-D | --context] [-x | --vendor-name]
1334  [-u | --host-username] [-a | --no-auth] [-p | --host-password]
1335
1336 where::
1337
1338  -m | --host-url                    host url in http(s). It is of type URL. By
1339                                     default, it is read from environment variable
1340                                     OPEN_CLI_HOST_URL.
1341  -C | --no-catalog                  whether to use given host-url directly without
1342                                     looking into catalog, it will override the
1343                                     service->mode. It is of type BOOL. It is
1344                                     optional.
1345  -h | --help                        print help message. It is of type BOOL.
1346  -f | --format                      Output formats, supported formats such as table,
1347                                     csv, json, yaml. It is of type STRING.
1348  -t | --no-title                    whether to print title or not. It is of type BOOL.
1349  -V | --verify                      verify the command using available command sample
1350                                     file and mocking file. By default it goes with
1351                                     mock style. To enable the verification in real
1352                                     time, set DISABLE_MOCKING=true in the context
1353                                     param. It is of type BOOL. It is optional.
1354  -v | --version                     print service version. It is of type BOOL.
1355  -d | --debug                       Enable debug output. It is of type BOOL.
1356  -y | --license-model-description   Description for License Model. It is of type
1357                                     STRING. It is optional. By default, it is .
1358  -s | --long                        whether to print all attributes or only short
1359                                     attributes. It is of type BOOL.
1360  -D | --context                     command context. It is of type MAP. It is
1361                                     optional.
1362  -x | --vendor-name                 vendor name. It is of type STRING. By default, it
1363                                     is .
1364  -u | --host-username               Host user name. It is of type STRING. By default,
1365                                     it is read from environment variable
1366                                     OPEN_CLI_HOST_USERNAME.
1367  -a | --no-auth                     whether to authenticate user or not. It is of
1368                                     type BOOL.
1369  -p | --host-password               Host user password. It is of type STRING. By
1370                                     default, it is read from environment variable
1371                                     OPEN_CLI_HOST_PASSWORD. Secured.
1372
1373
1374 Results::
1375
1376  ID   License Model ID and is of type STRING.
1377
1378
1379 Error::
1380
1381  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
1382
1383
1384
1385 [21] license-model-show
1386 -----------------------------------------------
1387
1388
1389 usage: oclip license-model-show
1390
1391 Details of the License Model
1392
1393 Product: onap-amsterdam
1394 Service: sdc
1395 Author: ONAP CLI Team onap-discuss@lists.onap.org
1396
1397 Options::
1398
1399  [-m | --host-url] [-C | --no-catalog] [-h | --help]
1400  [-f | --format] [-t | --no-title] [-V | --verify]
1401  [-v | --version] [-d | --debug] [-s | --long]
1402  [-D | --context] [-x | --license-model-id] [-u | --host-username]
1403  [-a | --no-auth] [-p | --host-password]
1404
1405 where::
1406
1407  -m | --host-url          host url in http(s). It is of type URL. By
1408                           default, it is read from environment variable
1409                           OPEN_CLI_HOST_URL.
1410  -C | --no-catalog        whether to use given host-url directly without
1411                           looking into catalog, it will override the
1412                           service->mode. It is of type BOOL. It is
1413                           optional.
1414  -h | --help              print help message. It is of type BOOL.
1415  -f | --format            Output formats, supported formats such as table,
1416                           csv, json, yaml. It is of type STRING.
1417  -t | --no-title          whether to print title or not. It is of type BOOL.
1418  -V | --verify            verify the command using available command sample
1419                           file and mocking file. By default it goes with
1420                           mock style. To enable the verification in real
1421                           time, set DISABLE_MOCKING=true in the context
1422                           param. It is of type BOOL. It is optional.
1423  -v | --version           print service version. It is of type BOOL.
1424  -d | --debug             Enable debug output. It is of type BOOL.
1425  -s | --long              whether to print all attributes or only short
1426                           attributes. It is of type BOOL.
1427  -D | --context           command context. It is of type MAP. It is
1428                           optional.
1429  -x | --license-model-id  Onap License Model ID. It is of type STRING. By
1430                           default, it is .
1431  -u | --host-username     Host user name. It is of type STRING. By default,
1432                           it is read from environment variable
1433                           OPEN_CLI_HOST_USERNAME.
1434  -a | --no-auth           whether to authenticate user or not. It is of
1435                           type BOOL.
1436  -p | --host-password     Host user password. It is of type STRING. By
1437                           default, it is read from environment variable
1438                           OPEN_CLI_HOST_PASSWORD. Secured.
1439
1440
1441 Results::
1442
1443  name         License Model  Name and is of type STRING.
1444  ID           License Model ID and is of type STRING.
1445  description  Description for the License Model and is of type
1446               STRING.
1447  status       Status of the License Model and is of type STRING.
1448
1449
1450 Error::
1451
1452  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
1453
1454
1455
1456 [22] logic-link-create
1457 -----------------------------------------------
1458
1459
1460 usage: oclip logic-link-create
1461
1462 Create a logic-link
1463
1464 Product: onap-beijing
1465 Service: aai
1466 Author: ONAP CLI Team onap-discuss@lists.onap.org
1467
1468 Options::
1469
1470  [-m | --host-url] [-g | --prov-status] [-C | --no-catalog]
1471  [-h | --help] [-f | --format] [-t | --no-title]
1472  [-V | --verify] [-v | --version] [-d | --debug]
1473  [-w | --in-maint] [-s | --long] [-D | --context]
1474  [-n | --name] [-j | --link-role] [-x | --speed-units]
1475  [-u | --host-username] [-r | --relationship] [-a | --no-auth]
1476  [-p | --host-password] [-i | --link-type] [-q | --speed-value]
1477  [-z | --link-id]
1478
1479 where::
1480
1481  -m | --host-url        host url in http(s). It is of type URL. By
1482                         default, it is read from environment variable
1483                         OPEN_CLI_HOST_URL.
1484  -g | --prov-status     Prov Status of this device (not under canopi
1485                         control) Valid values [PREPROV/NVTPROV/PROV]. It
1486                         is of type STRING. It is optional. By default, it
1487                         is .
1488  -C | --no-catalog      whether to use given host-url directly without
1489                         looking into catalog, it will override the
1490                         service->mode. It is of type BOOL. It is
1491                         optional.
1492  -h | --help            print help message. It is of type BOOL.
1493  -f | --format          Output formats, supported formats such as table,
1494                         csv, json, yaml. It is of type STRING.
1495  -t | --no-title        whether to print title or not. It is of type BOOL.
1496  -V | --verify          verify the command using available command sample
1497                         file and mocking file. By default it goes with
1498                         mock style. To enable the verification in real
1499                         time, set DISABLE_MOCKING=true in the context
1500                         param. It is of type BOOL. It is optional.
1501  -v | --version         print service version. It is of type BOOL.
1502  -d | --debug           Enable debug output. It is of type BOOL.
1503  -w | --in-maint        Used to indicate whether or not this object is in
1504                         maintenance mode (maintenance mode = true). It is
1505                         of type BOOL.
1506  -s | --long            whether to print all attributes or only short
1507                         attributes. It is of type BOOL.
1508  -D | --context         command context. It is of type MAP. It is
1509                         optional.
1510  -n | --name            logic-link-name. It is of type STRING. By
1511                         default, it is .
1512  -j | --link-role       link-role. It is of type STRING. It is optional.
1513                         By default, it is .
1514  -x | --speed-units     speed-units. It is of type STRING. It is
1515                         optional. By default, it is .
1516  -u | --host-username   Host user name. It is of type STRING. By default,
1517                         it is read from environment variable
1518                         OPEN_CLI_HOST_USERNAME.
1519  -r | --relationship    relationship. It is of type JSON. It's
1520                         recommended to input the complete path of the
1521                         file, which is having the value for it. It is
1522                         optional.
1523  -a | --no-auth         whether to authenticate user or not. It is of
1524                         type BOOL.
1525  -p | --host-password   Host user password. It is of type STRING. By
1526                         default, it is read from environment variable
1527                         OPEN_CLI_HOST_PASSWORD. Secured.
1528  -i | --link-type       link-type. It is of type STRING. It is optional.
1529                         By default, it is .
1530  -q | --speed-value     speed-value. It is of type STRING. It is
1531                         optional. By default, it is .
1532  -z | --link-id         link-id. It is of type STRING. It is optional. By
1533                         default, it is .
1534
1535
1536 Error::
1537
1538  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
1539
1540
1541
1542 [23] logic-link-delete
1543 -----------------------------------------------
1544
1545
1546 usage: oclip logic-link-delete
1547
1548 Delete logic-link-delete from Onap
1549
1550 Product: onap-beijing
1551 Service: aai
1552 Author: ONAP CLI Team onap-discuss@lists.onap.org
1553
1554 Options::
1555
1556  [-m | --host-url] [-C | --no-catalog] [-h | --help]
1557  [-f | --format] [-t | --no-title] [-V | --verify]
1558  [-v | --version] [-d | --debug] [-n | --logic-link-name]
1559  [-s | --long] [-D | --context] [-u | --host-username]
1560  [-a | --no-auth] [-p | --host-password] [-b | --resource-version]
1561
1562 where::
1563
1564  -m | --host-url          host url in http(s). It is of type URL. By
1565                           default, it is read from environment variable
1566                           OPEN_CLI_HOST_URL.
1567  -C | --no-catalog        whether to use given host-url directly without
1568                           looking into catalog, it will override the
1569                           service->mode. It is of type BOOL. It is
1570                           optional.
1571  -h | --help              print help message. It is of type BOOL.
1572  -f | --format            Output formats, supported formats such as table,
1573                           csv, json, yaml. It is of type STRING.
1574  -t | --no-title          whether to print title or not. It is of type BOOL.
1575  -V | --verify            verify the command using available command sample
1576                           file and mocking file. By default it goes with
1577                           mock style. To enable the verification in real
1578                           time, set DISABLE_MOCKING=true in the context
1579                           param. It is of type BOOL. It is optional.
1580  -v | --version           print service version. It is of type BOOL.
1581  -d | --debug             Enable debug output. It is of type BOOL.
1582  -n | --logic-link-name   Onap logic-link name. It is of type STRING. By
1583                           default, it is .
1584  -s | --long              whether to print all attributes or only short
1585                           attributes. It is of type BOOL.
1586  -D | --context           command context. It is of type MAP. It is
1587                           optional.
1588  -u | --host-username     Host user name. It is of type STRING. By default,
1589                           it is read from environment variable
1590                           OPEN_CLI_HOST_USERNAME.
1591  -a | --no-auth           whether to authenticate user or not. It is of
1592                           type BOOL.
1593  -p | --host-password     Host user password. It is of type STRING. By
1594                           default, it is read from environment variable
1595                           OPEN_CLI_HOST_PASSWORD. Secured.
1596  -b | --resource-version  Onap logic-link-name resource version. It is of
1597                           type UUID.
1598
1599
1600 Error::
1601
1602  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
1603
1604
1605
1606 [24] logic-link-list
1607 -----------------------------------------------
1608
1609
1610 usage: oclip logic-link-list
1611
1612 show detail for one single logic-link
1613
1614 Product: onap-beijing
1615 Service: aai
1616 Author: ONAP CLI Team onap-discuss@lists.onap.org
1617
1618 Options::
1619
1620  [-m | --host-url] [-C | --no-catalog] [-h | --help]
1621  [-f | --format] [-t | --no-title] [-V | --verify]
1622  [-v | --version] [-d | --debug] [-n | --name]
1623  [-s | --long] [-D | --context] [-u | --host-username]
1624  [-a | --no-auth] [-p | --host-password]
1625
1626 where::
1627
1628  -m | --host-url        host url in http(s). It is of type URL. By
1629                         default, it is read from environment variable
1630                         OPEN_CLI_HOST_URL.
1631  -C | --no-catalog      whether to use given host-url directly without
1632                         looking into catalog, it will override the
1633                         service->mode. It is of type BOOL. It is
1634                         optional.
1635  -h | --help            print help message. It is of type BOOL.
1636  -f | --format          Output formats, supported formats such as table,
1637                         csv, json, yaml. It is of type STRING.
1638  -t | --no-title        whether to print title or not. It is of type BOOL.
1639  -V | --verify          verify the command using available command sample
1640                         file and mocking file. By default it goes with
1641                         mock style. To enable the verification in real
1642                         time, set DISABLE_MOCKING=true in the context
1643                         param. It is of type BOOL. It is optional.
1644  -v | --version         print service version. It is of type BOOL.
1645  -d | --debug           Enable debug output. It is of type BOOL.
1646  -n | --name            logic-link-name. It is of type STRING. By
1647                         default, it is .
1648  -s | --long            whether to print all attributes or only short
1649                         attributes. It is of type BOOL.
1650  -D | --context         command context. It is of type MAP. It is
1651                         optional.
1652  -u | --host-username   Host user name. It is of type STRING. By default,
1653                         it is read from environment variable
1654                         OPEN_CLI_HOST_USERNAME.
1655  -a | --no-auth         whether to authenticate user or not. It is of
1656                         type BOOL.
1657  -p | --host-password   Host user password. It is of type STRING. By
1658                         default, it is read from environment variable
1659                         OPEN_CLI_HOST_PASSWORD. Secured.
1660
1661
1662 Results::
1663
1664  logic-link-name    Onap logic-link name and is of type STRING.
1665  logic-link-id      Onap logic-link id and is of type STRING.
1666  in-maint           Onap in-maint and is of type STRING.
1667  speed-value        Onap speed-value and is of type STRING.
1668  speed-units        Onap speed-units and is of type STRING.
1669  prov-status        Onap prov-status and is of type STRING.
1670  link-role          Onap link-role and is of type STRING.
1671  resource-version   Onap resource-version and is of type STRING.
1672
1673
1674 Error::
1675
1676  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
1677
1678
1679
1680 [25] logic-link-list
1681 -----------------------------------------------
1682
1683
1684 usage: oclip logic-link-list
1685
1686 show detail for one single logic-link
1687
1688 Product: onap-beijing
1689 Service: aai
1690 Author: ONAP CLI Team onap-discuss@lists.onap.org
1691
1692 Options::
1693
1694  [-m | --host-url] [-C | --no-catalog] [-h | --help]
1695  [-f | --format] [-t | --no-title] [-V | --verify]
1696  [-v | --version] [-d | --debug] [-n | --name]
1697  [-s | --long] [-D | --context] [-u | --host-username]
1698  [-a | --no-auth] [-p | --host-password]
1699
1700 where::
1701
1702  -m | --host-url        host url in http(s). It is of type URL. By
1703                         default, it is read from environment variable
1704                         OPEN_CLI_HOST_URL.
1705  -C | --no-catalog      whether to use given host-url directly without
1706                         looking into catalog, it will override the
1707                         service->mode. It is of type BOOL. It is
1708                         optional.
1709  -h | --help            print help message. It is of type BOOL.
1710  -f | --format          Output formats, supported formats such as table,
1711                         csv, json, yaml. It is of type STRING.
1712  -t | --no-title        whether to print title or not. It is of type BOOL.
1713  -V | --verify          verify the command using available command sample
1714                         file and mocking file. By default it goes with
1715                         mock style. To enable the verification in real
1716                         time, set DISABLE_MOCKING=true in the context
1717                         param. It is of type BOOL. It is optional.
1718  -v | --version         print service version. It is of type BOOL.
1719  -d | --debug           Enable debug output. It is of type BOOL.
1720  -n | --name            logic-link-name. It is of type STRING. By
1721                         default, it is .
1722  -s | --long            whether to print all attributes or only short
1723                         attributes. It is of type BOOL.
1724  -D | --context         command context. It is of type MAP. It is
1725                         optional.
1726  -u | --host-username   Host user name. It is of type STRING. By default,
1727                         it is read from environment variable
1728                         OPEN_CLI_HOST_USERNAME.
1729  -a | --no-auth         whether to authenticate user or not. It is of
1730                         type BOOL.
1731  -p | --host-password   Host user password. It is of type STRING. By
1732                         default, it is read from environment variable
1733                         OPEN_CLI_HOST_PASSWORD. Secured.
1734
1735
1736 Results::
1737
1738  logic-link-name    Onap logic-link name and is of type STRING.
1739  logic-link-id      Onap logic-link id and is of type STRING.
1740  in-maint           Onap in-maint and is of type STRING.
1741  speed-value        Onap speed-value and is of type STRING.
1742  speed-units        Onap speed-units and is of type STRING.
1743  prov-status        Onap prov-status and is of type STRING.
1744  link-role          Onap link-role and is of type STRING.
1745  resource-version   Onap resource-version and is of type STRING.
1746
1747
1748 Error::
1749
1750  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
1751
1752 tenant-create
1753 ----------------------------------------------------
1754
1755 usage: oclip tenant-create
1756
1757 Create a tenant under given cloud region in Onap
1758
1759 Product: onap-beijing
1760 Service: aai
1761 Author: ONAP CLI Team onap-discuss@lists.onap.org
1762
1763 Options::
1764
1765  [-m | --host-url] [-C | --no-catalog] [-h | --help]
1766  [-f | --format] [-t | --no-title] [-V | --verify]
1767  [-v | --version] [-d | --debug] [-x | --cloud]
1768  [-z | --tenant-id] [-y | --region] [-s | --long]
1769  [-D | --context] [-r | --tenant-name] [-u | --host-username]
1770  [-a | --no-auth] [-p | --host-password]
1771
1772 where::
1773
1774  -m | --host-url        host url in http(s). It is of type URL. By
1775                         default, it is read from environment variable
1776                         OPEN_CLI_HOST_URL.
1777  -C | --no-catalog      Whether to use given host-url directly or
1778                         discover it from catalog, it will override the
1779                         service->mode. It is of type BOOL. It is
1780                         optional.
1781  -h | --help            print help message. It is of type BOOL.
1782  -f | --format          Output formats, supported formats such as table,
1783                         csv, json, yaml. It is of type STRING.
1784  -t | --no-title        whether to print title or not. It is of type BOOL.
1785  -V | --verify          Helps to verify the command using samples
1786                         provides under open-cli-samples directory. By
1787                         default, it goes with mock.To enable the
1788                         verification of samples in real time, set
1789                         DISABLE_MOCKING=true in the context parameter. It
1790                         is of type BOOL. It is optional.
1791  -v | --version         print service version. It is of type BOOL.
1792  -d | --debug           Enable debug output. It is of type BOOL.
1793  -x | --cloud           Onap cloud. It is of type STRING. By default, it
1794                         is .
1795  -z | --tenant-id       Onap cloud tenant id. It is of type STRING. By
1796                         default, it is .
1797  -y | --region          Onap cloud region. It is of type STRING. By
1798                         default, it is .
1799  -s | --long            whether to print all attributes or only short
1800                         attributes. It is of type BOOL.
1801  -D | --context         command context. It is of type MAP. It is
1802                         optional.
1803  -r | --tenant-name     Onap cloud tenant name. It is of type STRING. By
1804                         default, it is .
1805  -u | --host-username   Host user name. It is of type STRING. By default,
1806                         it is read from environment variable
1807                         OPEN_CLI_HOST_USERNAME.
1808  -a | --no-auth         Whether to authenticate user or not. It is of
1809                         type BOOL.
1810  -p | --host-password   Host user password. It is of type STRING. By
1811                         default, it is read from environment variable
1812                         OPEN_CLI_HOST_PASSWORD. Secured.
1813
1814
1815 Error::
1816
1817  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
1818
1819
1820 vf-create
1821 ----------------------------------------------------
1822
1823 usage: oclip vf-create
1824
1825 Create a VF
1826
1827 Product: onap-beijing
1828 Service: so
1829 Author: ONAP CLI Team onap-discuss@lists.onap.org
1830
1831 Options::
1832
1833  [-j | --service-model-invariant-id] [-k | --service-model-uuid] [-q | --service-model-name]
1834  [-h | --help] [-f | --format] [-t | --no-title]
1835  [-V | --verify] [-v | --version] [-l | --cloud-region]
1836  [-y | --service-instance-id] [-z | --tenant-id] [-c | --vf-model-uuid]
1837  [-o | --instance-name] [-s | --long] [-e | --vf-model-name]
1838  [-g | --vf-model-version] [-b | --vf-model-invariant-id] [-a | --no-auth]
1839  [-n | --service-model-version] [-p | --host-password] [-m | --host-url]
1840  [-C | --no-catalog] [-i | --vf-model-customization-id] [-d | --debug]
1841  [-D | --context] [-w | --product-family] [-u | --host-username]
1842
1843 where::
1844
1845  -j | --service-model-invariant-id  model invariant id. It is of type STRING. By
1846                                     default, it is .
1847  -k | --service-model-uuid          model name version id. It is of type STRING. By
1848                                     default, it is .
1849  -q | --service-model-name          service model name. It is of type STRING. By
1850                                     default, it is .
1851  -h | --help                        print help message. It is of type BOOL.
1852  -f | --format                      Output formats, supported formats such as table,
1853                                     csv, json, yaml. It is of type STRING.
1854  -t | --no-title                    whether to print title or not. It is of type BOOL.
1855  -V | --verify                      Helps to verify the command using samples
1856                                     provides under open-cli-samples directory. By
1857                                     default, it goes with mock.To enable the
1858                                     verification of samples in real time, set
1859                                     DISABLE_MOCKING=true in the context parameter. It
1860                                     is of type BOOL. It is optional.
1861  -v | --version                     print service version. It is of type BOOL.
1862  -l | --cloud-region                cloud region identifier. It is of type STRING. By
1863                                     default, it is .
1864  -y | --service-instance-id         unique id for service instance. It is of type
1865                                     STRING. By default, it is .
1866  -z | --tenant-id                   openstack tenant id. It is of type STRING. By
1867                                     default, it is .
1868  -c | --vf-model-uuid               model uuid for vf. It is of type STRING. By
1869                                     default, it is .
1870  -o | --instance-name               service instance name. It is of type STRING. By
1871                                     default, it is .
1872  -s | --long                        whether to print all attributes or only short
1873                                     attributes. It is of type BOOL.
1874  -e | --vf-model-name               vf model name. It is of type STRING. By default,
1875                                     it is .
1876  -g | --vf-model-version            vf model version. It is of type STRING. By
1877                                     default, it is .
1878  -b | --vf-model-invariant-id       vf model invariant id. It is of type STRING. By
1879                                     default, it is .
1880  -a | --no-auth                     Whether to authenticate user or not. It is of
1881                                     type BOOL.
1882  -n | --service-model-version       service model version. It is of type STRING. By
1883                                     default, it is .
1884  -p | --host-password               Host user password. It is of type STRING. By
1885                                     default, it is read from environment variable
1886                                     OPEN_CLI_HOST_PASSWORD. Secured.
1887  -m | --host-url                    host url in http(s). It is of type URL. By
1888                                     default, it is read from environment variable
1889                                     OPEN_CLI_HOST_URL.
1890  -C | --no-catalog                  Whether to use given host-url directly or
1891                                     discover it from catalog, it will override the
1892                                     service->mode. It is of type BOOL. It is
1893                                     optional.
1894  -i | --vf-model-customization-id   vf model customization id. It is of type STRING.
1895                                     By default, it is .
1896  -d | --debug                       Enable debug output. It is of type BOOL.
1897  -D | --context                     command context. It is of type MAP. It is
1898                                     optional.
1899  -w | --product-family              service type for serivce (e.g. vLB). It is of
1900                                     type STRING. By default, it is .
1901  -u | --host-username               Host user name. It is of type STRING. By default,
1902                                     it is read from environment variable
1903                                     OPEN_CLI_HOST_USERNAME.
1904
1905
1906 Results::
1907
1908  vf-id  id for the created vnf and is of type STRING.
1909
1910
1911 Error::
1912
1913  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
1914
1915
1916 vf-list
1917 ----------------------------------------------------
1918
1919 usage: oclip vf-list
1920
1921 List created VF instances for a service instance
1922
1923 Product: onap-beijing
1924 Service: aai
1925 Author: ONAP CLI Team onap-discuss@lists.onap.org
1926
1927 Options::
1928
1929  [-m | --host-url] [-C | --no-catalog] [-h | --help]
1930  [-f | --format] [-t | --no-title] [-V | --verify]
1931  [-v | --version] [-d | --debug] [-x | --customer-name]
1932  [-y | --service-type] [-s | --long] [-D | --context]
1933  [-z | --service-id] [-u | --host-username] [-a | --no-auth]
1934  [-p | --host-password]
1935
1936 where::
1937
1938  -m | --host-url        host url in http(s). It is of type URL. By
1939                         default, it is read from environment variable
1940                         OPEN_CLI_HOST_URL.
1941  -C | --no-catalog      Whether to use given host-url directly or
1942                         discover it from catalog, it will override the
1943                         service->mode. It is of type BOOL. It is
1944                         optional.
1945  -h | --help            print help message. It is of type BOOL.
1946  -f | --format          Output formats, supported formats such as table,
1947                         csv, json, yaml. It is of type STRING.
1948  -t | --no-title        whether to print title or not. It is of type BOOL.
1949  -V | --verify          Helps to verify the command using samples
1950                         provides under open-cli-samples directory. By
1951                         default, it goes with mock.To enable the
1952                         verification of samples in real time, set
1953                         DISABLE_MOCKING=true in the context parameter. It
1954                         is of type BOOL. It is optional.
1955  -v | --version         print service version. It is of type BOOL.
1956  -d | --debug           Enable debug output. It is of type BOOL.
1957  -x | --customer-name   customer name. It is of type STRING. By default,
1958                         it is .
1959  -y | --service-type    service subscription type. It is of type STRING.
1960                         By default, it is .
1961  -s | --long            whether to print all attributes or only short
1962                         attributes. It is of type BOOL.
1963  -D | --context         command context. It is of type MAP. It is
1964                         optional.
1965  -z | --service-id      service ID. It is of type STRING. By default, it
1966                         is .
1967  -u | --host-username   Host user name. It is of type STRING. By default,
1968                         it is read from environment variable
1969                         OPEN_CLI_HOST_USERNAME.
1970  -a | --no-auth         Whether to authenticate user or not. It is of
1971                         type BOOL.
1972  -p | --host-password   Host user password. It is of type STRING. By
1973                         default, it is read from environment variable
1974                         OPEN_CLI_HOST_PASSWORD. Secured.
1975
1976
1977 Results::
1978
1979  vf-id    VF ID for the given service and is of type STRING.
1980  vf-name  VF name and is of type STRING.
1981
1982
1983 Error::
1984
1985  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
1986
1987
1988 vf-model-create
1989 ----------------------------------------------------
1990
1991 usage: oclip vf-model-create
1992
1993 Create Virtual function from Vendor Software Product
1994
1995 Product: onap-beijing
1996 Service: sdc
1997 Author: ONAP CLI Team onap-discuss@lists.onap.org
1998
1999 Options::
2000
2001  [-m | --host-url] [-C | --no-catalog] [-h | --help]
2002  [-f | --format] [-t | --no-title] [-V | --verify]
2003  [-v | --version] [-d | --debug] [-y | --description]
2004  [-g | --vsp-version] [-x | --name] [-s | --long]
2005  [-D | --context] [-z | --vendor-name] [-u | --host-username]
2006  [-a | --no-auth] [-p | --host-password] [-b | --vsp-id]
2007
2008 where::
2009
2010  -m | --host-url        host url in http(s). It is of type URL. By
2011                         default, it is read from environment variable
2012                         OPEN_CLI_HOST_URL.
2013  -C | --no-catalog      Whether to use given host-url directly or
2014                         discover it from catalog, it will override the
2015                         service->mode. It is of type BOOL. It is
2016                         optional.
2017  -h | --help            print help message. It is of type BOOL.
2018  -f | --format          Output formats, supported formats such as table,
2019                         csv, json, yaml. It is of type STRING.
2020  -t | --no-title        whether to print title or not. It is of type BOOL.
2021  -V | --verify          Helps to verify the command using samples
2022                         provides under open-cli-samples directory. By
2023                         default, it goes with mock.To enable the
2024                         verification of samples in real time, set
2025                         DISABLE_MOCKING=true in the context parameter. It
2026                         is of type BOOL. It is optional.
2027  -v | --version         print service version. It is of type BOOL.
2028  -d | --debug           Enable debug output. It is of type BOOL.
2029  -y | --description     Description for VF. It is of type STRING. It is
2030                         optional. By default, it is .
2031  -g | --vsp-version     VSP version. It is of type STRING. It is
2032                         optional. By default, it is .
2033  -x | --name            Onap VF Name. It is of type STRING. By default,
2034                         it is .
2035  -s | --long            whether to print all attributes or only short
2036                         attributes. It is of type BOOL.
2037  -D | --context         command context. It is of type MAP. It is
2038                         optional.
2039  -z | --vendor-name     Vendor name. It is of type STRING. It is
2040                         optional. By default, it is .
2041  -u | --host-username   Host user name. It is of type STRING. By default,
2042                         it is read from environment variable
2043                         OPEN_CLI_HOST_USERNAME.
2044  -a | --no-auth         Whether to authenticate user or not. It is of
2045                         type BOOL.
2046  -p | --host-password   Host user password. It is of type STRING. By
2047                         default, it is read from environment variable
2048                         OPEN_CLI_HOST_PASSWORD. Secured.
2049  -b | --vsp-id          VSP ID. It is of type STRING. It is optional. By
2050                         default, it is .
2051
2052
2053 Results::
2054
2055  ID   VF ID and is of type STRING.
2056
2057
2058 Error::
2059
2060  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
2061
2062
2063 vfmodule-create
2064 ----------------------------------------------------
2065
2066 usage: oclip vfmodule-create
2067
2068 Create a VF module
2069
2070 Product: onap-beijing
2071 Service: so
2072 Author: ONAP CLI Team onap-discuss@lists.onap.org
2073
2074 Options::
2075
2076  [-h | --help] [-f | --format] [-t | --no-title]
2077  [-V | --verify] [-v | --version] [-l | --cloud-region]
2078  [-x | --service-model-name] [-j | --service-id] [-z | --service-model-version]
2079  [-i | --module-name] [-o | --vf-model-version] [-k | --vf-model-invariant-id]
2080  [-s | --long] [-g | --vfmodule-version] [-r | --service-model-invariant-id]
2081  [-n | --vf-model-name] [-a | --no-auth] [-w | --service-model-uuid]
2082  [-p | --host-password] [-m | --host-url] [-C | --no-catalog]
2083  [-d | --debug] [-b | --vfmodule-invariant-id] [-c | --vfmodule-uuid]
2084  [-A | --vf-model-uuid] [-y | --vf-id] [-D | --context]
2085  [-B | --tenant-id] [-e | --vfmodule-name] [-q | --vf-model-customization-id]
2086  [-u | --host-username]
2087
2088 where::
2089
2090  -h | --help                        print help message. It is of type BOOL.
2091  -f | --format                      Output formats, supported formats such as table,
2092                                     csv, json, yaml. It is of type STRING.
2093  -t | --no-title                    whether to print title or not. It is of type BOOL.
2094  -V | --verify                      Helps to verify the command using samples
2095                                     provides under open-cli-samples directory. By
2096                                     default, it goes with mock.To enable the
2097                                     verification of samples in real time, set
2098                                     DISABLE_MOCKING=true in the context parameter. It
2099                                     is of type BOOL. It is optional.
2100  -v | --version                     print service version. It is of type BOOL.
2101  -l | --cloud-region                cloud region identifier. It is of type STRING. By
2102                                     default, it is .
2103  -x | --service-model-name          service model name. It is of type STRING. By
2104                                     default, it is .
2105  -j | --service-id                  unique id for service. It is of type STRING. By
2106                                     default, it is .
2107  -z | --service-model-version       service model version. It is of type STRING. By
2108                                     default, it is .
2109  -i | --module-name                 vfmodule name. It is of type STRING. By default,
2110                                     it is .
2111  -o | --vf-model-version            vf model version. It is of type STRING. By
2112                                     default, it is .
2113  -k | --vf-model-invariant-id       vf model invariant id. It is of type STRING. By
2114                                     default, it is .
2115  -s | --long                        whether to print all attributes or only short
2116                                     attributes. It is of type BOOL.
2117  -g | --vfmodule-version            vf module version. It is of type STRING. By
2118                                     default, it is .
2119  -r | --service-model-invariant-id  model invariant id. It is of type STRING. By
2120                                     default, it is .
2121  -n | --vf-model-name               vf model name. It is of type STRING. By default,
2122                                     it is .
2123  -a | --no-auth                     Whether to authenticate user or not. It is of
2124                                     type BOOL.
2125  -w | --service-model-uuid          model name version id. It is of type STRING. By
2126                                     default, it is .
2127  -p | --host-password               Host user password. It is of type STRING. By
2128                                     default, it is read from environment variable
2129                                     OPEN_CLI_HOST_PASSWORD. Secured.
2130  -m | --host-url                    host url in http(s). It is of type URL. By
2131                                     default, it is read from environment variable
2132                                     OPEN_CLI_HOST_URL.
2133  -C | --no-catalog                  Whether to use given host-url directly or
2134                                     discover it from catalog, it will override the
2135                                     service->mode. It is of type BOOL. It is
2136                                     optional.
2137  -d | --debug                       Enable debug output. It is of type BOOL.
2138  -b | --vfmodule-invariant-id       vfmodule model invariant id. It is of type
2139                                     STRING. By default, it is .
2140  -c | --vfmodule-uuid               model uuid for vfmodule. It is of type STRING. By
2141                                     default, it is .
2142  -A | --vf-model-uuid               model uuid for vf. It is of type STRING. By
2143                                     default, it is .
2144  -y | --vf-id                       unique id for related VF. It is of type STRING.
2145                                     By default, it is .
2146  -D | --context                     command context. It is of type MAP. It is
2147                                     optional.
2148  -B | --tenant-id                   openstack tenant id. It is of type STRING. By
2149                                     default, it is .
2150  -e | --vfmodule-name               vfmodule model name. It is of type STRING. By
2151                                     default, it is .
2152  -q | --vf-model-customization-id   vf model customization id. This can be obtained
2153                                     using SDC portal (Home -> service:xxx ->
2154                                     Composition -> click on VF for customization id).
2155                                     It is of type STRING. By default, it is .
2156  -u | --host-username               Host user name. It is of type STRING. By default,
2157                                     it is read from environment variable
2158                                     OPEN_CLI_HOST_USERNAME.
2159
2160
2161 Results::
2162
2163  vfmodule-id  id for the created vnf and is of type STRING.
2164
2165
2166 Error::
2167
2168  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
2169
2170
2171 vlm-aggreement-create
2172 ----------------------------------------------------
2173
2174 usage: oclip vlm-aggreement-create
2175
2176 Create license aggreement
2177
2178 Product: onap-beijing
2179 Service: sdc
2180 Author: ONAP CLI Team onap-discuss@lists.onap.org
2181
2182 Options::
2183
2184  [-m | --host-url] [-y | --vlm-id] [-C | --no-catalog]
2185  [-h | --help] [-f | --format] [-t | --no-title]
2186  [-V | --verify] [-v | --version] [-d | --debug]
2187  [-z | --description] [-x | --name] [-g | --vlm-feature-group-id]
2188  [-s | --long] [-D | --context] [-u | --host-username]
2189  [-a | --no-auth] [-e | --vlm-version] [-p | --host-password]
2190
2191 where::
2192
2193  -m | --host-url              host url in http(s). It is of type URL. By
2194                               default, it is read from environment variable
2195                               OPEN_CLI_HOST_URL.
2196  -y | --vlm-id                License Model ID. It is of type STRING. By
2197                               default, it is .
2198  -C | --no-catalog            Whether to use given host-url directly or
2199                               discover it from catalog, it will override the
2200                               service->mode. It is of type BOOL. It is
2201                               optional.
2202  -h | --help                  print help message. It is of type BOOL.
2203  -f | --format                Output formats, supported formats such as table,
2204                               csv, json, yaml. It is of type STRING.
2205  -t | --no-title              whether to print title or not. It is of type BOOL.
2206  -V | --verify                Helps to verify the command using samples
2207                               provides under open-cli-samples directory. By
2208                               default, it goes with mock.To enable the
2209                               verification of samples in real time, set
2210                               DISABLE_MOCKING=true in the context parameter. It
2211                               is of type BOOL. It is optional.
2212  -v | --version               print service version. It is of type BOOL.
2213  -d | --debug                 Enable debug output. It is of type BOOL.
2214  -z | --description           Description for aggreement. It is of type STRING.
2215                               By default, it is .
2216  -x | --name                  aggreement name. It is of type STRING. By
2217                               default, it is .
2218  -g | --vlm-feature-group-id  VLM feature group. It is of type STRING. By
2219                               default, it is .
2220  -s | --long                  whether to print all attributes or only short
2221                               attributes. It is of type BOOL.
2222  -D | --context               command context. It is of type MAP. It is
2223                               optional.
2224  -u | --host-username         Host user name. It is of type STRING. By default,
2225                               it is read from environment variable
2226                               OPEN_CLI_HOST_USERNAME.
2227  -a | --no-auth               Whether to authenticate user or not. It is of
2228                               type BOOL.
2229  -e | --vlm-version           License Model version. It is of type STRING. By
2230                               default, it is .
2231  -p | --host-password         Host user password. It is of type STRING. By
2232                               default, it is read from environment variable
2233                               OPEN_CLI_HOST_PASSWORD. Secured.
2234
2235
2236 Results::
2237
2238  ID   aggreement ID and is of type STRING.
2239
2240
2241 Error::
2242
2243  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
2244
2245
2246 vlm-entitlement-pool-create
2247 ----------------------------------------------------
2248
2249 usage: oclip vlm-entitlement-pool-create
2250
2251 Create Entitlement Pool
2252
2253 Product: onap-beijing
2254 Service: sdc
2255 Author: ONAP CLI Team onap-discuss@lists.onap.org
2256
2257 Options::
2258
2259  [-m | --host-url] [-y | --vlm-id] [-C | --no-catalog]
2260  [-h | --help] [-f | --format] [-t | --no-title]
2261  [-V | --verify] [-v | --version] [-d | --debug]
2262  [-z | --description] [-k | --manufacture-reference-number] [-x | --name]
2263  [-g | --operational-scope] [-s | --long] [-D | --context]
2264  [-u | --host-username] [-a | --no-auth] [-e | --vlm-version]
2265  [-p | --host-password]
2266
2267 where::
2268
2269  -m | --host-url                      host url in http(s). It is of type URL. By
2270                                       default, it is read from environment variable
2271                                       OPEN_CLI_HOST_URL.
2272  -y | --vlm-id                        License Model ID. It is of type STRING. By
2273                                       default, it is .
2274  -C | --no-catalog                    Whether to use given host-url directly or
2275                                       discover it from catalog, it will override the
2276                                       service->mode. It is of type BOOL. It is
2277                                       optional.
2278  -h | --help                          print help message. It is of type BOOL.
2279  -f | --format                        Output formats, supported formats such as table,
2280                                       csv, json, yaml. It is of type STRING.
2281  -t | --no-title                      whether to print title or not. It is of type BOOL.
2282  -V | --verify                        Helps to verify the command using samples
2283                                       provides under open-cli-samples directory. By
2284                                       default, it goes with mock.To enable the
2285                                       verification of samples in real time, set
2286                                       DISABLE_MOCKING=true in the context parameter. It
2287                                       is of type BOOL. It is optional.
2288  -v | --version                       print service version. It is of type BOOL.
2289  -d | --debug                         Enable debug output. It is of type BOOL.
2290  -z | --description                   Description for Entitlement Pool. It is of type
2291                                       STRING. By default, it is .
2292  -k | --manufacture-reference-number  Manufature Reference Number. It is of type
2293                                       STRING. By default, it is .
2294  -x | --name                          Entitlement Pool name. It is of type STRING. By
2295                                       default, it is .
2296  -g | --operational-scope             Operational Scope. It is of type STRING.
2297  -s | --long                          whether to print all attributes or only short
2298                                       attributes. It is of type BOOL.
2299  -D | --context                       command context. It is of type MAP. It is
2300                                       optional.
2301  -u | --host-username                 Host user name. It is of type STRING. By default,
2302                                       it is read from environment variable
2303                                       OPEN_CLI_HOST_USERNAME.
2304  -a | --no-auth                       Whether to authenticate user or not. It is of
2305                                       type BOOL.
2306  -e | --vlm-version                   License Model version. It is of type STRING. By
2307                                       default, it is .
2308  -p | --host-password                 Host user password. It is of type STRING. By
2309                                       default, it is read from environment variable
2310                                       OPEN_CLI_HOST_PASSWORD. Secured.
2311
2312
2313 Results::
2314
2315  ID   Entitlement Pool ID and is of type STRING.
2316
2317
2318 Error::
2319
2320  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
2321
2322
2323 vlm-key-group-list
2324 ----------------------------------------------------
2325
2326 usage: oclip vlm-key-group-list
2327
2328 key group list in a license model
2329
2330 Product: onap-beijing
2331 Service: sdc
2332 Author: ONAP CLI Team onap-discuss@lists.onap.org
2333
2334 Options::
2335
2336  [-m | --host-url] [-C | --no-catalog] [-y | --vlm-version]
2337  [-h | --help] [-f | --format] [-t | --no-title]
2338  [-V | --verify] [-v | --version] [-d | --debug]
2339  [-x | --vlm-id] [-s | --long] [-D | --context]
2340  [-u | --host-username] [-a | --no-auth] [-p | --host-password]
2341
2342 where::
2343
2344  -m | --host-url        host url in http(s). It is of type URL. By
2345                         default, it is read from environment variable
2346                         OPEN_CLI_HOST_URL.
2347  -C | --no-catalog      Whether to use given host-url directly or
2348                         discover it from catalog, it will override the
2349                         service->mode. It is of type BOOL. It is
2350                         optional.
2351  -y | --vlm-version     License Model version. It is of type STRING. By
2352                         default, it is .
2353  -h | --help            print help message. It is of type BOOL.
2354  -f | --format          Output formats, supported formats such as table,
2355                         csv, json, yaml. It is of type STRING.
2356  -t | --no-title        whether to print title or not. It is of type BOOL.
2357  -V | --verify          Helps to verify the command using samples
2358                         provides under open-cli-samples directory. By
2359                         default, it goes with mock.To enable the
2360                         verification of samples in real time, set
2361                         DISABLE_MOCKING=true in the context parameter. It
2362                         is of type BOOL. It is optional.
2363  -v | --version         print service version. It is of type BOOL.
2364  -d | --debug           Enable debug output. It is of type BOOL.
2365  -x | --vlm-id          License Model ID. It is of type STRING. By
2366                         default, it is .
2367  -s | --long            whether to print all attributes or only short
2368                         attributes. It is of type BOOL.
2369  -D | --context         command context. It is of type MAP. It is
2370                         optional.
2371  -u | --host-username   Host user name. It is of type STRING. By default,
2372                         it is read from environment variable
2373                         OPEN_CLI_HOST_USERNAME.
2374  -a | --no-auth         Whether to authenticate user or not. It is of
2375                         type BOOL.
2376  -p | --host-password   Host user password. It is of type STRING. By
2377                         default, it is read from environment variable
2378                         OPEN_CLI_HOST_PASSWORD. Secured.
2379
2380
2381 Results::
2382
2383  ID     Feature group ID and is of type STRING.
2384  name   Feature group name and is of type STRING.
2385
2386
2387 Error::
2388
2389  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
2390
2391
2392 vnf-create-with-template
2393 ----------------------------------------------------
2394
2395 usage: oclip vnf-create-with-template
2396
2397 Create a pnf with a template. this is flexible approch to create VNF , all the parameters are in template json file
2398
2399 Product: onap-beijing
2400 Service: aai
2401 Author: ONAP CLI Team onap-discuss@lists.onap.org
2402
2403 Options::
2404
2405  [-m | --host-url] [-C | --no-catalog] [-h | --help]
2406  [-f | --format] [-t | --no-title] [-V | --verify]
2407  [-v | --version] [-d | --debug] [-r | --template]
2408  [-i | --vnf-id] [-s | --long] [-D | --context]
2409  [-u | --host-username] [-a | --no-auth] [-p | --host-password]
2410
2411 where::
2412
2413  -m | --host-url        host url in http(s). It is of type URL. By
2414                         default, it is read from environment variable
2415                         OPEN_CLI_HOST_URL.
2416  -C | --no-catalog      Whether to use given host-url directly or
2417                         discover it from catalog, it will override the
2418                         service->mode. It is of type BOOL. It is
2419                         optional.
2420  -h | --help            print help message. It is of type BOOL.
2421  -f | --format          Output formats, supported formats such as table,
2422                         csv, json, yaml. It is of type STRING.
2423  -t | --no-title        whether to print title or not. It is of type BOOL.
2424  -V | --verify          Helps to verify the command using samples
2425                         provides under open-cli-samples directory. By
2426                         default, it goes with mock.To enable the
2427                         verification of samples in real time, set
2428                         DISABLE_MOCKING=true in the context parameter. It
2429                         is of type BOOL. It is optional.
2430  -v | --version         print service version. It is of type BOOL.
2431  -d | --debug           Enable debug output. It is of type BOOL.
2432  -r | --template        template. It is of type JSON. It's recommended to
2433                         input the complete path of the file, which is
2434                         having the value for it.
2435  -i | --vnf-id          vnf-id. It is of type STRING. By default, it is .
2436  -s | --long            whether to print all attributes or only short
2437                         attributes. It is of type BOOL.
2438  -D | --context         command context. It is of type MAP. It is
2439                         optional.
2440  -u | --host-username   Host user name. It is of type STRING. By default,
2441                         it is read from environment variable
2442                         OPEN_CLI_HOST_USERNAME.
2443  -a | --no-auth         Whether to authenticate user or not. It is of
2444                         type BOOL.
2445  -p | --host-password   Host user password. It is of type STRING. By
2446                         default, it is read from environment variable
2447                         OPEN_CLI_HOST_PASSWORD. Secured.
2448
2449
2450 Error::
2451
2452  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
2453
2454
2455 vnfm-show
2456 ----------------------------------------------------
2457
2458 usage: oclip vnfm-show
2459
2460 Show the VNFM in Onap
2461
2462 Product: onap-beijing
2463 Service: aai
2464 Author: ONAP CLI Team onap-discuss@lists.onap.org
2465
2466 Options::
2467
2468  [-m | --host-url] [-C | --no-catalog] [-h | --help]
2469  [-f | --format] [-t | --no-title] [-V | --verify]
2470  [-v | --version] [-d | --debug] [-x | --vnfm-id]
2471  [-s | --long] [-D | --context] [-u | --host-username]
2472  [-a | --no-auth] [-p | --host-password]
2473
2474 where::
2475
2476  -m | --host-url        host url in http(s). It is of type URL. By
2477                         default, it is read from environment variable
2478                         OPEN_CLI_HOST_URL.
2479  -C | --no-catalog      Whether to use given host-url directly or
2480                         discover it from catalog, it will override the
2481                         service->mode. It is of type BOOL. It is
2482                         optional.
2483  -h | --help            print help message. It is of type BOOL.
2484  -f | --format          Output formats, supported formats such as table,
2485                         csv, json, yaml. It is of type STRING.
2486  -t | --no-title        whether to print title or not. It is of type BOOL.
2487  -V | --verify          Helps to verify the command using samples
2488                         provides under open-cli-samples directory. By
2489                         default, it goes with mock.To enable the
2490                         verification of samples in real time, set
2491                         DISABLE_MOCKING=true in the context parameter. It
2492                         is of type BOOL. It is optional.
2493  -v | --version         print service version. It is of type BOOL.
2494  -d | --debug           Enable debug output. It is of type BOOL.
2495  -x | --vnfm-id         Onap VNFM unique id. It is of type UUID.
2496  -s | --long            whether to print all attributes or only short
2497                         attributes. It is of type BOOL.
2498  -D | --context         command context. It is of type MAP. It is
2499                         optional.
2500  -u | --host-username   Host user name. It is of type STRING. By default,
2501                         it is read from environment variable
2502                         OPEN_CLI_HOST_USERNAME.
2503  -a | --no-auth         Whether to authenticate user or not. It is of
2504                         type BOOL.
2505  -p | --host-password   Host user password. It is of type STRING. By
2506                         default, it is read from environment variable
2507                         OPEN_CLI_HOST_PASSWORD. Secured.
2508
2509
2510 Results::
2511
2512  name       Onap vnfm name and is of type STRING.
2513  type       Onap vnfm type and is of type STRING.
2514  vendor     Onap vnfm vendor and is of type STRING.
2515  version    Onap vnfm version and is of type STRING.
2516  url        Onap vnfm url and is of type STRING.
2517  username   Onap vnfm username and is of type STRING.
2518
2519
2520 Error::
2521
2522  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
2523
2524
2525 vsp-create
2526 ----------------------------------------------------
2527
2528 usage: oclip vsp-create
2529
2530 Create Vendor Software Product
2531
2532 Product: onap-beijing
2533 Service: sdc
2534 Author: ONAP CLI Team onap-discuss@lists.onap.org
2535
2536 Options::
2537
2538  [-m | --host-url] [-j | --vlm-feature-group-id] [-C | --no-catalog]
2539  [-h | --help] [-f | --format] [-t | --no-title]
2540  [-V | --verify] [-v | --version] [-d | --debug]
2541  [-e | --vlm-vendor] [-b | --vsp-subcategory] [-z | --vsp-category]
2542  [-x | --vsp-name] [-s | --long] [-D | --context]
2543  [-y | --vsp-description] [-i | --vlm-agreement-id] [-c | --vlm-version]
2544  [-u | --host-username] [-a | --no-auth] [-g | --vlm-id]
2545  [-p | --host-password]
2546
2547 where::
2548
2549  -m | --host-url              host url in http(s). It is of type URL. By
2550                               default, it is read from environment variable
2551                               OPEN_CLI_HOST_URL.
2552  -j | --vlm-feature-group-id  Feature Group ID. It is of type STRING. By
2553                               default, it is .
2554  -C | --no-catalog            Whether to use given host-url directly or
2555                               discover it from catalog, it will override the
2556                               service->mode. It is of type BOOL. It is
2557                               optional.
2558  -h | --help                  print help message. It is of type BOOL.
2559  -f | --format                Output formats, supported formats such as table,
2560                               csv, json, yaml. It is of type STRING.
2561  -t | --no-title              whether to print title or not. It is of type BOOL.
2562  -V | --verify                Helps to verify the command using samples
2563                               provides under open-cli-samples directory. By
2564                               default, it goes with mock.To enable the
2565                               verification of samples in real time, set
2566                               DISABLE_MOCKING=true in the context parameter. It
2567                               is of type BOOL. It is optional.
2568  -v | --version               print service version. It is of type BOOL.
2569  -d | --debug                 Enable debug output. It is of type BOOL.
2570  -e | --vlm-vendor            License Model vendor. It is of type STRING. By
2571                               default, it is .
2572  -b | --vsp-subcategory       Sub Category of VSP. It is of type STRING. It is
2573                               optional.
2574  -z | --vsp-category          Category of the VSP. It is of type STRING. It is
2575                               optional.
2576  -x | --vsp-name              Onap VSP Name. It is of type STRING. By default,
2577                               it is .
2578  -s | --long                  whether to print all attributes or only short
2579                               attributes. It is of type BOOL.
2580  -D | --context               command context. It is of type MAP. It is
2581                               optional.
2582  -y | --vsp-description       Description for VSP. It is of type STRING. It is
2583                               optional. By default, it is .
2584  -i | --vlm-agreement-id      License Agreement ID. It is of type STRING. By
2585                               default, it is .
2586  -c | --vlm-version           License version. It is of type STRING. It is
2587                               optional.
2588  -u | --host-username         Host user name. It is of type STRING. By default,
2589                               it is read from environment variable
2590                               OPEN_CLI_HOST_USERNAME.
2591  -a | --no-auth               Whether to authenticate user or not. It is of
2592                               type BOOL.
2593  -g | --vlm-id                License Model ID. It is of type STRING. By
2594                               default, it is .
2595  -p | --host-password         Host user password. It is of type STRING. By
2596                               default, it is read from environment variable
2597                               OPEN_CLI_HOST_PASSWORD. Secured.
2598
2599
2600 Results::
2601
2602  ID   VSP ID and is of type STRING.
2603
2604
2605 Error::
2606
2607  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
2608
2609
2610 vsp-submit
2611 ----------------------------------------------------
2612
2613 usage: oclip vsp-submit
2614
2615 Submit Vendor Software Product
2616
2617 Product: onap-beijing
2618 Service: sdc
2619 Author: ONAP CLI Team onap-discuss@lists.onap.org
2620
2621 Options::
2622
2623  [-m | --host-url] [-C | --no-catalog] [-h | --help]
2624  [-f | --format] [-t | --no-title] [-V | --verify]
2625  [-v | --version] [-d | --debug] [-x | --vsp-id]
2626  [-s | --long] [-D | --context] [-y | --vsp-version]
2627  [-u | --host-username] [-a | --no-auth] [-p | --host-password]
2628
2629 where::
2630
2631  -m | --host-url        host url in http(s). It is of type URL. By
2632                         default, it is read from environment variable
2633                         OPEN_CLI_HOST_URL.
2634  -C | --no-catalog      Whether to use given host-url directly or
2635                         discover it from catalog, it will override the
2636                         service->mode. It is of type BOOL. It is
2637                         optional.
2638  -h | --help            print help message. It is of type BOOL.
2639  -f | --format          Output formats, supported formats such as table,
2640                         csv, json, yaml. It is of type STRING.
2641  -t | --no-title        whether to print title or not. It is of type BOOL.
2642  -V | --verify          Helps to verify the command using samples
2643                         provides under open-cli-samples directory. By
2644                         default, it goes with mock.To enable the
2645                         verification of samples in real time, set
2646                         DISABLE_MOCKING=true in the context parameter. It
2647                         is of type BOOL. It is optional.
2648  -v | --version         print service version. It is of type BOOL.
2649  -d | --debug           Enable debug output. It is of type BOOL.
2650  -x | --vsp-id          Onap VSP ID. It is of type STRING. By default, it
2651                         is .
2652  -s | --long            whether to print all attributes or only short
2653                         attributes. It is of type BOOL.
2654  -D | --context         command context. It is of type MAP. It is
2655                         optional.
2656  -y | --vsp-version     VSP version. It is of type STRING. By default, it
2657                         is .
2658  -u | --host-username   Host user name. It is of type STRING. By default,
2659                         it is read from environment variable
2660                         OPEN_CLI_HOST_USERNAME.
2661  -a | --no-auth         Whether to authenticate user or not. It is of
2662                         type BOOL.
2663  -p | --host-password   Host user password. It is of type STRING. By
2664                         default, it is read from environment variable
2665                         OPEN_CLI_HOST_PASSWORD. Secured.
2666
2667
2668 Error::
2669
2670  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
2671
2672
2673 tenant-delete
2674 ----------------------------------------------------
2675
2676 usage: oclip tenant-delete
2677
2678 Delete tenant under given cloud region in Onap
2679
2680 Product: onap-beijing
2681 Service: aai
2682 Author: ONAP CLI Team onap-discuss@lists.onap.org
2683
2684 Options::
2685
2686  [-m | --host-url] [-C | --no-catalog] [-h | --help]
2687  [-f | --format] [-t | --no-title] [-V | --verify]
2688  [-v | --version] [-d | --debug] [-x | --cloud]
2689  [-z | --tenant-id] [-y | --region] [-r | --resource-version]
2690  [-s | --long] [-D | --context] [-u | --host-username]
2691  [-a | --no-auth] [-p | --host-password]
2692
2693 where::
2694
2695  -m | --host-url          host url in http(s). It is of type URL. By
2696                           default, it is read from environment variable
2697                           OPEN_CLI_HOST_URL.
2698  -C | --no-catalog        Whether to use given host-url directly or
2699                           discover it from catalog, it will override the
2700                           service->mode. It is of type BOOL. It is
2701                           optional.
2702  -h | --help              print help message. It is of type BOOL.
2703  -f | --format            Output formats, supported formats such as table,
2704                           csv, json, yaml. It is of type STRING.
2705  -t | --no-title          whether to print title or not. It is of type BOOL.
2706  -V | --verify            Helps to verify the command using samples
2707                           provides under open-cli-samples directory. By
2708                           default, it goes with mock.To enable the
2709                           verification of samples in real time, set
2710                           DISABLE_MOCKING=true in the context parameter. It
2711                           is of type BOOL. It is optional.
2712  -v | --version           print service version. It is of type BOOL.
2713  -d | --debug             Enable debug output. It is of type BOOL.
2714  -x | --cloud             Onap cloud. It is of type STRING. By default, it
2715                           is .
2716  -z | --tenant-id         Onap cloud tenant id. It is of type STRING. By
2717                           default, it is .
2718  -y | --region            Onap cloud region. It is of type STRING. By
2719                           default, it is .
2720  -r | --resource-version  Onap cloud tenant version. It is of type UUID. It
2721                           is optional.
2722  -s | --long              whether to print all attributes or only short
2723                           attributes. It is of type BOOL.
2724  -D | --context           command context. It is of type MAP. It is
2725                           optional.
2726  -u | --host-username     Host user name. It is of type STRING. By default,
2727                           it is read from environment variable
2728                           OPEN_CLI_HOST_USERNAME.
2729  -a | --no-auth           Whether to authenticate user or not. It is of
2730                           type BOOL.
2731  -p | --host-password     Host user password. It is of type STRING. By
2732                           default, it is read from environment variable
2733                           OPEN_CLI_HOST_PASSWORD. Secured.
2734
2735
2736 Error::
2737
2738  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
2739
2740
2741 vf-delete
2742 ----------------------------------------------------
2743
2744 usage: oclip vf-delete
2745
2746 delete a VF (experimental)
2747
2748 Product: onap-beijing
2749 Service: so
2750 Author: ONAP CLI Team onap-discuss@lists.onap.org
2751
2752 Options::
2753
2754  [-m | --host-url] [-e | --model-name] [-C | --no-catalog]
2755  [-h | --help] [-f | --format] [-t | --no-title]
2756  [-V | --verify] [-v | --version] [-d | --debug]
2757  [-l | --cloud-region] [-b | --model-invariant-id] [-y | --service-instance-id]
2758  [-z | --tenant-id] [-s | --long] [-D | --context]
2759  [-g | --model-version] [-c | --model-uuid] [-u | --host-username]
2760  [-a | --no-auth] [-p | --host-password] [-x | --vf-id]
2761
2762 where::
2763
2764  -m | --host-url              host url in http(s). It is of type URL. By
2765                               default, it is read from environment variable
2766                               OPEN_CLI_HOST_URL.
2767  -e | --model-name            model name available in SDC catalog. It is of
2768                               type STRING. By default, it is .
2769  -C | --no-catalog            Whether to use given host-url directly or
2770                               discover it from catalog, it will override the
2771                               service->mode. It is of type BOOL. It is
2772                               optional.
2773  -h | --help                  print help message. It is of type BOOL.
2774  -f | --format                Output formats, supported formats such as table,
2775                               csv, json, yaml. It is of type STRING.
2776  -t | --no-title              whether to print title or not. It is of type BOOL.
2777  -V | --verify                Helps to verify the command using samples
2778                               provides under open-cli-samples directory. By
2779                               default, it goes with mock.To enable the
2780                               verification of samples in real time, set
2781                               DISABLE_MOCKING=true in the context parameter. It
2782                               is of type BOOL. It is optional.
2783  -v | --version               print service version. It is of type BOOL.
2784  -d | --debug                 Enable debug output. It is of type BOOL.
2785  -l | --cloud-region          Cloud region ID. It is of type STRING. By
2786                               default, it is .
2787  -b | --model-invariant-id    model invariant id for service in SDC catalog. It
2788                               is of type STRING. By default, it is .
2789  -y | --service-instance-id   unique id for service instance. It is of type
2790                               STRING. By default, it is .
2791  -z | --tenant-id             openstack tenant id (uuid). It is of type STRING.
2792                               By default, it is .
2793  -s | --long                  whether to print all attributes or only short
2794                               attributes. It is of type BOOL.
2795  -D | --context               command context. It is of type MAP. It is
2796                               optional.
2797  -g | --model-version         model version of service (eg. 1.0). It is of type
2798                               STRING. By default, it is .
2799  -c | --model-uuid            model uuid for service in SDC catalog. It is of
2800                               type STRING. By default, it is .
2801  -u | --host-username         Host user name. It is of type STRING. By default,
2802                               it is read from environment variable
2803                               OPEN_CLI_HOST_USERNAME.
2804  -a | --no-auth               Whether to authenticate user or not. It is of
2805                               type BOOL.
2806  -p | --host-password         Host user password. It is of type STRING. By
2807                               default, it is read from environment variable
2808                               OPEN_CLI_HOST_PASSWORD. Secured.
2809  -x | --vf-id                 id for vnf. It is of type STRING. By default, it
2810                               is .
2811
2812
2813 Error::
2814
2815  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
2816
2817
2818 vf-model-certify-complete
2819 ----------------------------------------------------
2820
2821 usage: oclip vf-model-certify-complete
2822
2823 Complete certifying Virtual function
2824
2825 Product: onap-beijing
2826 Service: sdc
2827 Author: ONAP CLI Team onap-discuss@lists.onap.org
2828
2829 Options::
2830
2831  [-m | --host-url] [-C | --no-catalog] [-h | --help]
2832  [-f | --format] [-t | --no-title] [-V | --verify]
2833  [-v | --version] [-d | --debug] [-b | --vf-id]
2834  [-s | --long] [-D | --context] [-u | --host-username]
2835  [-a | --no-auth] [-p | --host-password]
2836
2837 where::
2838
2839  -m | --host-url        host url in http(s). It is of type URL. By
2840                         default, it is read from environment variable
2841                         OPEN_CLI_HOST_URL.
2842  -C | --no-catalog      Whether to use given host-url directly or
2843                         discover it from catalog, it will override the
2844                         service->mode. It is of type BOOL. It is
2845                         optional.
2846  -h | --help            print help message. It is of type BOOL.
2847  -f | --format          Output formats, supported formats such as table,
2848                         csv, json, yaml. It is of type STRING.
2849  -t | --no-title        whether to print title or not. It is of type BOOL.
2850  -V | --verify          Helps to verify the command using samples
2851                         provides under open-cli-samples directory. By
2852                         default, it goes with mock.To enable the
2853                         verification of samples in real time, set
2854                         DISABLE_MOCKING=true in the context parameter. It
2855                         is of type BOOL. It is optional.
2856  -v | --version         print service version. It is of type BOOL.
2857  -d | --debug           Enable debug output. It is of type BOOL.
2858  -b | --vf-id           VF ID. It is of type STRING. It is optional. By
2859                         default, it is .
2860  -s | --long            whether to print all attributes or only short
2861                         attributes. It is of type BOOL.
2862  -D | --context         command context. It is of type MAP. It is
2863                         optional.
2864  -u | --host-username   Host user name. It is of type STRING. By default,
2865                         it is read from environment variable
2866                         OPEN_CLI_HOST_USERNAME.
2867  -a | --no-auth         Whether to authenticate user or not. It is of
2868                         type BOOL.
2869  -p | --host-password   Host user password. It is of type STRING. By
2870                         default, it is read from environment variable
2871                         OPEN_CLI_HOST_PASSWORD. Secured.
2872
2873
2874 Error::
2875
2876  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
2877
2878
2879 vf-model-list
2880 ----------------------------------------------------
2881
2882 usage: oclip vf-model-list
2883
2884 List the VF resource model in SDC
2885
2886 Product: onap-beijing
2887 Service: sdc
2888 Author: ONAP CLI Team onap-discuss@lists.onap.org
2889
2890 Options::
2891
2892  [-m | --host-url] [-C | --no-catalog] [-h | --help]
2893  [-f | --format] [-t | --no-title] [-V | --verify]
2894  [-v | --version] [-d | --debug] [-s | --long]
2895  [-D | --context] [-u | --host-username] [-a | --no-auth]
2896  [-p | --host-password]
2897
2898 where::
2899
2900  -m | --host-url        host url in http(s). It is of type URL. By
2901                         default, it is read from environment variable
2902                         OPEN_CLI_HOST_URL.
2903  -C | --no-catalog      Whether to use given host-url directly or
2904                         discover it from catalog, it will override the
2905                         service->mode. It is of type BOOL. It is
2906                         optional.
2907  -h | --help            print help message. It is of type BOOL.
2908  -f | --format          Output formats, supported formats such as table,
2909                         csv, json, yaml. It is of type STRING.
2910  -t | --no-title        whether to print title or not. It is of type BOOL.
2911  -V | --verify          Helps to verify the command using samples
2912                         provides under open-cli-samples directory. By
2913                         default, it goes with mock.To enable the
2914                         verification of samples in real time, set
2915                         DISABLE_MOCKING=true in the context parameter. It
2916                         is of type BOOL. It is optional.
2917  -v | --version         print service version. It is of type BOOL.
2918  -d | --debug           Enable debug output. It is of type BOOL.
2919  -s | --long            whether to print all attributes or only short
2920                         attributes. It is of type BOOL.
2921  -D | --context         command context. It is of type MAP. It is
2922                         optional.
2923  -u | --host-username   Host user name. It is of type STRING. By default,
2924                         it is read from environment variable
2925                         OPEN_CLI_HOST_USERNAME.
2926  -a | --no-auth         Whether to authenticate user or not. It is of
2927                         type BOOL.
2928  -p | --host-password   Host user password. It is of type STRING. By
2929                         default, it is read from environment variable
2930                         OPEN_CLI_HOST_PASSWORD. Secured.
2931
2932
2933 Results::
2934
2935  uuid             UUID and is of type STRING.
2936  uniqueid         UUID and is of type STRING.
2937  invariant-uuid   Invariant UUID and is of type STRING.
2938  name             Name and is of type STRING.
2939  version          version and is of type STRING.
2940  status           status and is of type STRING.
2941  description      description and is of type STRING.
2942  vsp-uuid         VSP uuid and is of type STRING.
2943  vsp-version      VSP version and is of type STRING.
2944
2945
2946 Error::
2947
2948  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
2949
2950
2951 vfmodule-delete
2952 ----------------------------------------------------
2953
2954 usage: oclip vfmodule-delete
2955
2956 delete a VF module (experimental)
2957
2958 Product: onap-beijing
2959 Service: so
2960 Author: ONAP CLI Team onap-discuss@lists.onap.org
2961
2962 Options::
2963
2964  [-m | --host-url] [-C | --no-catalog] [-h | --help]
2965  [-f | --format] [-t | --no-title] [-V | --verify]
2966  [-v | --version] [-d | --debug] [-l | --cloud-region]
2967  [-j | --service-id] [-z | --tenant-id] [-y | --vf-id]
2968  [-k | --vf-model-invariant-id] [-s | --long] [-D | --context]
2969  [-g | --vfmodule-version] [-x | --vfmodule-id] [-e | --vfmodule-name]
2970  [-u | --host-username] [-a | --no-auth] [-p | --host-password]
2971
2972 where::
2973
2974  -m | --host-url                host url in http(s). It is of type URL. By
2975                                 default, it is read from environment variable
2976                                 OPEN_CLI_HOST_URL.
2977  -C | --no-catalog              Whether to use given host-url directly or
2978                                 discover it from catalog, it will override the
2979                                 service->mode. It is of type BOOL. It is
2980                                 optional.
2981  -h | --help                    print help message. It is of type BOOL.
2982  -f | --format                  Output formats, supported formats such as table,
2983                                 csv, json, yaml. It is of type STRING.
2984  -t | --no-title                whether to print title or not. It is of type BOOL.
2985  -V | --verify                  Helps to verify the command using samples
2986                                 provides under open-cli-samples directory. By
2987                                 default, it goes with mock.To enable the
2988                                 verification of samples in real time, set
2989                                 DISABLE_MOCKING=true in the context parameter. It
2990                                 is of type BOOL. It is optional.
2991  -v | --version                 print service version. It is of type BOOL.
2992  -d | --debug                   Enable debug output. It is of type BOOL.
2993  -l | --cloud-region            cloud region identifier. It is of type STRING. By
2994                                 default, it is .
2995  -j | --service-id              unique id for service. It is of type STRING. By
2996                                 default, it is .
2997  -z | --tenant-id               openstack tenant id. It is of type STRING. By
2998                                 default, it is .
2999  -y | --vf-id                   unique id for related VF. It is of type STRING.
3000                                 By default, it is .
3001  -k | --vf-model-invariant-id   vf model invariant id. It is of type STRING. By
3002                                 default, it is .
3003  -s | --long                    whether to print all attributes or only short
3004                                 attributes. It is of type BOOL.
3005  -D | --context                 command context. It is of type MAP. It is
3006                                 optional.
3007  -g | --vfmodule-version        vf module version. It is of type STRING. By
3008                                 default, it is .
3009  -x | --vfmodule-id             VF module Id. It is of type STRING. By default,
3010                                 it is .
3011  -e | --vfmodule-name           vfmodule model name. It is of type STRING. By
3012                                 default, it is .
3013  -u | --host-username           Host user name. It is of type STRING. By default,
3014                                 it is read from environment variable
3015                                 OPEN_CLI_HOST_USERNAME.
3016  -a | --no-auth                 Whether to authenticate user or not. It is of
3017                                 type BOOL.
3018  -p | --host-password           Host user password. It is of type STRING. By
3019                                 default, it is read from environment variable
3020                                 OPEN_CLI_HOST_PASSWORD. Secured.
3021
3022
3023 Error::
3024
3025  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
3026
3027
3028 vlm-aggreement-list
3029 ----------------------------------------------------
3030
3031 usage: oclip vlm-aggreement-list
3032
3033 List license aggreement
3034
3035 Product: onap-beijing
3036 Service: sdc
3037 Author: ONAP CLI Team onap-discuss@lists.onap.org
3038
3039 Options::
3040
3041  [-m | --host-url] [-C | --no-catalog] [-y | --vlm-version]
3042  [-h | --help] [-f | --format] [-t | --no-title]
3043  [-V | --verify] [-v | --version] [-d | --debug]
3044  [-x | --vlm-id] [-s | --long] [-D | --context]
3045  [-u | --host-username] [-a | --no-auth] [-p | --host-password]
3046
3047 where::
3048
3049  -m | --host-url        host url in http(s). It is of type URL. By
3050                         default, it is read from environment variable
3051                         OPEN_CLI_HOST_URL.
3052  -C | --no-catalog      Whether to use given host-url directly or
3053                         discover it from catalog, it will override the
3054                         service->mode. It is of type BOOL. It is
3055                         optional.
3056  -y | --vlm-version     License Model version. It is of type STRING. By
3057                         default, it is .
3058  -h | --help            print help message. It is of type BOOL.
3059  -f | --format          Output formats, supported formats such as table,
3060                         csv, json, yaml. It is of type STRING.
3061  -t | --no-title        whether to print title or not. It is of type BOOL.
3062  -V | --verify          Helps to verify the command using samples
3063                         provides under open-cli-samples directory. By
3064                         default, it goes with mock.To enable the
3065                         verification of samples in real time, set
3066                         DISABLE_MOCKING=true in the context parameter. It
3067                         is of type BOOL. It is optional.
3068  -v | --version         print service version. It is of type BOOL.
3069  -d | --debug           Enable debug output. It is of type BOOL.
3070  -x | --vlm-id          License Model ID. It is of type STRING. By
3071                         default, it is .
3072  -s | --long            whether to print all attributes or only short
3073                         attributes. It is of type BOOL.
3074  -D | --context         command context. It is of type MAP. It is
3075                         optional.
3076  -u | --host-username   Host user name. It is of type STRING. By default,
3077                         it is read from environment variable
3078                         OPEN_CLI_HOST_USERNAME.
3079  -a | --no-auth         Whether to authenticate user or not. It is of
3080                         type BOOL.
3081  -p | --host-password   Host user password. It is of type STRING. By
3082                         default, it is read from environment variable
3083                         OPEN_CLI_HOST_PASSWORD. Secured.
3084
3085
3086 Results::
3087
3088  ID     aggreement ID and is of type STRING.
3089  name   aggreement name and is of type STRING.
3090
3091
3092 Error::
3093
3094  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
3095
3096
3097 vlm-entitlement-pool-list
3098 ----------------------------------------------------
3099
3100 usage: oclip vlm-entitlement-pool-list
3101
3102 entitlement pool list in a license model
3103
3104 Product: onap-beijing
3105 Service: sdc
3106 Author: ONAP CLI Team onap-discuss@lists.onap.org
3107
3108 Options::
3109
3110  [-m | --host-url] [-C | --no-catalog] [-y | --vlm-version]
3111  [-h | --help] [-f | --format] [-t | --no-title]
3112  [-V | --verify] [-v | --version] [-d | --debug]
3113  [-x | --vlm-id] [-s | --long] [-D | --context]
3114  [-u | --host-username] [-a | --no-auth] [-p | --host-password]
3115
3116 where::
3117
3118  -m | --host-url        host url in http(s). It is of type URL. By
3119                         default, it is read from environment variable
3120                         OPEN_CLI_HOST_URL.
3121  -C | --no-catalog      Whether to use given host-url directly or
3122                         discover it from catalog, it will override the
3123                         service->mode. It is of type BOOL. It is
3124                         optional.
3125  -y | --vlm-version     License Model version. It is of type STRING. By
3126                         default, it is .
3127  -h | --help            print help message. It is of type BOOL.
3128  -f | --format          Output formats, supported formats such as table,
3129                         csv, json, yaml. It is of type STRING.
3130  -t | --no-title        whether to print title or not. It is of type BOOL.
3131  -V | --verify          Helps to verify the command using samples
3132                         provides under open-cli-samples directory. By
3133                         default, it goes with mock.To enable the
3134                         verification of samples in real time, set
3135                         DISABLE_MOCKING=true in the context parameter. It
3136                         is of type BOOL. It is optional.
3137  -v | --version         print service version. It is of type BOOL.
3138  -d | --debug           Enable debug output. It is of type BOOL.
3139  -x | --vlm-id          License Model ID. It is of type STRING. By
3140                         default, it is .
3141  -s | --long            whether to print all attributes or only short
3142                         attributes. It is of type BOOL.
3143  -D | --context         command context. It is of type MAP. It is
3144                         optional.
3145  -u | --host-username   Host user name. It is of type STRING. By default,
3146                         it is read from environment variable
3147                         OPEN_CLI_HOST_USERNAME.
3148  -a | --no-auth         Whether to authenticate user or not. It is of
3149                         type BOOL.
3150  -p | --host-password   Host user password. It is of type STRING. By
3151                         default, it is read from environment variable
3152                         OPEN_CLI_HOST_PASSWORD. Secured.
3153
3154
3155 Results::
3156
3157  ID     Feature group ID and is of type STRING.
3158  name   Feature group name and is of type STRING.
3159
3160
3161 Error::
3162
3163  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
3164
3165
3166 vlm-list
3167 ----------------------------------------------------
3168
3169 usage: oclip vlm-list
3170
3171 List License Model
3172
3173 Product: onap-beijing
3174 Service: sdc
3175 Author: ONAP CLI Team onap-discuss@lists.onap.org
3176
3177 Options::
3178
3179  [-m | --host-url] [-C | --no-catalog] [-h | --help]
3180  [-f | --format] [-t | --no-title] [-V | --verify]
3181  [-v | --version] [-d | --debug] [-s | --long]
3182  [-D | --context] [-u | --host-username] [-a | --no-auth]
3183  [-p | --host-password]
3184
3185 where::
3186
3187  -m | --host-url        host url in http(s). It is of type URL. By
3188                         default, it is read from environment variable
3189                         OPEN_CLI_HOST_URL.
3190  -C | --no-catalog      Whether to use given host-url directly or
3191                         discover it from catalog, it will override the
3192                         service->mode. It is of type BOOL. It is
3193                         optional.
3194  -h | --help            print help message. It is of type BOOL.
3195  -f | --format          Output formats, supported formats such as table,
3196                         csv, json, yaml. It is of type STRING.
3197  -t | --no-title        whether to print title or not. It is of type BOOL.
3198  -V | --verify          Helps to verify the command using samples
3199                         provides under open-cli-samples directory. By
3200                         default, it goes with mock.To enable the
3201                         verification of samples in real time, set
3202                         DISABLE_MOCKING=true in the context parameter. It
3203                         is of type BOOL. It is optional.
3204  -v | --version         print service version. It is of type BOOL.
3205  -d | --debug           Enable debug output. It is of type BOOL.
3206  -s | --long            whether to print all attributes or only short
3207                         attributes. It is of type BOOL.
3208  -D | --context         command context. It is of type MAP. It is
3209                         optional.
3210  -u | --host-username   Host user name. It is of type STRING. By default,
3211                         it is read from environment variable
3212                         OPEN_CLI_HOST_USERNAME.
3213  -a | --no-auth         Whether to authenticate user or not. It is of
3214                         type BOOL.
3215  -p | --host-password   Host user password. It is of type STRING. By
3216                         default, it is read from environment variable
3217                         OPEN_CLI_HOST_PASSWORD. Secured.
3218
3219
3220 Results::
3221
3222  id           License ID and is of type UUID.
3223  vendor-name  Vendor  Name and is of type STRING.
3224  vlm-version  VLM version and is of type STRING.
3225  status       status and is of type STRING.
3226  description  License description and is of type STRING.
3227
3228
3229 Error::
3230
3231  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
3232
3233
3234 vnf-delete
3235 ----------------------------------------------------
3236
3237 usage: oclip vnf-delete
3238
3239 Delete vnf from Onap
3240
3241 Product: onap-beijing
3242 Service: aai
3243 Author: ONAP CLI Team onap-discuss@lists.onap.org
3244
3245 Options::
3246
3247  [-m | --host-url] [-C | --no-catalog] [-h | --help]
3248  [-f | --format] [-t | --no-title] [-V | --verify]
3249  [-v | --version] [-d | --debug] [-i | --vnf-id]
3250  [-s | --long] [-D | --context] [-u | --host-username]
3251  [-a | --no-auth] [-p | --host-password] [-b | --resource-version]
3252
3253 where::
3254
3255  -m | --host-url          host url in http(s). It is of type URL. By
3256                           default, it is read from environment variable
3257                           OPEN_CLI_HOST_URL.
3258  -C | --no-catalog        Whether to use given host-url directly or
3259                           discover it from catalog, it will override the
3260                           service->mode. It is of type BOOL. It is
3261                           optional.
3262  -h | --help              print help message. It is of type BOOL.
3263  -f | --format            Output formats, supported formats such as table,
3264                           csv, json, yaml. It is of type STRING.
3265  -t | --no-title          whether to print title or not. It is of type BOOL.
3266  -V | --verify            Helps to verify the command using samples
3267                           provides under open-cli-samples directory. By
3268                           default, it goes with mock.To enable the
3269                           verification of samples in real time, set
3270                           DISABLE_MOCKING=true in the context parameter. It
3271                           is of type BOOL. It is optional.
3272  -v | --version           print service version. It is of type BOOL.
3273  -d | --debug             Enable debug output. It is of type BOOL.
3274  -i | --vnf-id            Onap vnf id. It is of type STRING. By default, it
3275                           is .
3276  -s | --long              whether to print all attributes or only short
3277                           attributes. It is of type BOOL.
3278  -D | --context           command context. It is of type MAP. It is
3279                           optional.
3280  -u | --host-username     Host user name. It is of type STRING. By default,
3281                           it is read from environment variable
3282                           OPEN_CLI_HOST_USERNAME.
3283  -a | --no-auth           Whether to authenticate user or not. It is of
3284                           type BOOL.
3285  -p | --host-password     Host user password. It is of type STRING. By
3286                           default, it is read from environment variable
3287                           OPEN_CLI_HOST_PASSWORD. Secured.
3288  -b | --resource-version  Onap vnf resource version. It is of type UUID.
3289
3290
3291 Error::
3292
3293  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
3294
3295
3296 vnfm-unregister
3297 ----------------------------------------------------
3298
3299 usage: oclip vnfm-unregister
3300
3301 Un-register a VNFM in Onap
3302
3303 Product: onap-beijing
3304 Service: aai
3305 Author: ONAP CLI Team onap-discuss@lists.onap.org
3306
3307 Options::
3308
3309  [-m | --host-url] [-C | --no-catalog] [-h | --help]
3310  [-f | --format] [-t | --no-title] [-V | --verify]
3311  [-v | --version] [-d | --debug] [-y | --resource-version]
3312  [-x | --vnfm-id] [-s | --long] [-D | --context]
3313  [-u | --host-username] [-a | --no-auth] [-p | --host-password]
3314
3315 where::
3316
3317  -m | --host-url          host url in http(s). It is of type URL. By
3318                           default, it is read from environment variable
3319                           OPEN_CLI_HOST_URL.
3320  -C | --no-catalog        Whether to use given host-url directly or
3321                           discover it from catalog, it will override the
3322                           service->mode. It is of type BOOL. It is
3323                           optional.
3324  -h | --help              print help message. It is of type BOOL.
3325  -f | --format            Output formats, supported formats such as table,
3326                           csv, json, yaml. It is of type STRING.
3327  -t | --no-title          whether to print title or not. It is of type BOOL.
3328  -V | --verify            Helps to verify the command using samples
3329                           provides under open-cli-samples directory. By
3330                           default, it goes with mock.To enable the
3331                           verification of samples in real time, set
3332                           DISABLE_MOCKING=true in the context parameter. It
3333                           is of type BOOL. It is optional.
3334  -v | --version           print service version. It is of type BOOL.
3335  -d | --debug             Enable debug output. It is of type BOOL.
3336  -y | --resource-version  Onap vim resource version. It is of type STRING.
3337                           It is optional. By default, it is .
3338  -x | --vnfm-id           Onap VNFM unique id. It is of type UUID.
3339  -s | --long              whether to print all attributes or only short
3340                           attributes. It is of type BOOL.
3341  -D | --context           command context. It is of type MAP. It is
3342                           optional.
3343  -u | --host-username     Host user name. It is of type STRING. By default,
3344                           it is read from environment variable
3345                           OPEN_CLI_HOST_USERNAME.
3346  -a | --no-auth           Whether to authenticate user or not. It is of
3347                           type BOOL.
3348  -p | --host-password     Host user password. It is of type STRING. By
3349                           default, it is read from environment variable
3350                           OPEN_CLI_HOST_PASSWORD. Secured.
3351
3352
3353 Error::
3354
3355  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
3356
3357
3358 vsp-list
3359 ----------------------------------------------------
3360
3361 usage: oclip vsp-list
3362
3363 List of the Vendor Software Products
3364
3365 Product: onap-beijing
3366 Service: sdc
3367 Author: ONAP CLI Team onap-discuss@lists.onap.org
3368
3369 Options::
3370
3371  [-m | --host-url] [-C | --no-catalog] [-h | --help]
3372  [-f | --format] [-t | --no-title] [-V | --verify]
3373  [-v | --version] [-d | --debug] [-s | --long]
3374  [-D | --context] [-u | --host-username] [-a | --no-auth]
3375  [-p | --host-password]
3376
3377 where::
3378
3379  -m | --host-url        host url in http(s). It is of type URL. By
3380                         default, it is read from environment variable
3381                         OPEN_CLI_HOST_URL.
3382  -C | --no-catalog      Whether to use given host-url directly or
3383                         discover it from catalog, it will override the
3384                         service->mode. It is of type BOOL. It is
3385                         optional.
3386  -h | --help            print help message. It is of type BOOL.
3387  -f | --format          Output formats, supported formats such as table,
3388                         csv, json, yaml. It is of type STRING.
3389  -t | --no-title        whether to print title or not. It is of type BOOL.
3390  -V | --verify          Helps to verify the command using samples
3391                         provides under open-cli-samples directory. By
3392                         default, it goes with mock.To enable the
3393                         verification of samples in real time, set
3394                         DISABLE_MOCKING=true in the context parameter. It
3395                         is of type BOOL. It is optional.
3396  -v | --version         print service version. It is of type BOOL.
3397  -d | --debug           Enable debug output. It is of type BOOL.
3398  -s | --long            whether to print all attributes or only short
3399                         attributes. It is of type BOOL.
3400  -D | --context         command context. It is of type MAP. It is
3401                         optional.
3402  -u | --host-username   Host user name. It is of type STRING. By default,
3403                         it is read from environment variable
3404                         OPEN_CLI_HOST_USERNAME.
3405  -a | --no-auth         Whether to authenticate user or not. It is of
3406                         type BOOL.
3407  -p | --host-password   Host user password. It is of type STRING. By
3408                         default, it is read from environment variable
3409                         OPEN_CLI_HOST_PASSWORD. Secured.
3410
3411
3412 Results::
3413
3414  ID               VSP ID and is of type STRING.
3415  name             VSP Name and is of type STRING.
3416  vendor-name      Vendor name and is of type STRING.
3417  version          Version and is of type STRING.
3418  status           status and is of type STRING.
3419  license-id       license aggreement and is of type STRING.
3420  license-version  license version and is of type STRING.
3421
3422
3423 Error::
3424
3425  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
3426
3427
3428 vsp-validate
3429 ----------------------------------------------------
3430
3431 usage: oclip vsp-validate
3432
3433 Validated the uploaded Vendor Software Product
3434
3435 Product: onap-beijing
3436 Service: sdc
3437 Author: ONAP CLI Team onap-discuss@lists.onap.org
3438
3439 Options::
3440
3441  [-m | --host-url] [-C | --no-catalog] [-h | --help]
3442  [-f | --format] [-t | --no-title] [-V | --verify]
3443  [-v | --version] [-d | --debug] [-x | --vsp-id]
3444  [-s | --long] [-D | --context] [-y | --vsp-version]
3445  [-u | --host-username] [-a | --no-auth] [-p | --host-password]
3446
3447 where::
3448
3449  -m | --host-url        host url in http(s). It is of type URL. By
3450                         default, it is read from environment variable
3451                         OPEN_CLI_HOST_URL.
3452  -C | --no-catalog      Whether to use given host-url directly or
3453                         discover it from catalog, it will override the
3454                         service->mode. It is of type BOOL. It is
3455                         optional.
3456  -h | --help            print help message. It is of type BOOL.
3457  -f | --format          Output formats, supported formats such as table,
3458                         csv, json, yaml. It is of type STRING.
3459  -t | --no-title        whether to print title or not. It is of type BOOL.
3460  -V | --verify          Helps to verify the command using samples
3461                         provides under open-cli-samples directory. By
3462                         default, it goes with mock.To enable the
3463                         verification of samples in real time, set
3464                         DISABLE_MOCKING=true in the context parameter. It
3465                         is of type BOOL. It is optional.
3466  -v | --version         print service version. It is of type BOOL.
3467  -d | --debug           Enable debug output. It is of type BOOL.
3468  -x | --vsp-id          Onap VSP ID. It is of type STRING. By default, it
3469                         is .
3470  -s | --long            whether to print all attributes or only short
3471                         attributes. It is of type BOOL.
3472  -D | --context         command context. It is of type MAP. It is
3473                         optional.
3474  -y | --vsp-version     VSP version. It is of type STRING. By default, it
3475                         is .
3476  -u | --host-username   Host user name. It is of type STRING. By default,
3477                         it is read from environment variable
3478                         OPEN_CLI_HOST_USERNAME.
3479  -a | --no-auth         Whether to authenticate user or not. It is of
3480                         type BOOL.
3481  -p | --host-password   Host user password. It is of type STRING. By
3482                         default, it is read from environment variable
3483                         OPEN_CLI_HOST_PASSWORD. Secured.
3484
3485
3486 Results::
3487
3488  status   Validation status and is of type STRING.
3489  errors   Validation messages and is of type JSON.
3490
3491
3492 Error::
3493
3494  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
3495
3496
3497 tenant-list
3498 ----------------------------------------------------
3499
3500 usage: oclip tenant-list
3501
3502 Lists the tenants under given cloud region in Onap
3503
3504 Product: onap-beijing
3505 Service: aai
3506 Author: ONAP CLI Team onap-discuss@lists.onap.org
3507
3508 Options::
3509
3510  [-m | --host-url] [-C | --no-catalog] [-h | --help]
3511  [-f | --format] [-t | --no-title] [-V | --verify]
3512  [-v | --version] [-d | --debug] [-x | --cloud]
3513  [-y | --region] [-s | --long] [-D | --context]
3514  [-u | --host-username] [-a | --no-auth] [-p | --host-password]
3515
3516 where::
3517
3518  -m | --host-url        host url in http(s). It is of type URL. By
3519                         default, it is read from environment variable
3520                         OPEN_CLI_HOST_URL.
3521  -C | --no-catalog      Whether to use given host-url directly or
3522                         discover it from catalog, it will override the
3523                         service->mode. It is of type BOOL. It is
3524                         optional.
3525  -h | --help            print help message. It is of type BOOL.
3526  -f | --format          Output formats, supported formats such as table,
3527                         csv, json, yaml. It is of type STRING.
3528  -t | --no-title        whether to print title or not. It is of type BOOL.
3529  -V | --verify          Helps to verify the command using samples
3530                         provides under open-cli-samples directory. By
3531                         default, it goes with mock.To enable the
3532                         verification of samples in real time, set
3533                         DISABLE_MOCKING=true in the context parameter. It
3534                         is of type BOOL. It is optional.
3535  -v | --version         print service version. It is of type BOOL.
3536  -d | --debug           Enable debug output. It is of type BOOL.
3537  -x | --cloud           Onap cloud. It is of type STRING. By default, it
3538                         is .
3539  -y | --region          Onap cloud region. It is of type STRING. By
3540                         default, it is .
3541  -s | --long            whether to print all attributes or only short
3542                         attributes. It is of type BOOL.
3543  -D | --context         command context. It is of type MAP. It is
3544                         optional.
3545  -u | --host-username   Host user name. It is of type STRING. By default,
3546                         it is read from environment variable
3547                         OPEN_CLI_HOST_USERNAME.
3548  -a | --no-auth         Whether to authenticate user or not. It is of
3549                         type BOOL.
3550  -p | --host-password   Host user password. It is of type STRING. By
3551                         default, it is read from environment variable
3552                         OPEN_CLI_HOST_PASSWORD. Secured.
3553
3554
3555 Results::
3556
3557  tenant-id          Onap tenant-id and is of type STRING.
3558  tenant-name        Onap tenant name and is of type STRING.
3559  resource-version   Onap tenant resource version and is of type
3560                     STRING.
3561
3562
3563 Error::
3564
3565  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
3566