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