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>