aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v9.yaml

   1 swagger: "2.0"
   2 info:
   3   description: |
   4
   5     [Differences versus the previous schema version](apidocs/aai_swagger_v9.diff)
   6
   7     Copyright &copy; 2017 AT&amp;T Intellectual Property. All rights reserved.
   8
   9     Licensed under the Creative Commons License, Attribution 4.0 Intl. (the &quot;License&quot;); you may not use this documentation except in compliance with the License.
  10
  11     You may obtain a copy of the License at
  12
  13     (https://creativecommons.org/licenses/by/4.0/)
  14
  15     Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
  16
  17     ECOMP and OpenECOMP are trademarks and service marks of AT&amp;T Intellectual Property.
  18
  19     This document is best viewed with Firefox or Chrome. Nodes can be found by appending /#/definitions/node-type-to-find to the path to this document. Edge definitions can be found with the node definitions.
  20   version: "v9"
  21   title: Active and Available Inventory REST API
  22   license:
  23     name: Apache 2.0
  24     url: http://www.apache.org/licenses/LICENSE-2.0.html
  25   contact:
  26     name:
  27     url:
  28     email:
  29 host:
  30 basePath: /aai/v9
  31 schemes:
  32   - https
  33 paths:
  34   /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}/relationship-list/relationship:
  35     put:
  36       tags:
  37         - CloudInfrastructure
  38       summary: see node definition for valid relationships
  39       operationId: createOrUpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPoolRelationshipListRelationship
  40       consumes:
  41         - application/json
  42         - application/xml
  43       produces:
  44         - application/json
  45         - application/xml
  46       responses:
  47         "default":
  48           description: Response codes found in [response codes](https://wiki.onap.org/).
  49       parameters:
  50         - name: physical-location-id
  51           in: path
  52           description: Unique identifier for physical location, e.g., CLLI
  53           required: true
  54           type: string
  55           example: __PHYSICAL-LOCATION-ID__
  56         - name: target-pe
  57           in: path
  58           description: The Target provider edge router
  59           required: true
  60           type: string
  61           example: __TARGET-PE__
  62         - name: availability-zone-name
  63           in: path
  64           description: Name of the availability zone
  65           required: true
  66           type: string
  67           example: __AVAILABILITY-ZONE-NAME__
  68         - name: body
  69           in: body
  70           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json)
  71           required: true
  72           schema:
  73             $ref: "#/definitions/relationship"
  74     delete:
  75       tags:
  76         - CloudInfrastructure
  77       summary: delete an existing relationship
  78       description: delete an existing relationship
  79       operationId: deleteCloudInfrastructureComplexesComplexCtagPoolsCtagPoolRelationshipListRelationship
  80       consumes:
  81         - application/json
  82         - application/xml
  83       produces:
  84         - application/json
  85         - application/xml
  86       responses:
  87         "default":
  88           description: Response codes found in [response codes](https://wiki.onap.org/).
  89       parameters:
  90         - name: physical-location-id
  91           in: path
  92           description: Unique identifier for physical location, e.g., CLLI
  93           required: true
  94           type: string
  95           example: __PHYSICAL-LOCATION-ID__
  96         - name: target-pe
  97           in: path
  98           description: The Target provider edge router
  99           required: true
 100           type: string
 101           example: __TARGET-PE__
 102         - name: availability-zone-name
 103           in: path
 104           description: Name of the availability zone
 105           required: true
 106           type: string
 107           example: __AVAILABILITY-ZONE-NAME__
 108   /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}:
 109     get:
 110       tags:
 111         - CloudInfrastructure
 112       summary: returns ctag-pool
 113       description: returns ctag-pool
 114       operationId: getCloudInfrastructureComplexesComplexCtagPoolsCtagPool
 115       produces:
 116         - application/json
 117         - application/xml
 118       responses:
 119         "200":
 120           description: successful operation
 121           schema:
 122               $ref: "#/getDefinitions/ctag-pool"
 123         "default":
 124           description: Response codes found in [response codes](https://wiki.onap.org/).
 125       parameters:
 126         - name: physical-location-id
 127           in: path
 128           description: Unique identifier for physical location, e.g., CLLI
 129           required: true
 130           type: string
 131           example: __PHYSICAL-LOCATION-ID__
 132         - name: target-pe
 133           in: path
 134           description: The Target provider edge router
 135           required: true
 136           type: string
 137           example: __TARGET-PE__
 138         - name: availability-zone-name
 139           in: path
 140           description: Name of the availability zone
 141           required: true
 142           type: string
 143           example: __AVAILABILITY-ZONE-NAME__
 144         - name: data-center-code
 145           in: query
 146           description: Data center code which can be an alternate way to identify a complex
 147           required: false
 148           type: string
 149         - name: complex-name
 150           in: query
 151           description: Gamma complex name for LCP instance.
 152           required: false
 153           type: string
 154         - name: identity-url
 155           in: query
 156           description: URL of the keystone identity service
 157           required: false
 158           type: string
 159     put:
 160       tags:
 161         - CloudInfrastructure
 162       summary: create or update an existing ctag-pool
 163       description: |
 164         Create or update an existing ctag-pool.
 165         #
 166         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
 167       operationId: createOrUpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPool
 168       consumes:
 169         - application/json
 170         - application/xml
 171       produces:
 172         - application/json
 173         - application/xml
 174       responses:
 175         "default":
 176           description: Response codes found in [response codes](https://wiki.onap.org/).
 177       parameters:
 178         - name: physical-location-id
 179           in: path
 180           description: Unique identifier for physical location, e.g., CLLI
 181           required: true
 182           type: string
 183           example: __PHYSICAL-LOCATION-ID__
 184         - name: target-pe
 185           in: path
 186           description: The Target provider edge router
 187           required: true
 188           type: string
 189           example: __TARGET-PE__
 190         - name: availability-zone-name
 191           in: path
 192           description: Name of the availability zone
 193           required: true
 194           type: string
 195           example: __AVAILABILITY-ZONE-NAME__
 196         - name: body
 197           in: body
 198           description: ctag-pool object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json)
 199           required: true
 200           schema:
 201             $ref: "#/definitions/ctag-pool"
 202     patch:
 203       tags:
 204         - CloudInfrastructure
 205       summary: update an existing ctag-pool
 206       description: |
 207         Update an existing ctag-pool
 208         #
 209         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
 210         The PUT operation will entirely replace an existing object.
 211         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
 212         #
 213         Other differences between PUT and PATCH are:
 214         #
 215         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
 216         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
 217         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
 218       operationId: UpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPool
 219       consumes:
 220         - application/json
 221         - application/xml
 222       produces:
 223         - application/json
 224         - application/xml
 225       responses:
 226         "default":
 227           description: Response codes found in [response codes](https://wiki.onap.org/).
 228       parameters:
 229         - name: physical-location-id
 230           in: path
 231           description: Unique identifier for physical location, e.g., CLLI
 232           required: true
 233           type: string
 234           example: __PHYSICAL-LOCATION-ID__
 235         - name: target-pe
 236           in: path
 237           description: The Target provider edge router
 238           required: true
 239           type: string
 240           example: __TARGET-PE__
 241         - name: availability-zone-name
 242           in: path
 243           description: Name of the availability zone
 244           required: true
 245           type: string
 246           example: __AVAILABILITY-ZONE-NAME__
 247         - name: body
 248           in: body
 249           description: ctag-pool object that needs to be created or updated.
 250           required: true
 251           schema:
 252             $ref: "#/patchDefinitions/ctag-pool"
 253     delete:
 254       tags:
 255         - CloudInfrastructure
 256       summary: delete an existing ctag-pool
 257       description: delete an existing ctag-pool
 258       operationId: deleteCloudInfrastructureComplexesComplexCtagPoolsCtagPool
 259       consumes:
 260         - application/json
 261         - application/xml
 262       produces:
 263         - application/json
 264         - application/xml
 265       responses:
 266         "default":
 267           description: Response codes found in [response codes](https://wiki.onap.org/).
 268       parameters:
 269         - name: physical-location-id
 270           in: path
 271           description: Unique identifier for physical location, e.g., CLLI
 272           required: true
 273           type: string
 274           example: __PHYSICAL-LOCATION-ID__
 275         - name: target-pe
 276           in: path
 277           description: The Target provider edge router
 278           required: true
 279           type: string
 280           example: __TARGET-PE__
 281         - name: availability-zone-name
 282           in: path
 283           description: Name of the availability zone
 284           required: true
 285           type: string
 286           example: __AVAILABILITY-ZONE-NAME__
 287         - name: resource-version
 288           in: query
 289           description: resource-version for concurrency
 290           required: true
 291           type: string
 292   /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools:
 293     get:
 294       tags:
 295         - CloudInfrastructure
 296       summary: returns ctag-pools
 297       description: returns ctag-pools
 298       operationId: getCloudInfrastructureComplexesComplexCtagPools
 299       produces:
 300         - application/json
 301         - application/xml
 302       responses:
 303         "200":
 304           description: successful operation
 305           schema:
 306               $ref: "#/getDefinitions/ctag-pools"
 307         "default":
 308           description: Response codes found in [response codes](https://wiki.onap.org/).
 309       parameters:
 310         - name: physical-location-id
 311           in: path
 312           description: Unique identifier for physical location, e.g., CLLI
 313           required: true
 314           type: string
 315           example: __PHYSICAL-LOCATION-ID__
 316         - name: data-center-code
 317           in: query
 318           description: Data center code which can be an alternate way to identify a complex
 319           required: false
 320           type: string
 321         - name: complex-name
 322           in: query
 323           description: Gamma complex name for LCP instance.
 324           required: false
 325           type: string
 326         - name: identity-url
 327           in: query
 328           description: URL of the keystone identity service
 329           required: false
 330           type: string
 331   /cloud-infrastructure/complexes/complex/{physical-location-id}/relationship-list/relationship:
 332     put:
 333       tags:
 334         - CloudInfrastructure
 335       summary: see node definition for valid relationships
 336       operationId: createOrUpdateCloudInfrastructureComplexesComplexRelationshipListRelationship
 337       consumes:
 338         - application/json
 339         - application/xml
 340       produces:
 341         - application/json
 342         - application/xml
 343       responses:
 344         "default":
 345           description: Response codes found in [response codes](https://wiki.onap.org/).
 346       parameters:
 347         - name: physical-location-id
 348           in: path
 349           description: Unique identifier for physical location, e.g., CLLI
 350           required: true
 351           type: string
 352           example: __PHYSICAL-LOCATION-ID__
 353         - name: body
 354           in: body
 355           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureComplexesComplex.json)
 356           required: true
 357           schema:
 358             $ref: "#/definitions/relationship"
 359     delete:
 360       tags:
 361         - CloudInfrastructure
 362       summary: delete an existing relationship
 363       description: delete an existing relationship
 364       operationId: deleteCloudInfrastructureComplexesComplexRelationshipListRelationship
 365       consumes:
 366         - application/json
 367         - application/xml
 368       produces:
 369         - application/json
 370         - application/xml
 371       responses:
 372         "default":
 373           description: Response codes found in [response codes](https://wiki.onap.org/).
 374       parameters:
 375         - name: physical-location-id
 376           in: path
 377           description: Unique identifier for physical location, e.g., CLLI
 378           required: true
 379           type: string
 380           example: __PHYSICAL-LOCATION-ID__
 381   /cloud-infrastructure/complexes/complex/{physical-location-id}:
 382     get:
 383       tags:
 384         - CloudInfrastructure
 385       summary: returns complex
 386       description: returns complex
 387       operationId: getCloudInfrastructureComplexesComplex
 388       produces:
 389         - application/json
 390         - application/xml
 391       responses:
 392         "200":
 393           description: successful operation
 394           schema:
 395               $ref: "#/getDefinitions/complex"
 396         "default":
 397           description: Response codes found in [response codes](https://wiki.onap.org/).
 398       parameters:
 399         - name: physical-location-id
 400           in: path
 401           description: Unique identifier for physical location, e.g., CLLI
 402           required: true
 403           type: string
 404           example: __PHYSICAL-LOCATION-ID__
 405         - name: data-center-code
 406           in: query
 407           description: Data center code which can be an alternate way to identify a complex
 408           required: false
 409           type: string
 410         - name: complex-name
 411           in: query
 412           description: Gamma complex name for LCP instance.
 413           required: false
 414           type: string
 415         - name: identity-url
 416           in: query
 417           description: URL of the keystone identity service
 418           required: false
 419           type: string
 420     put:
 421       tags:
 422         - CloudInfrastructure
 423       summary: create or update an existing complex
 424       description: |
 425         Create or update an existing complex.
 426         #
 427         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
 428       operationId: createOrUpdateCloudInfrastructureComplexesComplex
 429       consumes:
 430         - application/json
 431         - application/xml
 432       produces:
 433         - application/json
 434         - application/xml
 435       responses:
 436         "default":
 437           description: Response codes found in [response codes](https://wiki.onap.org/).
 438       parameters:
 439         - name: physical-location-id
 440           in: path
 441           description: Unique identifier for physical location, e.g., CLLI
 442           required: true
 443           type: string
 444           example: __PHYSICAL-LOCATION-ID__
 445         - name: body
 446           in: body
 447           description: complex object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureComplexesComplex.json)
 448           required: true
 449           schema:
 450             $ref: "#/definitions/complex"
 451     patch:
 452       tags:
 453         - CloudInfrastructure
 454       summary: update an existing complex
 455       description: |
 456         Update an existing complex
 457         #
 458         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
 459         The PUT operation will entirely replace an existing object.
 460         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
 461         #
 462         Other differences between PUT and PATCH are:
 463         #
 464         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
 465         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
 466         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
 467       operationId: UpdateCloudInfrastructureComplexesComplex
 468       consumes:
 469         - application/json
 470         - application/xml
 471       produces:
 472         - application/json
 473         - application/xml
 474       responses:
 475         "default":
 476           description: Response codes found in [response codes](https://wiki.onap.org/).
 477       parameters:
 478         - name: physical-location-id
 479           in: path
 480           description: Unique identifier for physical location, e.g., CLLI
 481           required: true
 482           type: string
 483           example: __PHYSICAL-LOCATION-ID__
 484         - name: body
 485           in: body
 486           description: complex object that needs to be created or updated.
 487           required: true
 488           schema:
 489             $ref: "#/patchDefinitions/complex"
 490     delete:
 491       tags:
 492         - CloudInfrastructure
 493       summary: delete an existing complex
 494       description: delete an existing complex
 495       operationId: deleteCloudInfrastructureComplexesComplex
 496       consumes:
 497         - application/json
 498         - application/xml
 499       produces:
 500         - application/json
 501         - application/xml
 502       responses:
 503         "default":
 504           description: Response codes found in [response codes](https://wiki.onap.org/).
 505       parameters:
 506         - name: physical-location-id
 507           in: path
 508           description: Unique identifier for physical location, e.g., CLLI
 509           required: true
 510           type: string
 511           example: __PHYSICAL-LOCATION-ID__
 512         - name: resource-version
 513           in: query
 514           description: resource-version for concurrency
 515           required: true
 516           type: string
 517   /cloud-infrastructure/complexes:
 518     get:
 519       tags:
 520         - CloudInfrastructure
 521       summary: returns complexes
 522       description: returns complexes
 523       operationId: getCloudInfrastructureComplexes
 524       produces:
 525         - application/json
 526         - application/xml
 527       responses:
 528         "200":
 529           description: successful operation
 530           schema:
 531               $ref: "#/getDefinitions/complexes"
 532         "default":
 533           description: Response codes found in [response codes](https://wiki.onap.org/).
 534   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship:
 535     put:
 536       tags:
 537         - CloudInfrastructure
 538       summary: see node definition for valid relationships
 539       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroupRelationshipListRelationship
 540       consumes:
 541         - application/json
 542         - application/xml
 543       produces:
 544         - application/json
 545         - application/xml
 546       responses:
 547         "default":
 548           description: Response codes found in [response codes](https://wiki.onap.org/).
 549       parameters:
 550         - name: cloud-owner
 551           in: path
 552           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 553           required: true
 554           type: string
 555           example: __CLOUD-OWNER__
 556         - name: cloud-region-id
 557           in: path
 558           description: Identifier used by the vendor for the region. Second part of composite key
 559           required: true
 560           type: string
 561           example: __CLOUD-REGION-ID__
 562         - name: volume-group-id
 563           in: path
 564           description: Unique ID of volume-group.
 565           required: true
 566           type: string
 567           example: __VOLUME-GROUP-ID__
 568         - name: body
 569           in: body
 570           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json)
 571           required: true
 572           schema:
 573             $ref: "#/definitions/relationship"
 574     delete:
 575       tags:
 576         - CloudInfrastructure
 577       summary: delete an existing relationship
 578       description: delete an existing relationship
 579       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroupRelationshipListRelationship
 580       consumes:
 581         - application/json
 582         - application/xml
 583       produces:
 584         - application/json
 585         - application/xml
 586       responses:
 587         "default":
 588           description: Response codes found in [response codes](https://wiki.onap.org/).
 589       parameters:
 590         - name: cloud-owner
 591           in: path
 592           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 593           required: true
 594           type: string
 595           example: __CLOUD-OWNER__
 596         - name: cloud-region-id
 597           in: path
 598           description: Identifier used by the vendor for the region. Second part of composite key
 599           required: true
 600           type: string
 601           example: __CLOUD-REGION-ID__
 602         - name: volume-group-id
 603           in: path
 604           description: Unique ID of volume-group.
 605           required: true
 606           type: string
 607           example: __VOLUME-GROUP-ID__
 608   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}:
 609     get:
 610       tags:
 611         - CloudInfrastructure
 612       summary: returns volume-group
 613       description: returns volume-group
 614       operationId: getCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup
 615       produces:
 616         - application/json
 617         - application/xml
 618       responses:
 619         "200":
 620           description: successful operation
 621           schema:
 622               $ref: "#/getDefinitions/volume-group"
 623         "default":
 624           description: Response codes found in [response codes](https://wiki.onap.org/).
 625       parameters:
 626         - name: cloud-owner
 627           in: path
 628           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 629           required: true
 630           type: string
 631           example: __CLOUD-OWNER__
 632         - name: cloud-region-id
 633           in: path
 634           description: Identifier used by the vendor for the region. Second part of composite key
 635           required: true
 636           type: string
 637           example: __CLOUD-REGION-ID__
 638         - name: volume-group-id
 639           in: path
 640           description: Unique ID of volume-group.
 641           required: true
 642           type: string
 643           example: __VOLUME-GROUP-ID__
 644         - name: cloud-type
 645           in: query
 646           description: Type of the cloud (e.g., openstack)
 647           required: false
 648           type: string
 649         - name: owner-defined-type
 650           in: query
 651           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
 652           required: false
 653           type: string
 654         - name: volume-group-name
 655           in: query
 656           description: Name of the volume group.
 657           required: false
 658           type: string
 659         - name: heat-stack-id
 660           in: query
 661           description: Heat stack id corresponding to this volume-group
 662           required: false
 663           type: string
 664         - name: vnf-type
 665           in: query
 666           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
 667           required: false
 668           type: string
 669     put:
 670       tags:
 671         - CloudInfrastructure
 672       summary: create or update an existing volume-group
 673       description: |
 674         Create or update an existing volume-group.
 675         #
 676         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
 677       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup
 678       consumes:
 679         - application/json
 680         - application/xml
 681       produces:
 682         - application/json
 683         - application/xml
 684       responses:
 685         "default":
 686           description: Response codes found in [response codes](https://wiki.onap.org/).
 687       parameters:
 688         - name: cloud-owner
 689           in: path
 690           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 691           required: true
 692           type: string
 693           example: __CLOUD-OWNER__
 694         - name: cloud-region-id
 695           in: path
 696           description: Identifier used by the vendor for the region. Second part of composite key
 697           required: true
 698           type: string
 699           example: __CLOUD-REGION-ID__
 700         - name: volume-group-id
 701           in: path
 702           description: Unique ID of volume-group.
 703           required: true
 704           type: string
 705           example: __VOLUME-GROUP-ID__
 706         - name: body
 707           in: body
 708           description: volume-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json)
 709           required: true
 710           schema:
 711             $ref: "#/definitions/volume-group"
 712     patch:
 713       tags:
 714         - CloudInfrastructure
 715       summary: update an existing volume-group
 716       description: |
 717         Update an existing volume-group
 718         #
 719         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
 720         The PUT operation will entirely replace an existing object.
 721         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
 722         #
 723         Other differences between PUT and PATCH are:
 724         #
 725         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
 726         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
 727         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
 728       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup
 729       consumes:
 730         - application/json
 731         - application/xml
 732       produces:
 733         - application/json
 734         - application/xml
 735       responses:
 736         "default":
 737           description: Response codes found in [response codes](https://wiki.onap.org/).
 738       parameters:
 739         - name: cloud-owner
 740           in: path
 741           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 742           required: true
 743           type: string
 744           example: __CLOUD-OWNER__
 745         - name: cloud-region-id
 746           in: path
 747           description: Identifier used by the vendor for the region. Second part of composite key
 748           required: true
 749           type: string
 750           example: __CLOUD-REGION-ID__
 751         - name: volume-group-id
 752           in: path
 753           description: Unique ID of volume-group.
 754           required: true
 755           type: string
 756           example: __VOLUME-GROUP-ID__
 757         - name: body
 758           in: body
 759           description: volume-group object that needs to be created or updated.
 760           required: true
 761           schema:
 762             $ref: "#/patchDefinitions/volume-group"
 763     delete:
 764       tags:
 765         - CloudInfrastructure
 766       summary: delete an existing volume-group
 767       description: delete an existing volume-group
 768       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup
 769       consumes:
 770         - application/json
 771         - application/xml
 772       produces:
 773         - application/json
 774         - application/xml
 775       responses:
 776         "default":
 777           description: Response codes found in [response codes](https://wiki.onap.org/).
 778       parameters:
 779         - name: cloud-owner
 780           in: path
 781           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 782           required: true
 783           type: string
 784           example: __CLOUD-OWNER__
 785         - name: cloud-region-id
 786           in: path
 787           description: Identifier used by the vendor for the region. Second part of composite key
 788           required: true
 789           type: string
 790           example: __CLOUD-REGION-ID__
 791         - name: volume-group-id
 792           in: path
 793           description: Unique ID of volume-group.
 794           required: true
 795           type: string
 796           example: __VOLUME-GROUP-ID__
 797         - name: resource-version
 798           in: query
 799           description: resource-version for concurrency
 800           required: true
 801           type: string
 802   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups:
 803     get:
 804       tags:
 805         - CloudInfrastructure
 806       summary: returns volume-groups
 807       description: returns volume-groups
 808       operationId: getCloudInfrastructureCloudRegionsCloudRegionVolumeGroups
 809       produces:
 810         - application/json
 811         - application/xml
 812       responses:
 813         "200":
 814           description: successful operation
 815           schema:
 816               $ref: "#/getDefinitions/volume-groups"
 817         "default":
 818           description: Response codes found in [response codes](https://wiki.onap.org/).
 819       parameters:
 820         - name: cloud-owner
 821           in: path
 822           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 823           required: true
 824           type: string
 825           example: __CLOUD-OWNER__
 826         - name: cloud-region-id
 827           in: path
 828           description: Identifier used by the vendor for the region. Second part of composite key
 829           required: true
 830           type: string
 831           example: __CLOUD-REGION-ID__
 832         - name: cloud-type
 833           in: query
 834           description: Type of the cloud (e.g., openstack)
 835           required: false
 836           type: string
 837         - name: owner-defined-type
 838           in: query
 839           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
 840           required: false
 841           type: string
 842   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}/relationship-list/relationship:
 843     put:
 844       tags:
 845         - CloudInfrastructure
 846       summary: see node definition for valid relationships
 847       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolumeRelationshipListRelationship
 848       consumes:
 849         - application/json
 850         - application/xml
 851       produces:
 852         - application/json
 853         - application/xml
 854       responses:
 855         "default":
 856           description: Response codes found in [response codes](https://wiki.onap.org/).
 857       parameters:
 858         - name: cloud-owner
 859           in: path
 860           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 861           required: true
 862           type: string
 863           example: __CLOUD-OWNER__
 864         - name: cloud-region-id
 865           in: path
 866           description: Identifier used by the vendor for the region. Second part of composite key
 867           required: true
 868           type: string
 869           example: __CLOUD-REGION-ID__
 870         - name: tenant-id
 871           in: path
 872           description: Unique id relative to the cloud-region.
 873           required: true
 874           type: string
 875           example: __TENANT-ID__
 876         - name: vserver-id
 877           in: path
 878           description: Unique identifier for this vserver relative to its tenant
 879           required: true
 880           type: string
 881           example: __VSERVER-ID__
 882         - name: volume-id
 883           in: path
 884           description: Unique ID of block storage volume relative to the vserver.
 885           required: true
 886           type: string
 887           example: __VOLUME-ID__
 888         - name: body
 889           in: body
 890           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)
 891           required: true
 892           schema:
 893             $ref: "#/definitions/relationship"
 894     delete:
 895       tags:
 896         - CloudInfrastructure
 897       summary: delete an existing relationship
 898       description: delete an existing relationship
 899       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolumeRelationshipListRelationship
 900       consumes:
 901         - application/json
 902         - application/xml
 903       produces:
 904         - application/json
 905         - application/xml
 906       responses:
 907         "default":
 908           description: Response codes found in [response codes](https://wiki.onap.org/).
 909       parameters:
 910         - name: cloud-owner
 911           in: path
 912           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 913           required: true
 914           type: string
 915           example: __CLOUD-OWNER__
 916         - name: cloud-region-id
 917           in: path
 918           description: Identifier used by the vendor for the region. Second part of composite key
 919           required: true
 920           type: string
 921           example: __CLOUD-REGION-ID__
 922         - name: tenant-id
 923           in: path
 924           description: Unique id relative to the cloud-region.
 925           required: true
 926           type: string
 927           example: __TENANT-ID__
 928         - name: vserver-id
 929           in: path
 930           description: Unique identifier for this vserver relative to its tenant
 931           required: true
 932           type: string
 933           example: __VSERVER-ID__
 934         - name: volume-id
 935           in: path
 936           description: Unique ID of block storage volume relative to the vserver.
 937           required: true
 938           type: string
 939           example: __VOLUME-ID__
 940   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}:
 941     get:
 942       tags:
 943         - CloudInfrastructure
 944       summary: returns volume
 945       description: returns volume
 946       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
 947       produces:
 948         - application/json
 949         - application/xml
 950       responses:
 951         "200":
 952           description: successful operation
 953           schema:
 954               $ref: "#/getDefinitions/volume"
 955         "default":
 956           description: Response codes found in [response codes](https://wiki.onap.org/).
 957       parameters:
 958         - name: cloud-owner
 959           in: path
 960           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 961           required: true
 962           type: string
 963           example: __CLOUD-OWNER__
 964         - name: cloud-region-id
 965           in: path
 966           description: Identifier used by the vendor for the region. Second part of composite key
 967           required: true
 968           type: string
 969           example: __CLOUD-REGION-ID__
 970         - name: tenant-id
 971           in: path
 972           description: Unique id relative to the cloud-region.
 973           required: true
 974           type: string
 975           example: __TENANT-ID__
 976         - name: vserver-id
 977           in: path
 978           description: Unique identifier for this vserver relative to its tenant
 979           required: true
 980           type: string
 981           example: __VSERVER-ID__
 982         - name: volume-id
 983           in: path
 984           description: Unique ID of block storage volume relative to the vserver.
 985           required: true
 986           type: string
 987           example: __VOLUME-ID__
 988         - name: cloud-type
 989           in: query
 990           description: Type of the cloud (e.g., openstack)
 991           required: false
 992           type: string
 993         - name: owner-defined-type
 994           in: query
 995           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
 996           required: false
 997           type: string
 998         - name: tenant-name
 999           in: query
1000           description: Readable name of tenant
1001           required: false
1002           type: string
1003         - name: vserver-name
1004           in: query
1005           description: Name of vserver
1006           required: false
1007           type: string
1008         - name: vserver-name2
1009           in: query
1010           description: Alternative name of vserver
1011           required: false
1012           type: string
1013         - name: prov-status
1014           in: query
1015           description: Trigger for operational monitoring of this resource by Service Assurance systems.
1016           required: false
1017           type: string
1018         - name: in-maint
1019           in: query
1020           required: false
1021           type: boolean
1022         - name: is-closed-loop-disabled
1023           in: query
1024           required: false
1025           type: boolean
1026     put:
1027       tags:
1028         - CloudInfrastructure
1029       summary: create or update an existing volume
1030       description: |
1031         Create or update an existing volume.
1032         #
1033         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
1034       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
1035       consumes:
1036         - application/json
1037         - application/xml
1038       produces:
1039         - application/json
1040         - application/xml
1041       responses:
1042         "default":
1043           description: Response codes found in [response codes](https://wiki.onap.org/).
1044       parameters:
1045         - name: cloud-owner
1046           in: path
1047           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1048           required: true
1049           type: string
1050           example: __CLOUD-OWNER__
1051         - name: cloud-region-id
1052           in: path
1053           description: Identifier used by the vendor for the region. Second part of composite key
1054           required: true
1055           type: string
1056           example: __CLOUD-REGION-ID__
1057         - name: tenant-id
1058           in: path
1059           description: Unique id relative to the cloud-region.
1060           required: true
1061           type: string
1062           example: __TENANT-ID__
1063         - name: vserver-id
1064           in: path
1065           description: Unique identifier for this vserver relative to its tenant
1066           required: true
1067           type: string
1068           example: __VSERVER-ID__
1069         - name: volume-id
1070           in: path
1071           description: Unique ID of block storage volume relative to the vserver.
1072           required: true
1073           type: string
1074           example: __VOLUME-ID__
1075         - name: body
1076           in: body
1077           description: volume object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)
1078           required: true
1079           schema:
1080             $ref: "#/definitions/volume"
1081     patch:
1082       tags:
1083         - CloudInfrastructure
1084       summary: update an existing volume
1085       description: |
1086         Update an existing volume
1087         #
1088         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
1089         The PUT operation will entirely replace an existing object.
1090         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
1091         #
1092         Other differences between PUT and PATCH are:
1093         #
1094         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
1095         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
1096         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
1097       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
1098       consumes:
1099         - application/json
1100         - application/xml
1101       produces:
1102         - application/json
1103         - application/xml
1104       responses:
1105         "default":
1106           description: Response codes found in [response codes](https://wiki.onap.org/).
1107       parameters:
1108         - name: cloud-owner
1109           in: path
1110           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1111           required: true
1112           type: string
1113           example: __CLOUD-OWNER__
1114         - name: cloud-region-id
1115           in: path
1116           description: Identifier used by the vendor for the region. Second part of composite key
1117           required: true
1118           type: string
1119           example: __CLOUD-REGION-ID__
1120         - name: tenant-id
1121           in: path
1122           description: Unique id relative to the cloud-region.
1123           required: true
1124           type: string
1125           example: __TENANT-ID__
1126         - name: vserver-id
1127           in: path
1128           description: Unique identifier for this vserver relative to its tenant
1129           required: true
1130           type: string
1131           example: __VSERVER-ID__
1132         - name: volume-id
1133           in: path
1134           description: Unique ID of block storage volume relative to the vserver.
1135           required: true
1136           type: string
1137           example: __VOLUME-ID__
1138         - name: body
1139           in: body
1140           description: volume object that needs to be created or updated.
1141           required: true
1142           schema:
1143             $ref: "#/patchDefinitions/volume"
1144     delete:
1145       tags:
1146         - CloudInfrastructure
1147       summary: delete an existing volume
1148       description: delete an existing volume
1149       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
1150       consumes:
1151         - application/json
1152         - application/xml
1153       produces:
1154         - application/json
1155         - application/xml
1156       responses:
1157         "default":
1158           description: Response codes found in [response codes](https://wiki.onap.org/).
1159       parameters:
1160         - name: cloud-owner
1161           in: path
1162           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1163           required: true
1164           type: string
1165           example: __CLOUD-OWNER__
1166         - name: cloud-region-id
1167           in: path
1168           description: Identifier used by the vendor for the region. Second part of composite key
1169           required: true
1170           type: string
1171           example: __CLOUD-REGION-ID__
1172         - name: tenant-id
1173           in: path
1174           description: Unique id relative to the cloud-region.
1175           required: true
1176           type: string
1177           example: __TENANT-ID__
1178         - name: vserver-id
1179           in: path
1180           description: Unique identifier for this vserver relative to its tenant
1181           required: true
1182           type: string
1183           example: __VSERVER-ID__
1184         - name: volume-id
1185           in: path
1186           description: Unique ID of block storage volume relative to the vserver.
1187           required: true
1188           type: string
1189           example: __VOLUME-ID__
1190         - name: resource-version
1191           in: query
1192           description: resource-version for concurrency
1193           required: true
1194           type: string
1195   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes:
1196     get:
1197       tags:
1198         - CloudInfrastructure
1199       summary: returns volumes
1200       description: returns volumes
1201       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumes
1202       produces:
1203         - application/json
1204         - application/xml
1205       responses:
1206         "200":
1207           description: successful operation
1208           schema:
1209               $ref: "#/getDefinitions/volumes"
1210         "default":
1211           description: Response codes found in [response codes](https://wiki.onap.org/).
1212       parameters:
1213         - name: cloud-owner
1214           in: path
1215           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1216           required: true
1217           type: string
1218           example: __CLOUD-OWNER__
1219         - name: cloud-region-id
1220           in: path
1221           description: Identifier used by the vendor for the region. Second part of composite key
1222           required: true
1223           type: string
1224           example: __CLOUD-REGION-ID__
1225         - name: tenant-id
1226           in: path
1227           description: Unique id relative to the cloud-region.
1228           required: true
1229           type: string
1230           example: __TENANT-ID__
1231         - name: vserver-id
1232           in: path
1233           description: Unique identifier for this vserver relative to its tenant
1234           required: true
1235           type: string
1236           example: __VSERVER-ID__
1237         - name: cloud-type
1238           in: query
1239           description: Type of the cloud (e.g., openstack)
1240           required: false
1241           type: string
1242         - name: owner-defined-type
1243           in: query
1244           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
1245           required: false
1246           type: string
1247         - name: tenant-name
1248           in: query
1249           description: Readable name of tenant
1250           required: false
1251           type: string
1252         - name: vserver-name
1253           in: query
1254           description: Name of vserver
1255           required: false
1256           type: string
1257         - name: vserver-name2
1258           in: query
1259           description: Alternative name of vserver
1260           required: false
1261           type: string
1262         - name: prov-status
1263           in: query
1264           description: Trigger for operational monitoring of this resource by Service Assurance systems.
1265           required: false
1266           type: string
1267         - name: in-maint
1268           in: query
1269           required: false
1270           type: boolean
1271         - name: is-closed-loop-disabled
1272           in: query
1273           required: false
1274           type: boolean
1275   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/relationship-list/relationship:
1276     put:
1277       tags:
1278         - CloudInfrastructure
1279       summary: see node definition for valid relationships
1280       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship
1281       consumes:
1282         - application/json
1283         - application/xml
1284       produces:
1285         - application/json
1286         - application/xml
1287       responses:
1288         "default":
1289           description: Response codes found in [response codes](https://wiki.onap.org/).
1290       parameters:
1291         - name: cloud-owner
1292           in: path
1293           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1294           required: true
1295           type: string
1296           example: __CLOUD-OWNER__
1297         - name: cloud-region-id
1298           in: path
1299           description: Identifier used by the vendor for the region. Second part of composite key
1300           required: true
1301           type: string
1302           example: __CLOUD-REGION-ID__
1303         - name: tenant-id
1304           in: path
1305           description: Unique id relative to the cloud-region.
1306           required: true
1307           type: string
1308           example: __TENANT-ID__
1309         - name: vserver-id
1310           in: path
1311           description: Unique identifier for this vserver relative to its tenant
1312           required: true
1313           type: string
1314           example: __VSERVER-ID__
1315         - name: body
1316           in: body
1317           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json)
1318           required: true
1319           schema:
1320             $ref: "#/definitions/relationship"
1321     delete:
1322       tags:
1323         - CloudInfrastructure
1324       summary: delete an existing relationship
1325       description: delete an existing relationship
1326       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship
1327       consumes:
1328         - application/json
1329         - application/xml
1330       produces:
1331         - application/json
1332         - application/xml
1333       responses:
1334         "default":
1335           description: Response codes found in [response codes](https://wiki.onap.org/).
1336       parameters:
1337         - name: cloud-owner
1338           in: path
1339           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1340           required: true
1341           type: string
1342           example: __CLOUD-OWNER__
1343         - name: cloud-region-id
1344           in: path
1345           description: Identifier used by the vendor for the region. Second part of composite key
1346           required: true
1347           type: string
1348           example: __CLOUD-REGION-ID__
1349         - name: tenant-id
1350           in: path
1351           description: Unique id relative to the cloud-region.
1352           required: true
1353           type: string
1354           example: __TENANT-ID__
1355         - name: vserver-id
1356           in: path
1357           description: Unique identifier for this vserver relative to its tenant
1358           required: true
1359           type: string
1360           example: __VSERVER-ID__
1361   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
1362     put:
1363       tags:
1364         - CloudInfrastructure
1365       summary: see node definition for valid relationships
1366       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship
1367       consumes:
1368         - application/json
1369         - application/xml
1370       produces:
1371         - application/json
1372         - application/xml
1373       responses:
1374         "default":
1375           description: Response codes found in [response codes](https://wiki.onap.org/).
1376       parameters:
1377         - name: cloud-owner
1378           in: path
1379           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1380           required: true
1381           type: string
1382           example: __CLOUD-OWNER__
1383         - name: cloud-region-id
1384           in: path
1385           description: Identifier used by the vendor for the region. Second part of composite key
1386           required: true
1387           type: string
1388           example: __CLOUD-REGION-ID__
1389         - name: tenant-id
1390           in: path
1391           description: Unique id relative to the cloud-region.
1392           required: true
1393           type: string
1394           example: __TENANT-ID__
1395         - name: vserver-id
1396           in: path
1397           description: Unique identifier for this vserver relative to its tenant
1398           required: true
1399           type: string
1400           example: __VSERVER-ID__
1401         - name: interface-name
1402           in: path
1403           description: Name given to the interface
1404           required: true
1405           type: string
1406           example: __INTERFACE-NAME__
1407         - name: vlan-interface
1408           in: path
1409           description: String that identifies the interface
1410           required: true
1411           type: string
1412           example: __VLAN-INTERFACE__
1413         - name: body
1414           in: body
1415           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json)
1416           required: true
1417           schema:
1418             $ref: "#/definitions/relationship"
1419     delete:
1420       tags:
1421         - CloudInfrastructure
1422       summary: delete an existing relationship
1423       description: delete an existing relationship
1424       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship
1425       consumes:
1426         - application/json
1427         - application/xml
1428       produces:
1429         - application/json
1430         - application/xml
1431       responses:
1432         "default":
1433           description: Response codes found in [response codes](https://wiki.onap.org/).
1434       parameters:
1435         - name: cloud-owner
1436           in: path
1437           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1438           required: true
1439           type: string
1440           example: __CLOUD-OWNER__
1441         - name: cloud-region-id
1442           in: path
1443           description: Identifier used by the vendor for the region. Second part of composite key
1444           required: true
1445           type: string
1446           example: __CLOUD-REGION-ID__
1447         - name: tenant-id
1448           in: path
1449           description: Unique id relative to the cloud-region.
1450           required: true
1451           type: string
1452           example: __TENANT-ID__
1453         - name: vserver-id
1454           in: path
1455           description: Unique identifier for this vserver relative to its tenant
1456           required: true
1457           type: string
1458           example: __VSERVER-ID__
1459         - name: interface-name
1460           in: path
1461           description: Name given to the interface
1462           required: true
1463           type: string
1464           example: __INTERFACE-NAME__
1465         - name: vlan-interface
1466           in: path
1467           description: String that identifies the interface
1468           required: true
1469           type: string
1470           example: __VLAN-INTERFACE__
1471   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
1472     put:
1473       tags:
1474         - CloudInfrastructure
1475       summary: see node definition for valid relationships
1476       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
1477       consumes:
1478         - application/json
1479         - application/xml
1480       produces:
1481         - application/json
1482         - application/xml
1483       responses:
1484         "default":
1485           description: Response codes found in [response codes](https://wiki.onap.org/).
1486       parameters:
1487         - name: cloud-owner
1488           in: path
1489           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1490           required: true
1491           type: string
1492           example: __CLOUD-OWNER__
1493         - name: cloud-region-id
1494           in: path
1495           description: Identifier used by the vendor for the region. Second part of composite key
1496           required: true
1497           type: string
1498           example: __CLOUD-REGION-ID__
1499         - name: tenant-id
1500           in: path
1501           description: Unique id relative to the cloud-region.
1502           required: true
1503           type: string
1504           example: __TENANT-ID__
1505         - name: vserver-id
1506           in: path
1507           description: Unique identifier for this vserver relative to its tenant
1508           required: true
1509           type: string
1510           example: __VSERVER-ID__
1511         - name: interface-name
1512           in: path
1513           description: Name given to the interface
1514           required: true
1515           type: string
1516           example: __INTERFACE-NAME__
1517         - name: vlan-interface
1518           in: path
1519           description: String that identifies the interface
1520           required: true
1521           type: string
1522           example: __VLAN-INTERFACE__
1523         - name: l3-interface-ipv4-address
1524           in: path
1525           description: IP address
1526           required: true
1527           type: string
1528           example: __L3-INTERFACE-IPV4-ADDRESS__
1529         - name: body
1530           in: body
1531           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
1532           required: true
1533           schema:
1534             $ref: "#/definitions/relationship"
1535     delete:
1536       tags:
1537         - CloudInfrastructure
1538       summary: delete an existing relationship
1539       description: delete an existing relationship
1540       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
1541       consumes:
1542         - application/json
1543         - application/xml
1544       produces:
1545         - application/json
1546         - application/xml
1547       responses:
1548         "default":
1549           description: Response codes found in [response codes](https://wiki.onap.org/).
1550       parameters:
1551         - name: cloud-owner
1552           in: path
1553           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1554           required: true
1555           type: string
1556           example: __CLOUD-OWNER__
1557         - name: cloud-region-id
1558           in: path
1559           description: Identifier used by the vendor for the region. Second part of composite key
1560           required: true
1561           type: string
1562           example: __CLOUD-REGION-ID__
1563         - name: tenant-id
1564           in: path
1565           description: Unique id relative to the cloud-region.
1566           required: true
1567           type: string
1568           example: __TENANT-ID__
1569         - name: vserver-id
1570           in: path
1571           description: Unique identifier for this vserver relative to its tenant
1572           required: true
1573           type: string
1574           example: __VSERVER-ID__
1575         - name: interface-name
1576           in: path
1577           description: Name given to the interface
1578           required: true
1579           type: string
1580           example: __INTERFACE-NAME__
1581         - name: vlan-interface
1582           in: path
1583           description: String that identifies the interface
1584           required: true
1585           type: string
1586           example: __VLAN-INTERFACE__
1587         - name: l3-interface-ipv4-address
1588           in: path
1589           description: IP address
1590           required: true
1591           type: string
1592           example: __L3-INTERFACE-IPV4-ADDRESS__
1593   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
1594     get:
1595       tags:
1596         - CloudInfrastructure
1597       summary: returns l3-interface-ipv4-address-list
1598       description: returns l3-interface-ipv4-address-list
1599       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
1600       produces:
1601         - application/json
1602         - application/xml
1603       responses:
1604         "200":
1605           description: successful operation
1606           schema:
1607               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
1608         "default":
1609           description: Response codes found in [response codes](https://wiki.onap.org/).
1610       parameters:
1611         - name: cloud-owner
1612           in: path
1613           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1614           required: true
1615           type: string
1616           example: __CLOUD-OWNER__
1617         - name: cloud-region-id
1618           in: path
1619           description: Identifier used by the vendor for the region. Second part of composite key
1620           required: true
1621           type: string
1622           example: __CLOUD-REGION-ID__
1623         - name: tenant-id
1624           in: path
1625           description: Unique id relative to the cloud-region.
1626           required: true
1627           type: string
1628           example: __TENANT-ID__
1629         - name: vserver-id
1630           in: path
1631           description: Unique identifier for this vserver relative to its tenant
1632           required: true
1633           type: string
1634           example: __VSERVER-ID__
1635         - name: interface-name
1636           in: path
1637           description: Name given to the interface
1638           required: true
1639           type: string
1640           example: __INTERFACE-NAME__
1641         - name: vlan-interface
1642           in: path
1643           description: String that identifies the interface
1644           required: true
1645           type: string
1646           example: __VLAN-INTERFACE__
1647         - name: l3-interface-ipv4-address
1648           in: path
1649           description: IP address
1650           required: true
1651           type: string
1652           example: __L3-INTERFACE-IPV4-ADDRESS__
1653         - name: cloud-type
1654           in: query
1655           description: Type of the cloud (e.g., openstack)
1656           required: false
1657           type: string
1658         - name: owner-defined-type
1659           in: query
1660           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
1661           required: false
1662           type: string
1663         - name: tenant-name
1664           in: query
1665           description: Readable name of tenant
1666           required: false
1667           type: string
1668         - name: vserver-name
1669           in: query
1670           description: Name of vserver
1671           required: false
1672           type: string
1673         - name: vserver-name2
1674           in: query
1675           description: Alternative name of vserver
1676           required: false
1677           type: string
1678         - name: prov-status
1679           in: query
1680           description: Trigger for operational monitoring of this resource by Service Assurance systems.
1681           required: false
1682           type: string
1683         - name: in-maint
1684           in: query
1685           required: false
1686           type: boolean
1687         - name: is-closed-loop-disabled
1688           in: query
1689           required: false
1690           type: boolean
1691         - name: interface-id
1692           in: query
1693           description: ID of interface
1694           required: false
1695           type: string
1696         - name: macaddr
1697           in: query
1698           description: MAC address for the interface
1699           required: false
1700           type: string
1701         - name: network-name
1702           in: query
1703           description: Name of the network
1704           required: false
1705           type: string
1706         - name: vlan-id-inner
1707           in: query
1708           description: Inner VLAN tag
1709           required: false
1710           type: integer
1711           format: int64
1712         - name: vpn-id
1713           in: query
1714           description: This indicates the customers VPN ID associated with this vlan
1715           required: false
1716           type: string
1717         - name: vlan-id-inner
1718           in: query
1719           description: Inner VLAN tag
1720           required: false
1721           type: integer
1722           format: int64
1723         - name: neutron-network-id
1724           in: query
1725           description: Neutron network id of the interface that address belongs to
1726           required: false
1727           type: string
1728         - name: neutron-subnet-id
1729           in: query
1730           description: Neutron id of subnet that address belongs to
1731           required: false
1732           type: string
1733     put:
1734       tags:
1735         - CloudInfrastructure
1736       summary: create or update an existing l3-interface-ipv4-address-list
1737       description: |
1738         Create or update an existing l3-interface-ipv4-address-list.
1739         #
1740         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
1741       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
1742       consumes:
1743         - application/json
1744         - application/xml
1745       produces:
1746         - application/json
1747         - application/xml
1748       responses:
1749         "default":
1750           description: Response codes found in [response codes](https://wiki.onap.org/).
1751       parameters:
1752         - name: cloud-owner
1753           in: path
1754           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1755           required: true
1756           type: string
1757           example: __CLOUD-OWNER__
1758         - name: cloud-region-id
1759           in: path
1760           description: Identifier used by the vendor for the region. Second part of composite key
1761           required: true
1762           type: string
1763           example: __CLOUD-REGION-ID__
1764         - name: tenant-id
1765           in: path
1766           description: Unique id relative to the cloud-region.
1767           required: true
1768           type: string
1769           example: __TENANT-ID__
1770         - name: vserver-id
1771           in: path
1772           description: Unique identifier for this vserver relative to its tenant
1773           required: true
1774           type: string
1775           example: __VSERVER-ID__
1776         - name: interface-name
1777           in: path
1778           description: Name given to the interface
1779           required: true
1780           type: string
1781           example: __INTERFACE-NAME__
1782         - name: vlan-interface
1783           in: path
1784           description: String that identifies the interface
1785           required: true
1786           type: string
1787           example: __VLAN-INTERFACE__
1788         - name: l3-interface-ipv4-address
1789           in: path
1790           description: IP address
1791           required: true
1792           type: string
1793           example: __L3-INTERFACE-IPV4-ADDRESS__
1794         - name: body
1795           in: body
1796           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
1797           required: true
1798           schema:
1799             $ref: "#/definitions/l3-interface-ipv4-address-list"
1800     patch:
1801       tags:
1802         - CloudInfrastructure
1803       summary: update an existing l3-interface-ipv4-address-list
1804       description: |
1805         Update an existing l3-interface-ipv4-address-list
1806         #
1807         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
1808         The PUT operation will entirely replace an existing object.
1809         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
1810         #
1811         Other differences between PUT and PATCH are:
1812         #
1813         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
1814         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
1815         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
1816       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
1817       consumes:
1818         - application/json
1819         - application/xml
1820       produces:
1821         - application/json
1822         - application/xml
1823       responses:
1824         "default":
1825           description: Response codes found in [response codes](https://wiki.onap.org/).
1826       parameters:
1827         - name: cloud-owner
1828           in: path
1829           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1830           required: true
1831           type: string
1832           example: __CLOUD-OWNER__
1833         - name: cloud-region-id
1834           in: path
1835           description: Identifier used by the vendor for the region. Second part of composite key
1836           required: true
1837           type: string
1838           example: __CLOUD-REGION-ID__
1839         - name: tenant-id
1840           in: path
1841           description: Unique id relative to the cloud-region.
1842           required: true
1843           type: string
1844           example: __TENANT-ID__
1845         - name: vserver-id
1846           in: path
1847           description: Unique identifier for this vserver relative to its tenant
1848           required: true
1849           type: string
1850           example: __VSERVER-ID__
1851         - name: interface-name
1852           in: path
1853           description: Name given to the interface
1854           required: true
1855           type: string
1856           example: __INTERFACE-NAME__
1857         - name: vlan-interface
1858           in: path
1859           description: String that identifies the interface
1860           required: true
1861           type: string
1862           example: __VLAN-INTERFACE__
1863         - name: l3-interface-ipv4-address
1864           in: path
1865           description: IP address
1866           required: true
1867           type: string
1868           example: __L3-INTERFACE-IPV4-ADDRESS__
1869         - name: body
1870           in: body
1871           description: l3-interface-ipv4-address-list object that needs to be created or updated.
1872           required: true
1873           schema:
1874             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
1875     delete:
1876       tags:
1877         - CloudInfrastructure
1878       summary: delete an existing l3-interface-ipv4-address-list
1879       description: delete an existing l3-interface-ipv4-address-list
1880       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
1881       consumes:
1882         - application/json
1883         - application/xml
1884       produces:
1885         - application/json
1886         - application/xml
1887       responses:
1888         "default":
1889           description: Response codes found in [response codes](https://wiki.onap.org/).
1890       parameters:
1891         - name: cloud-owner
1892           in: path
1893           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1894           required: true
1895           type: string
1896           example: __CLOUD-OWNER__
1897         - name: cloud-region-id
1898           in: path
1899           description: Identifier used by the vendor for the region. Second part of composite key
1900           required: true
1901           type: string
1902           example: __CLOUD-REGION-ID__
1903         - name: tenant-id
1904           in: path
1905           description: Unique id relative to the cloud-region.
1906           required: true
1907           type: string
1908           example: __TENANT-ID__
1909         - name: vserver-id
1910           in: path
1911           description: Unique identifier for this vserver relative to its tenant
1912           required: true
1913           type: string
1914           example: __VSERVER-ID__
1915         - name: interface-name
1916           in: path
1917           description: Name given to the interface
1918           required: true
1919           type: string
1920           example: __INTERFACE-NAME__
1921         - name: vlan-interface
1922           in: path
1923           description: String that identifies the interface
1924           required: true
1925           type: string
1926           example: __VLAN-INTERFACE__
1927         - name: l3-interface-ipv4-address
1928           in: path
1929           description: IP address
1930           required: true
1931           type: string
1932           example: __L3-INTERFACE-IPV4-ADDRESS__
1933         - name: resource-version
1934           in: query
1935           description: resource-version for concurrency
1936           required: true
1937           type: string
1938   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
1939     put:
1940       tags:
1941         - CloudInfrastructure
1942       summary: see node definition for valid relationships
1943       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
1944       consumes:
1945         - application/json
1946         - application/xml
1947       produces:
1948         - application/json
1949         - application/xml
1950       responses:
1951         "default":
1952           description: Response codes found in [response codes](https://wiki.onap.org/).
1953       parameters:
1954         - name: cloud-owner
1955           in: path
1956           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1957           required: true
1958           type: string
1959           example: __CLOUD-OWNER__
1960         - name: cloud-region-id
1961           in: path
1962           description: Identifier used by the vendor for the region. Second part of composite key
1963           required: true
1964           type: string
1965           example: __CLOUD-REGION-ID__
1966         - name: tenant-id
1967           in: path
1968           description: Unique id relative to the cloud-region.
1969           required: true
1970           type: string
1971           example: __TENANT-ID__
1972         - name: vserver-id
1973           in: path
1974           description: Unique identifier for this vserver relative to its tenant
1975           required: true
1976           type: string
1977           example: __VSERVER-ID__
1978         - name: interface-name
1979           in: path
1980           description: Name given to the interface
1981           required: true
1982           type: string
1983           example: __INTERFACE-NAME__
1984         - name: vlan-interface
1985           in: path
1986           description: String that identifies the interface
1987           required: true
1988           type: string
1989           example: __VLAN-INTERFACE__
1990         - name: l3-interface-ipv6-address
1991           in: path
1992           description: IP address
1993           required: true
1994           type: string
1995           example: __L3-INTERFACE-IPV6-ADDRESS__
1996         - name: body
1997           in: body
1998           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
1999           required: true
2000           schema:
2001             $ref: "#/definitions/relationship"
2002     delete:
2003       tags:
2004         - CloudInfrastructure
2005       summary: delete an existing relationship
2006       description: delete an existing relationship
2007       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
2008       consumes:
2009         - application/json
2010         - application/xml
2011       produces:
2012         - application/json
2013         - application/xml
2014       responses:
2015         "default":
2016           description: Response codes found in [response codes](https://wiki.onap.org/).
2017       parameters:
2018         - name: cloud-owner
2019           in: path
2020           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2021           required: true
2022           type: string
2023           example: __CLOUD-OWNER__
2024         - name: cloud-region-id
2025           in: path
2026           description: Identifier used by the vendor for the region. Second part of composite key
2027           required: true
2028           type: string
2029           example: __CLOUD-REGION-ID__
2030         - name: tenant-id
2031           in: path
2032           description: Unique id relative to the cloud-region.
2033           required: true
2034           type: string
2035           example: __TENANT-ID__
2036         - name: vserver-id
2037           in: path
2038           description: Unique identifier for this vserver relative to its tenant
2039           required: true
2040           type: string
2041           example: __VSERVER-ID__
2042         - name: interface-name
2043           in: path
2044           description: Name given to the interface
2045           required: true
2046           type: string
2047           example: __INTERFACE-NAME__
2048         - name: vlan-interface
2049           in: path
2050           description: String that identifies the interface
2051           required: true
2052           type: string
2053           example: __VLAN-INTERFACE__
2054         - name: l3-interface-ipv6-address
2055           in: path
2056           description: IP address
2057           required: true
2058           type: string
2059           example: __L3-INTERFACE-IPV6-ADDRESS__
2060   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
2061     get:
2062       tags:
2063         - CloudInfrastructure
2064       summary: returns l3-interface-ipv6-address-list
2065       description: returns l3-interface-ipv6-address-list
2066       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
2067       produces:
2068         - application/json
2069         - application/xml
2070       responses:
2071         "200":
2072           description: successful operation
2073           schema:
2074               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
2075         "default":
2076           description: Response codes found in [response codes](https://wiki.onap.org/).
2077       parameters:
2078         - name: cloud-owner
2079           in: path
2080           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2081           required: true
2082           type: string
2083           example: __CLOUD-OWNER__
2084         - name: cloud-region-id
2085           in: path
2086           description: Identifier used by the vendor for the region. Second part of composite key
2087           required: true
2088           type: string
2089           example: __CLOUD-REGION-ID__
2090         - name: tenant-id
2091           in: path
2092           description: Unique id relative to the cloud-region.
2093           required: true
2094           type: string
2095           example: __TENANT-ID__
2096         - name: vserver-id
2097           in: path
2098           description: Unique identifier for this vserver relative to its tenant
2099           required: true
2100           type: string
2101           example: __VSERVER-ID__
2102         - name: interface-name
2103           in: path
2104           description: Name given to the interface
2105           required: true
2106           type: string
2107           example: __INTERFACE-NAME__
2108         - name: vlan-interface
2109           in: path
2110           description: String that identifies the interface
2111           required: true
2112           type: string
2113           example: __VLAN-INTERFACE__
2114         - name: l3-interface-ipv6-address
2115           in: path
2116           description: IP address
2117           required: true
2118           type: string
2119           example: __L3-INTERFACE-IPV6-ADDRESS__
2120         - name: cloud-type
2121           in: query
2122           description: Type of the cloud (e.g., openstack)
2123           required: false
2124           type: string
2125         - name: owner-defined-type
2126           in: query
2127           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
2128           required: false
2129           type: string
2130         - name: tenant-name
2131           in: query
2132           description: Readable name of tenant
2133           required: false
2134           type: string
2135         - name: vserver-name
2136           in: query
2137           description: Name of vserver
2138           required: false
2139           type: string
2140         - name: vserver-name2
2141           in: query
2142           description: Alternative name of vserver
2143           required: false
2144           type: string
2145         - name: prov-status
2146           in: query
2147           description: Trigger for operational monitoring of this resource by Service Assurance systems.
2148           required: false
2149           type: string
2150         - name: in-maint
2151           in: query
2152           required: false
2153           type: boolean
2154         - name: is-closed-loop-disabled
2155           in: query
2156           required: false
2157           type: boolean
2158         - name: interface-id
2159           in: query
2160           description: ID of interface
2161           required: false
2162           type: string
2163         - name: macaddr
2164           in: query
2165           description: MAC address for the interface
2166           required: false
2167           type: string
2168         - name: network-name
2169           in: query
2170           description: Name of the network
2171           required: false
2172           type: string
2173         - name: vlan-id-inner
2174           in: query
2175           description: Inner VLAN tag
2176           required: false
2177           type: integer
2178           format: int64
2179         - name: vpn-id
2180           in: query
2181           description: This indicates the customers VPN ID associated with this vlan
2182           required: false
2183           type: string
2184         - name: vlan-id-inner
2185           in: query
2186           description: Inner VLAN tag
2187           required: false
2188           type: integer
2189           format: int64
2190         - name: neutron-network-id
2191           in: query
2192           description: Neutron network id of the interface that address belongs to
2193           required: false
2194           type: string
2195         - name: neutron-subnet-id
2196           in: query
2197           description: Neutron id of subnet that address belongs to
2198           required: false
2199           type: string
2200     put:
2201       tags:
2202         - CloudInfrastructure
2203       summary: create or update an existing l3-interface-ipv6-address-list
2204       description: |
2205         Create or update an existing l3-interface-ipv6-address-list.
2206         #
2207         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
2208       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
2209       consumes:
2210         - application/json
2211         - application/xml
2212       produces:
2213         - application/json
2214         - application/xml
2215       responses:
2216         "default":
2217           description: Response codes found in [response codes](https://wiki.onap.org/).
2218       parameters:
2219         - name: cloud-owner
2220           in: path
2221           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2222           required: true
2223           type: string
2224           example: __CLOUD-OWNER__
2225         - name: cloud-region-id
2226           in: path
2227           description: Identifier used by the vendor for the region. Second part of composite key
2228           required: true
2229           type: string
2230           example: __CLOUD-REGION-ID__
2231         - name: tenant-id
2232           in: path
2233           description: Unique id relative to the cloud-region.
2234           required: true
2235           type: string
2236           example: __TENANT-ID__
2237         - name: vserver-id
2238           in: path
2239           description: Unique identifier for this vserver relative to its tenant
2240           required: true
2241           type: string
2242           example: __VSERVER-ID__
2243         - name: interface-name
2244           in: path
2245           description: Name given to the interface
2246           required: true
2247           type: string
2248           example: __INTERFACE-NAME__
2249         - name: vlan-interface
2250           in: path
2251           description: String that identifies the interface
2252           required: true
2253           type: string
2254           example: __VLAN-INTERFACE__
2255         - name: l3-interface-ipv6-address
2256           in: path
2257           description: IP address
2258           required: true
2259           type: string
2260           example: __L3-INTERFACE-IPV6-ADDRESS__
2261         - name: body
2262           in: body
2263           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
2264           required: true
2265           schema:
2266             $ref: "#/definitions/l3-interface-ipv6-address-list"
2267     patch:
2268       tags:
2269         - CloudInfrastructure
2270       summary: update an existing l3-interface-ipv6-address-list
2271       description: |
2272         Update an existing l3-interface-ipv6-address-list
2273         #
2274         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
2275         The PUT operation will entirely replace an existing object.
2276         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
2277         #
2278         Other differences between PUT and PATCH are:
2279         #
2280         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
2281         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
2282         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
2283       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
2284       consumes:
2285         - application/json
2286         - application/xml
2287       produces:
2288         - application/json
2289         - application/xml
2290       responses:
2291         "default":
2292           description: Response codes found in [response codes](https://wiki.onap.org/).
2293       parameters:
2294         - name: cloud-owner
2295           in: path
2296           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2297           required: true
2298           type: string
2299           example: __CLOUD-OWNER__
2300         - name: cloud-region-id
2301           in: path
2302           description: Identifier used by the vendor for the region. Second part of composite key
2303           required: true
2304           type: string
2305           example: __CLOUD-REGION-ID__
2306         - name: tenant-id
2307           in: path
2308           description: Unique id relative to the cloud-region.
2309           required: true
2310           type: string
2311           example: __TENANT-ID__
2312         - name: vserver-id
2313           in: path
2314           description: Unique identifier for this vserver relative to its tenant
2315           required: true
2316           type: string
2317           example: __VSERVER-ID__
2318         - name: interface-name
2319           in: path
2320           description: Name given to the interface
2321           required: true
2322           type: string
2323           example: __INTERFACE-NAME__
2324         - name: vlan-interface
2325           in: path
2326           description: String that identifies the interface
2327           required: true
2328           type: string
2329           example: __VLAN-INTERFACE__
2330         - name: l3-interface-ipv6-address
2331           in: path
2332           description: IP address
2333           required: true
2334           type: string
2335           example: __L3-INTERFACE-IPV6-ADDRESS__
2336         - name: body
2337           in: body
2338           description: l3-interface-ipv6-address-list object that needs to be created or updated.
2339           required: true
2340           schema:
2341             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
2342     delete:
2343       tags:
2344         - CloudInfrastructure
2345       summary: delete an existing l3-interface-ipv6-address-list
2346       description: delete an existing l3-interface-ipv6-address-list
2347       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
2348       consumes:
2349         - application/json
2350         - application/xml
2351       produces:
2352         - application/json
2353         - application/xml
2354       responses:
2355         "default":
2356           description: Response codes found in [response codes](https://wiki.onap.org/).
2357       parameters:
2358         - name: cloud-owner
2359           in: path
2360           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2361           required: true
2362           type: string
2363           example: __CLOUD-OWNER__
2364         - name: cloud-region-id
2365           in: path
2366           description: Identifier used by the vendor for the region. Second part of composite key
2367           required: true
2368           type: string
2369           example: __CLOUD-REGION-ID__
2370         - name: tenant-id
2371           in: path
2372           description: Unique id relative to the cloud-region.
2373           required: true
2374           type: string
2375           example: __TENANT-ID__
2376         - name: vserver-id
2377           in: path
2378           description: Unique identifier for this vserver relative to its tenant
2379           required: true
2380           type: string
2381           example: __VSERVER-ID__
2382         - name: interface-name
2383           in: path
2384           description: Name given to the interface
2385           required: true
2386           type: string
2387           example: __INTERFACE-NAME__
2388         - name: vlan-interface
2389           in: path
2390           description: String that identifies the interface
2391           required: true
2392           type: string
2393           example: __VLAN-INTERFACE__
2394         - name: l3-interface-ipv6-address
2395           in: path
2396           description: IP address
2397           required: true
2398           type: string
2399           example: __L3-INTERFACE-IPV6-ADDRESS__
2400         - name: resource-version
2401           in: query
2402           description: resource-version for concurrency
2403           required: true
2404           type: string
2405   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
2406     get:
2407       tags:
2408         - CloudInfrastructure
2409       summary: returns vlan
2410       description: returns vlan
2411       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan
2412       produces:
2413         - application/json
2414         - application/xml
2415       responses:
2416         "200":
2417           description: successful operation
2418           schema:
2419               $ref: "#/getDefinitions/vlan"
2420         "default":
2421           description: Response codes found in [response codes](https://wiki.onap.org/).
2422       parameters:
2423         - name: cloud-owner
2424           in: path
2425           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2426           required: true
2427           type: string
2428           example: __CLOUD-OWNER__
2429         - name: cloud-region-id
2430           in: path
2431           description: Identifier used by the vendor for the region. Second part of composite key
2432           required: true
2433           type: string
2434           example: __CLOUD-REGION-ID__
2435         - name: tenant-id
2436           in: path
2437           description: Unique id relative to the cloud-region.
2438           required: true
2439           type: string
2440           example: __TENANT-ID__
2441         - name: vserver-id
2442           in: path
2443           description: Unique identifier for this vserver relative to its tenant
2444           required: true
2445           type: string
2446           example: __VSERVER-ID__
2447         - name: interface-name
2448           in: path
2449           description: Name given to the interface
2450           required: true
2451           type: string
2452           example: __INTERFACE-NAME__
2453         - name: vlan-interface
2454           in: path
2455           description: String that identifies the interface
2456           required: true
2457           type: string
2458           example: __VLAN-INTERFACE__
2459         - name: cloud-type
2460           in: query
2461           description: Type of the cloud (e.g., openstack)
2462           required: false
2463           type: string
2464         - name: owner-defined-type
2465           in: query
2466           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
2467           required: false
2468           type: string
2469         - name: tenant-name
2470           in: query
2471           description: Readable name of tenant
2472           required: false
2473           type: string
2474         - name: vserver-name
2475           in: query
2476           description: Name of vserver
2477           required: false
2478           type: string
2479         - name: vserver-name2
2480           in: query
2481           description: Alternative name of vserver
2482           required: false
2483           type: string
2484         - name: prov-status
2485           in: query
2486           description: Trigger for operational monitoring of this resource by Service Assurance systems.
2487           required: false
2488           type: string
2489         - name: in-maint
2490           in: query
2491           required: false
2492           type: boolean
2493         - name: is-closed-loop-disabled
2494           in: query
2495           required: false
2496           type: boolean
2497         - name: interface-id
2498           in: query
2499           description: ID of interface
2500           required: false
2501           type: string
2502         - name: macaddr
2503           in: query
2504           description: MAC address for the interface
2505           required: false
2506           type: string
2507         - name: network-name
2508           in: query
2509           description: Name of the network
2510           required: false
2511           type: string
2512         - name: vlan-id-inner
2513           in: query
2514           description: Inner VLAN tag
2515           required: false
2516           type: integer
2517           format: int64
2518         - name: vpn-id
2519           in: query
2520           description: This indicates the customers VPN ID associated with this vlan
2521           required: false
2522           type: string
2523     put:
2524       tags:
2525         - CloudInfrastructure
2526       summary: create or update an existing vlan
2527       description: |
2528         Create or update an existing vlan.
2529         #
2530         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
2531       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan
2532       consumes:
2533         - application/json
2534         - application/xml
2535       produces:
2536         - application/json
2537         - application/xml
2538       responses:
2539         "default":
2540           description: Response codes found in [response codes](https://wiki.onap.org/).
2541       parameters:
2542         - name: cloud-owner
2543           in: path
2544           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2545           required: true
2546           type: string
2547           example: __CLOUD-OWNER__
2548         - name: cloud-region-id
2549           in: path
2550           description: Identifier used by the vendor for the region. Second part of composite key
2551           required: true
2552           type: string
2553           example: __CLOUD-REGION-ID__
2554         - name: tenant-id
2555           in: path
2556           description: Unique id relative to the cloud-region.
2557           required: true
2558           type: string
2559           example: __TENANT-ID__
2560         - name: vserver-id
2561           in: path
2562           description: Unique identifier for this vserver relative to its tenant
2563           required: true
2564           type: string
2565           example: __VSERVER-ID__
2566         - name: interface-name
2567           in: path
2568           description: Name given to the interface
2569           required: true
2570           type: string
2571           example: __INTERFACE-NAME__
2572         - name: vlan-interface
2573           in: path
2574           description: String that identifies the interface
2575           required: true
2576           type: string
2577           example: __VLAN-INTERFACE__
2578         - name: body
2579           in: body
2580           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json)
2581           required: true
2582           schema:
2583             $ref: "#/definitions/vlan"
2584     patch:
2585       tags:
2586         - CloudInfrastructure
2587       summary: update an existing vlan
2588       description: |
2589         Update an existing vlan
2590         #
2591         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
2592         The PUT operation will entirely replace an existing object.
2593         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
2594         #
2595         Other differences between PUT and PATCH are:
2596         #
2597         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
2598         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
2599         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
2600       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan
2601       consumes:
2602         - application/json
2603         - application/xml
2604       produces:
2605         - application/json
2606         - application/xml
2607       responses:
2608         "default":
2609           description: Response codes found in [response codes](https://wiki.onap.org/).
2610       parameters:
2611         - name: cloud-owner
2612           in: path
2613           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2614           required: true
2615           type: string
2616           example: __CLOUD-OWNER__
2617         - name: cloud-region-id
2618           in: path
2619           description: Identifier used by the vendor for the region. Second part of composite key
2620           required: true
2621           type: string
2622           example: __CLOUD-REGION-ID__
2623         - name: tenant-id
2624           in: path
2625           description: Unique id relative to the cloud-region.
2626           required: true
2627           type: string
2628           example: __TENANT-ID__
2629         - name: vserver-id
2630           in: path
2631           description: Unique identifier for this vserver relative to its tenant
2632           required: true
2633           type: string
2634           example: __VSERVER-ID__
2635         - name: interface-name
2636           in: path
2637           description: Name given to the interface
2638           required: true
2639           type: string
2640           example: __INTERFACE-NAME__
2641         - name: vlan-interface
2642           in: path
2643           description: String that identifies the interface
2644           required: true
2645           type: string
2646           example: __VLAN-INTERFACE__
2647         - name: body
2648           in: body
2649           description: vlan object that needs to be created or updated.
2650           required: true
2651           schema:
2652             $ref: "#/patchDefinitions/vlan"
2653     delete:
2654       tags:
2655         - CloudInfrastructure
2656       summary: delete an existing vlan
2657       description: delete an existing vlan
2658       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan
2659       consumes:
2660         - application/json
2661         - application/xml
2662       produces:
2663         - application/json
2664         - application/xml
2665       responses:
2666         "default":
2667           description: Response codes found in [response codes](https://wiki.onap.org/).
2668       parameters:
2669         - name: cloud-owner
2670           in: path
2671           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2672           required: true
2673           type: string
2674           example: __CLOUD-OWNER__
2675         - name: cloud-region-id
2676           in: path
2677           description: Identifier used by the vendor for the region. Second part of composite key
2678           required: true
2679           type: string
2680           example: __CLOUD-REGION-ID__
2681         - name: tenant-id
2682           in: path
2683           description: Unique id relative to the cloud-region.
2684           required: true
2685           type: string
2686           example: __TENANT-ID__
2687         - name: vserver-id
2688           in: path
2689           description: Unique identifier for this vserver relative to its tenant
2690           required: true
2691           type: string
2692           example: __VSERVER-ID__
2693         - name: interface-name
2694           in: path
2695           description: Name given to the interface
2696           required: true
2697           type: string
2698           example: __INTERFACE-NAME__
2699         - name: vlan-interface
2700           in: path
2701           description: String that identifies the interface
2702           required: true
2703           type: string
2704           example: __VLAN-INTERFACE__
2705         - name: resource-version
2706           in: query
2707           description: resource-version for concurrency
2708           required: true
2709           type: string
2710   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans:
2711     get:
2712       tags:
2713         - CloudInfrastructure
2714       summary: returns vlans
2715       description: returns vlans
2716       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlans
2717       produces:
2718         - application/json
2719         - application/xml
2720       responses:
2721         "200":
2722           description: successful operation
2723           schema:
2724               $ref: "#/getDefinitions/vlans"
2725         "default":
2726           description: Response codes found in [response codes](https://wiki.onap.org/).
2727       parameters:
2728         - name: cloud-owner
2729           in: path
2730           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2731           required: true
2732           type: string
2733           example: __CLOUD-OWNER__
2734         - name: cloud-region-id
2735           in: path
2736           description: Identifier used by the vendor for the region. Second part of composite key
2737           required: true
2738           type: string
2739           example: __CLOUD-REGION-ID__
2740         - name: tenant-id
2741           in: path
2742           description: Unique id relative to the cloud-region.
2743           required: true
2744           type: string
2745           example: __TENANT-ID__
2746         - name: vserver-id
2747           in: path
2748           description: Unique identifier for this vserver relative to its tenant
2749           required: true
2750           type: string
2751           example: __VSERVER-ID__
2752         - name: interface-name
2753           in: path
2754           description: Name given to the interface
2755           required: true
2756           type: string
2757           example: __INTERFACE-NAME__
2758         - name: cloud-type
2759           in: query
2760           description: Type of the cloud (e.g., openstack)
2761           required: false
2762           type: string
2763         - name: owner-defined-type
2764           in: query
2765           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
2766           required: false
2767           type: string
2768         - name: tenant-name
2769           in: query
2770           description: Readable name of tenant
2771           required: false
2772           type: string
2773         - name: vserver-name
2774           in: query
2775           description: Name of vserver
2776           required: false
2777           type: string
2778         - name: vserver-name2
2779           in: query
2780           description: Alternative name of vserver
2781           required: false
2782           type: string
2783         - name: prov-status
2784           in: query
2785           description: Trigger for operational monitoring of this resource by Service Assurance systems.
2786           required: false
2787           type: string
2788         - name: in-maint
2789           in: query
2790           required: false
2791           type: boolean
2792         - name: is-closed-loop-disabled
2793           in: query
2794           required: false
2795           type: boolean
2796         - name: interface-id
2797           in: query
2798           description: ID of interface
2799           required: false
2800           type: string
2801         - name: macaddr
2802           in: query
2803           description: MAC address for the interface
2804           required: false
2805           type: string
2806         - name: network-name
2807           in: query
2808           description: Name of the network
2809           required: false
2810           type: string
2811   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
2812     put:
2813       tags:
2814         - CloudInfrastructure
2815       summary: see node definition for valid relationships
2816       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
2817       consumes:
2818         - application/json
2819         - application/xml
2820       produces:
2821         - application/json
2822         - application/xml
2823       responses:
2824         "default":
2825           description: Response codes found in [response codes](https://wiki.onap.org/).
2826       parameters:
2827         - name: cloud-owner
2828           in: path
2829           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2830           required: true
2831           type: string
2832           example: __CLOUD-OWNER__
2833         - name: cloud-region-id
2834           in: path
2835           description: Identifier used by the vendor for the region. Second part of composite key
2836           required: true
2837           type: string
2838           example: __CLOUD-REGION-ID__
2839         - name: tenant-id
2840           in: path
2841           description: Unique id relative to the cloud-region.
2842           required: true
2843           type: string
2844           example: __TENANT-ID__
2845         - name: vserver-id
2846           in: path
2847           description: Unique identifier for this vserver relative to its tenant
2848           required: true
2849           type: string
2850           example: __VSERVER-ID__
2851         - name: interface-name
2852           in: path
2853           description: Name given to the interface
2854           required: true
2855           type: string
2856           example: __INTERFACE-NAME__
2857         - name: pci-id
2858           in: path
2859           description: PCI ID used to identify the sriov-vf
2860           required: true
2861           type: string
2862           example: __PCI-ID__
2863         - name: body
2864           in: body
2865           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json)
2866           required: true
2867           schema:
2868             $ref: "#/definitions/relationship"
2869     delete:
2870       tags:
2871         - CloudInfrastructure
2872       summary: delete an existing relationship
2873       description: delete an existing relationship
2874       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
2875       consumes:
2876         - application/json
2877         - application/xml
2878       produces:
2879         - application/json
2880         - application/xml
2881       responses:
2882         "default":
2883           description: Response codes found in [response codes](https://wiki.onap.org/).
2884       parameters:
2885         - name: cloud-owner
2886           in: path
2887           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2888           required: true
2889           type: string
2890           example: __CLOUD-OWNER__
2891         - name: cloud-region-id
2892           in: path
2893           description: Identifier used by the vendor for the region. Second part of composite key
2894           required: true
2895           type: string
2896           example: __CLOUD-REGION-ID__
2897         - name: tenant-id
2898           in: path
2899           description: Unique id relative to the cloud-region.
2900           required: true
2901           type: string
2902           example: __TENANT-ID__
2903         - name: vserver-id
2904           in: path
2905           description: Unique identifier for this vserver relative to its tenant
2906           required: true
2907           type: string
2908           example: __VSERVER-ID__
2909         - name: interface-name
2910           in: path
2911           description: Name given to the interface
2912           required: true
2913           type: string
2914           example: __INTERFACE-NAME__
2915         - name: pci-id
2916           in: path
2917           description: PCI ID used to identify the sriov-vf
2918           required: true
2919           type: string
2920           example: __PCI-ID__
2921   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
2922     get:
2923       tags:
2924         - CloudInfrastructure
2925       summary: returns sriov-vf
2926       description: returns sriov-vf
2927       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf
2928       produces:
2929         - application/json
2930         - application/xml
2931       responses:
2932         "200":
2933           description: successful operation
2934           schema:
2935               $ref: "#/getDefinitions/sriov-vf"
2936         "default":
2937           description: Response codes found in [response codes](https://wiki.onap.org/).
2938       parameters:
2939         - name: cloud-owner
2940           in: path
2941           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2942           required: true
2943           type: string
2944           example: __CLOUD-OWNER__
2945         - name: cloud-region-id
2946           in: path
2947           description: Identifier used by the vendor for the region. Second part of composite key
2948           required: true
2949           type: string
2950           example: __CLOUD-REGION-ID__
2951         - name: tenant-id
2952           in: path
2953           description: Unique id relative to the cloud-region.
2954           required: true
2955           type: string
2956           example: __TENANT-ID__
2957         - name: vserver-id
2958           in: path
2959           description: Unique identifier for this vserver relative to its tenant
2960           required: true
2961           type: string
2962           example: __VSERVER-ID__
2963         - name: interface-name
2964           in: path
2965           description: Name given to the interface
2966           required: true
2967           type: string
2968           example: __INTERFACE-NAME__
2969         - name: pci-id
2970           in: path
2971           description: PCI ID used to identify the sriov-vf
2972           required: true
2973           type: string
2974           example: __PCI-ID__
2975         - name: cloud-type
2976           in: query
2977           description: Type of the cloud (e.g., openstack)
2978           required: false
2979           type: string
2980         - name: owner-defined-type
2981           in: query
2982           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
2983           required: false
2984           type: string
2985         - name: tenant-name
2986           in: query
2987           description: Readable name of tenant
2988           required: false
2989           type: string
2990         - name: vserver-name
2991           in: query
2992           description: Name of vserver
2993           required: false
2994           type: string
2995         - name: vserver-name2
2996           in: query
2997           description: Alternative name of vserver
2998           required: false
2999           type: string
3000         - name: prov-status
3001           in: query
3002           description: Trigger for operational monitoring of this resource by Service Assurance systems.
3003           required: false
3004           type: string
3005         - name: in-maint
3006           in: query
3007           required: false
3008           type: boolean
3009         - name: is-closed-loop-disabled
3010           in: query
3011           required: false
3012           type: boolean
3013         - name: interface-id
3014           in: query
3015           description: ID of interface
3016           required: false
3017           type: string
3018         - name: macaddr
3019           in: query
3020           description: MAC address for the interface
3021           required: false
3022           type: string
3023         - name: network-name
3024           in: query
3025           description: Name of the network
3026           required: false
3027           type: string
3028         - name: vf-vlan-filter
3029           in: query
3030           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
3031           required: false
3032           type: string
3033         - name: vf-mac-filter
3034           in: query
3035           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
3036           required: false
3037           type: string
3038         - name: vf-vlan-strip
3039           in: query
3040           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
3041           required: false
3042           type: boolean
3043         - name: neutron-network-id
3044           in: query
3045           description: Neutron network id of the interface
3046           required: false
3047           type: string
3048     put:
3049       tags:
3050         - CloudInfrastructure
3051       summary: create or update an existing sriov-vf
3052       description: |
3053         Create or update an existing sriov-vf.
3054         #
3055         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
3056       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf
3057       consumes:
3058         - application/json
3059         - application/xml
3060       produces:
3061         - application/json
3062         - application/xml
3063       responses:
3064         "default":
3065           description: Response codes found in [response codes](https://wiki.onap.org/).
3066       parameters:
3067         - name: cloud-owner
3068           in: path
3069           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3070           required: true
3071           type: string
3072           example: __CLOUD-OWNER__
3073         - name: cloud-region-id
3074           in: path
3075           description: Identifier used by the vendor for the region. Second part of composite key
3076           required: true
3077           type: string
3078           example: __CLOUD-REGION-ID__
3079         - name: tenant-id
3080           in: path
3081           description: Unique id relative to the cloud-region.
3082           required: true
3083           type: string
3084           example: __TENANT-ID__
3085         - name: vserver-id
3086           in: path
3087           description: Unique identifier for this vserver relative to its tenant
3088           required: true
3089           type: string
3090           example: __VSERVER-ID__
3091         - name: interface-name
3092           in: path
3093           description: Name given to the interface
3094           required: true
3095           type: string
3096           example: __INTERFACE-NAME__
3097         - name: pci-id
3098           in: path
3099           description: PCI ID used to identify the sriov-vf
3100           required: true
3101           type: string
3102           example: __PCI-ID__
3103         - name: body
3104           in: body
3105           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json)
3106           required: true
3107           schema:
3108             $ref: "#/definitions/sriov-vf"
3109     patch:
3110       tags:
3111         - CloudInfrastructure
3112       summary: update an existing sriov-vf
3113       description: |
3114         Update an existing sriov-vf
3115         #
3116         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
3117         The PUT operation will entirely replace an existing object.
3118         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
3119         #
3120         Other differences between PUT and PATCH are:
3121         #
3122         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
3123         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
3124         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
3125       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf
3126       consumes:
3127         - application/json
3128         - application/xml
3129       produces:
3130         - application/json
3131         - application/xml
3132       responses:
3133         "default":
3134           description: Response codes found in [response codes](https://wiki.onap.org/).
3135       parameters:
3136         - name: cloud-owner
3137           in: path
3138           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3139           required: true
3140           type: string
3141           example: __CLOUD-OWNER__
3142         - name: cloud-region-id
3143           in: path
3144           description: Identifier used by the vendor for the region. Second part of composite key
3145           required: true
3146           type: string
3147           example: __CLOUD-REGION-ID__
3148         - name: tenant-id
3149           in: path
3150           description: Unique id relative to the cloud-region.
3151           required: true
3152           type: string
3153           example: __TENANT-ID__
3154         - name: vserver-id
3155           in: path
3156           description: Unique identifier for this vserver relative to its tenant
3157           required: true
3158           type: string
3159           example: __VSERVER-ID__
3160         - name: interface-name
3161           in: path
3162           description: Name given to the interface
3163           required: true
3164           type: string
3165           example: __INTERFACE-NAME__
3166         - name: pci-id
3167           in: path
3168           description: PCI ID used to identify the sriov-vf
3169           required: true
3170           type: string
3171           example: __PCI-ID__
3172         - name: body
3173           in: body
3174           description: sriov-vf object that needs to be created or updated.
3175           required: true
3176           schema:
3177             $ref: "#/patchDefinitions/sriov-vf"
3178     delete:
3179       tags:
3180         - CloudInfrastructure
3181       summary: delete an existing sriov-vf
3182       description: delete an existing sriov-vf
3183       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf
3184       consumes:
3185         - application/json
3186         - application/xml
3187       produces:
3188         - application/json
3189         - application/xml
3190       responses:
3191         "default":
3192           description: Response codes found in [response codes](https://wiki.onap.org/).
3193       parameters:
3194         - name: cloud-owner
3195           in: path
3196           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3197           required: true
3198           type: string
3199           example: __CLOUD-OWNER__
3200         - name: cloud-region-id
3201           in: path
3202           description: Identifier used by the vendor for the region. Second part of composite key
3203           required: true
3204           type: string
3205           example: __CLOUD-REGION-ID__
3206         - name: tenant-id
3207           in: path
3208           description: Unique id relative to the cloud-region.
3209           required: true
3210           type: string
3211           example: __TENANT-ID__
3212         - name: vserver-id
3213           in: path
3214           description: Unique identifier for this vserver relative to its tenant
3215           required: true
3216           type: string
3217           example: __VSERVER-ID__
3218         - name: interface-name
3219           in: path
3220           description: Name given to the interface
3221           required: true
3222           type: string
3223           example: __INTERFACE-NAME__
3224         - name: pci-id
3225           in: path
3226           description: PCI ID used to identify the sriov-vf
3227           required: true
3228           type: string
3229           example: __PCI-ID__
3230         - name: resource-version
3231           in: query
3232           description: resource-version for concurrency
3233           required: true
3234           type: string
3235   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
3236     get:
3237       tags:
3238         - CloudInfrastructure
3239       summary: returns sriov-vfs
3240       description: returns sriov-vfs
3241       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfs
3242       produces:
3243         - application/json
3244         - application/xml
3245       responses:
3246         "200":
3247           description: successful operation
3248           schema:
3249               $ref: "#/getDefinitions/sriov-vfs"
3250         "default":
3251           description: Response codes found in [response codes](https://wiki.onap.org/).
3252       parameters:
3253         - name: cloud-owner
3254           in: path
3255           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3256           required: true
3257           type: string
3258           example: __CLOUD-OWNER__
3259         - name: cloud-region-id
3260           in: path
3261           description: Identifier used by the vendor for the region. Second part of composite key
3262           required: true
3263           type: string
3264           example: __CLOUD-REGION-ID__
3265         - name: tenant-id
3266           in: path
3267           description: Unique id relative to the cloud-region.
3268           required: true
3269           type: string
3270           example: __TENANT-ID__
3271         - name: vserver-id
3272           in: path
3273           description: Unique identifier for this vserver relative to its tenant
3274           required: true
3275           type: string
3276           example: __VSERVER-ID__
3277         - name: interface-name
3278           in: path
3279           description: Name given to the interface
3280           required: true
3281           type: string
3282           example: __INTERFACE-NAME__
3283         - name: cloud-type
3284           in: query
3285           description: Type of the cloud (e.g., openstack)
3286           required: false
3287           type: string
3288         - name: owner-defined-type
3289           in: query
3290           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
3291           required: false
3292           type: string
3293         - name: tenant-name
3294           in: query
3295           description: Readable name of tenant
3296           required: false
3297           type: string
3298         - name: vserver-name
3299           in: query
3300           description: Name of vserver
3301           required: false
3302           type: string
3303         - name: vserver-name2
3304           in: query
3305           description: Alternative name of vserver
3306           required: false
3307           type: string
3308         - name: prov-status
3309           in: query
3310           description: Trigger for operational monitoring of this resource by Service Assurance systems.
3311           required: false
3312           type: string
3313         - name: in-maint
3314           in: query
3315           required: false
3316           type: boolean
3317         - name: is-closed-loop-disabled
3318           in: query
3319           required: false
3320           type: boolean
3321         - name: interface-id
3322           in: query
3323           description: ID of interface
3324           required: false
3325           type: string
3326         - name: macaddr
3327           in: query
3328           description: MAC address for the interface
3329           required: false
3330           type: string
3331         - name: network-name
3332           in: query
3333           description: Name of the network
3334           required: false
3335           type: string
3336   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
3337     put:
3338       tags:
3339         - CloudInfrastructure
3340       summary: see node definition for valid relationships
3341       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceRelationshipListRelationship
3342       consumes:
3343         - application/json
3344         - application/xml
3345       produces:
3346         - application/json
3347         - application/xml
3348       responses:
3349         "default":
3350           description: Response codes found in [response codes](https://wiki.onap.org/).
3351       parameters:
3352         - name: cloud-owner
3353           in: path
3354           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3355           required: true
3356           type: string
3357           example: __CLOUD-OWNER__
3358         - name: cloud-region-id
3359           in: path
3360           description: Identifier used by the vendor for the region. Second part of composite key
3361           required: true
3362           type: string
3363           example: __CLOUD-REGION-ID__
3364         - name: tenant-id
3365           in: path
3366           description: Unique id relative to the cloud-region.
3367           required: true
3368           type: string
3369           example: __TENANT-ID__
3370         - name: vserver-id
3371           in: path
3372           description: Unique identifier for this vserver relative to its tenant
3373           required: true
3374           type: string
3375           example: __VSERVER-ID__
3376         - name: interface-name
3377           in: path
3378           description: Name given to the interface
3379           required: true
3380           type: string
3381           example: __INTERFACE-NAME__
3382         - name: body
3383           in: body
3384           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json)
3385           required: true
3386           schema:
3387             $ref: "#/definitions/relationship"
3388     delete:
3389       tags:
3390         - CloudInfrastructure
3391       summary: delete an existing relationship
3392       description: delete an existing relationship
3393       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceRelationshipListRelationship
3394       consumes:
3395         - application/json
3396         - application/xml
3397       produces:
3398         - application/json
3399         - application/xml
3400       responses:
3401         "default":
3402           description: Response codes found in [response codes](https://wiki.onap.org/).
3403       parameters:
3404         - name: cloud-owner
3405           in: path
3406           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3407           required: true
3408           type: string
3409           example: __CLOUD-OWNER__
3410         - name: cloud-region-id
3411           in: path
3412           description: Identifier used by the vendor for the region. Second part of composite key
3413           required: true
3414           type: string
3415           example: __CLOUD-REGION-ID__
3416         - name: tenant-id
3417           in: path
3418           description: Unique id relative to the cloud-region.
3419           required: true
3420           type: string
3421           example: __TENANT-ID__
3422         - name: vserver-id
3423           in: path
3424           description: Unique identifier for this vserver relative to its tenant
3425           required: true
3426           type: string
3427           example: __VSERVER-ID__
3428         - name: interface-name
3429           in: path
3430           description: Name given to the interface
3431           required: true
3432           type: string
3433           example: __INTERFACE-NAME__
3434   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
3435     put:
3436       tags:
3437         - CloudInfrastructure
3438       summary: see node definition for valid relationships
3439       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
3440       consumes:
3441         - application/json
3442         - application/xml
3443       produces:
3444         - application/json
3445         - application/xml
3446       responses:
3447         "default":
3448           description: Response codes found in [response codes](https://wiki.onap.org/).
3449       parameters:
3450         - name: cloud-owner
3451           in: path
3452           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3453           required: true
3454           type: string
3455           example: __CLOUD-OWNER__
3456         - name: cloud-region-id
3457           in: path
3458           description: Identifier used by the vendor for the region. Second part of composite key
3459           required: true
3460           type: string
3461           example: __CLOUD-REGION-ID__
3462         - name: tenant-id
3463           in: path
3464           description: Unique id relative to the cloud-region.
3465           required: true
3466           type: string
3467           example: __TENANT-ID__
3468         - name: vserver-id
3469           in: path
3470           description: Unique identifier for this vserver relative to its tenant
3471           required: true
3472           type: string
3473           example: __VSERVER-ID__
3474         - name: interface-name
3475           in: path
3476           description: Name given to the interface
3477           required: true
3478           type: string
3479           example: __INTERFACE-NAME__
3480         - name: l3-interface-ipv4-address
3481           in: path
3482           description: IP address
3483           required: true
3484           type: string
3485           example: __L3-INTERFACE-IPV4-ADDRESS__
3486         - name: body
3487           in: body
3488           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
3489           required: true
3490           schema:
3491             $ref: "#/definitions/relationship"
3492     delete:
3493       tags:
3494         - CloudInfrastructure
3495       summary: delete an existing relationship
3496       description: delete an existing relationship
3497       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
3498       consumes:
3499         - application/json
3500         - application/xml
3501       produces:
3502         - application/json
3503         - application/xml
3504       responses:
3505         "default":
3506           description: Response codes found in [response codes](https://wiki.onap.org/).
3507       parameters:
3508         - name: cloud-owner
3509           in: path
3510           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3511           required: true
3512           type: string
3513           example: __CLOUD-OWNER__
3514         - name: cloud-region-id
3515           in: path
3516           description: Identifier used by the vendor for the region. Second part of composite key
3517           required: true
3518           type: string
3519           example: __CLOUD-REGION-ID__
3520         - name: tenant-id
3521           in: path
3522           description: Unique id relative to the cloud-region.
3523           required: true
3524           type: string
3525           example: __TENANT-ID__
3526         - name: vserver-id
3527           in: path
3528           description: Unique identifier for this vserver relative to its tenant
3529           required: true
3530           type: string
3531           example: __VSERVER-ID__
3532         - name: interface-name
3533           in: path
3534           description: Name given to the interface
3535           required: true
3536           type: string
3537           example: __INTERFACE-NAME__
3538         - name: l3-interface-ipv4-address
3539           in: path
3540           description: IP address
3541           required: true
3542           type: string
3543           example: __L3-INTERFACE-IPV4-ADDRESS__
3544   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
3545     get:
3546       tags:
3547         - CloudInfrastructure
3548       summary: returns l3-interface-ipv4-address-list
3549       description: returns l3-interface-ipv4-address-list
3550       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
3551       produces:
3552         - application/json
3553         - application/xml
3554       responses:
3555         "200":
3556           description: successful operation
3557           schema:
3558               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
3559         "default":
3560           description: Response codes found in [response codes](https://wiki.onap.org/).
3561       parameters:
3562         - name: cloud-owner
3563           in: path
3564           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3565           required: true
3566           type: string
3567           example: __CLOUD-OWNER__
3568         - name: cloud-region-id
3569           in: path
3570           description: Identifier used by the vendor for the region. Second part of composite key
3571           required: true
3572           type: string
3573           example: __CLOUD-REGION-ID__
3574         - name: tenant-id
3575           in: path
3576           description: Unique id relative to the cloud-region.
3577           required: true
3578           type: string
3579           example: __TENANT-ID__
3580         - name: vserver-id
3581           in: path
3582           description: Unique identifier for this vserver relative to its tenant
3583           required: true
3584           type: string
3585           example: __VSERVER-ID__
3586         - name: interface-name
3587           in: path
3588           description: Name given to the interface
3589           required: true
3590           type: string
3591           example: __INTERFACE-NAME__
3592         - name: l3-interface-ipv4-address
3593           in: path
3594           description: IP address
3595           required: true
3596           type: string
3597           example: __L3-INTERFACE-IPV4-ADDRESS__
3598         - name: cloud-type
3599           in: query
3600           description: Type of the cloud (e.g., openstack)
3601           required: false
3602           type: string
3603         - name: owner-defined-type
3604           in: query
3605           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
3606           required: false
3607           type: string
3608         - name: tenant-name
3609           in: query
3610           description: Readable name of tenant
3611           required: false
3612           type: string
3613         - name: vserver-name
3614           in: query
3615           description: Name of vserver
3616           required: false
3617           type: string
3618         - name: vserver-name2
3619           in: query
3620           description: Alternative name of vserver
3621           required: false
3622           type: string
3623         - name: prov-status
3624           in: query
3625           description: Trigger for operational monitoring of this resource by Service Assurance systems.
3626           required: false
3627           type: string
3628         - name: in-maint
3629           in: query
3630           required: false
3631           type: boolean
3632         - name: is-closed-loop-disabled
3633           in: query
3634           required: false
3635           type: boolean
3636         - name: interface-id
3637           in: query
3638           description: ID of interface
3639           required: false
3640           type: string
3641         - name: macaddr
3642           in: query
3643           description: MAC address for the interface
3644           required: false
3645           type: string
3646         - name: network-name
3647           in: query
3648           description: Name of the network
3649           required: false
3650           type: string
3651         - name: vlan-id-inner
3652           in: query
3653           description: Inner VLAN tag
3654           required: false
3655           type: integer
3656           format: int64
3657         - name: neutron-network-id
3658           in: query
3659           description: Neutron network id of the interface that address belongs to
3660           required: false
3661           type: string
3662         - name: neutron-subnet-id
3663           in: query
3664           description: Neutron id of subnet that address belongs to
3665           required: false
3666           type: string
3667     put:
3668       tags:
3669         - CloudInfrastructure
3670       summary: create or update an existing l3-interface-ipv4-address-list
3671       description: |
3672         Create or update an existing l3-interface-ipv4-address-list.
3673         #
3674         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
3675       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
3676       consumes:
3677         - application/json
3678         - application/xml
3679       produces:
3680         - application/json
3681         - application/xml
3682       responses:
3683         "default":
3684           description: Response codes found in [response codes](https://wiki.onap.org/).
3685       parameters:
3686         - name: cloud-owner
3687           in: path
3688           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3689           required: true
3690           type: string
3691           example: __CLOUD-OWNER__
3692         - name: cloud-region-id
3693           in: path
3694           description: Identifier used by the vendor for the region. Second part of composite key
3695           required: true
3696           type: string
3697           example: __CLOUD-REGION-ID__
3698         - name: tenant-id
3699           in: path
3700           description: Unique id relative to the cloud-region.
3701           required: true
3702           type: string
3703           example: __TENANT-ID__
3704         - name: vserver-id
3705           in: path
3706           description: Unique identifier for this vserver relative to its tenant
3707           required: true
3708           type: string
3709           example: __VSERVER-ID__
3710         - name: interface-name
3711           in: path
3712           description: Name given to the interface
3713           required: true
3714           type: string
3715           example: __INTERFACE-NAME__
3716         - name: l3-interface-ipv4-address
3717           in: path
3718           description: IP address
3719           required: true
3720           type: string
3721           example: __L3-INTERFACE-IPV4-ADDRESS__
3722         - name: body
3723           in: body
3724           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
3725           required: true
3726           schema:
3727             $ref: "#/definitions/l3-interface-ipv4-address-list"
3728     patch:
3729       tags:
3730         - CloudInfrastructure
3731       summary: update an existing l3-interface-ipv4-address-list
3732       description: |
3733         Update an existing l3-interface-ipv4-address-list
3734         #
3735         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
3736         The PUT operation will entirely replace an existing object.
3737         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
3738         #
3739         Other differences between PUT and PATCH are:
3740         #
3741         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
3742         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
3743         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
3744       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
3745       consumes:
3746         - application/json
3747         - application/xml
3748       produces:
3749         - application/json
3750         - application/xml
3751       responses:
3752         "default":
3753           description: Response codes found in [response codes](https://wiki.onap.org/).
3754       parameters:
3755         - name: cloud-owner
3756           in: path
3757           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3758           required: true
3759           type: string
3760           example: __CLOUD-OWNER__
3761         - name: cloud-region-id
3762           in: path
3763           description: Identifier used by the vendor for the region. Second part of composite key
3764           required: true
3765           type: string
3766           example: __CLOUD-REGION-ID__
3767         - name: tenant-id
3768           in: path
3769           description: Unique id relative to the cloud-region.
3770           required: true
3771           type: string
3772           example: __TENANT-ID__
3773         - name: vserver-id
3774           in: path
3775           description: Unique identifier for this vserver relative to its tenant
3776           required: true
3777           type: string
3778           example: __VSERVER-ID__
3779         - name: interface-name
3780           in: path
3781           description: Name given to the interface
3782           required: true
3783           type: string
3784           example: __INTERFACE-NAME__
3785         - name: l3-interface-ipv4-address
3786           in: path
3787           description: IP address
3788           required: true
3789           type: string
3790           example: __L3-INTERFACE-IPV4-ADDRESS__
3791         - name: body
3792           in: body
3793           description: l3-interface-ipv4-address-list object that needs to be created or updated.
3794           required: true
3795           schema:
3796             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
3797     delete:
3798       tags:
3799         - CloudInfrastructure
3800       summary: delete an existing l3-interface-ipv4-address-list
3801       description: delete an existing l3-interface-ipv4-address-list
3802       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
3803       consumes:
3804         - application/json
3805         - application/xml
3806       produces:
3807         - application/json
3808         - application/xml
3809       responses:
3810         "default":
3811           description: Response codes found in [response codes](https://wiki.onap.org/).
3812       parameters:
3813         - name: cloud-owner
3814           in: path
3815           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3816           required: true
3817           type: string
3818           example: __CLOUD-OWNER__
3819         - name: cloud-region-id
3820           in: path
3821           description: Identifier used by the vendor for the region. Second part of composite key
3822           required: true
3823           type: string
3824           example: __CLOUD-REGION-ID__
3825         - name: tenant-id
3826           in: path
3827           description: Unique id relative to the cloud-region.
3828           required: true
3829           type: string
3830           example: __TENANT-ID__
3831         - name: vserver-id
3832           in: path
3833           description: Unique identifier for this vserver relative to its tenant
3834           required: true
3835           type: string
3836           example: __VSERVER-ID__
3837         - name: interface-name
3838           in: path
3839           description: Name given to the interface
3840           required: true
3841           type: string
3842           example: __INTERFACE-NAME__
3843         - name: l3-interface-ipv4-address
3844           in: path
3845           description: IP address
3846           required: true
3847           type: string
3848           example: __L3-INTERFACE-IPV4-ADDRESS__
3849         - name: resource-version
3850           in: query
3851           description: resource-version for concurrency
3852           required: true
3853           type: string
3854   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
3855     put:
3856       tags:
3857         - CloudInfrastructure
3858       summary: see node definition for valid relationships
3859       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
3860       consumes:
3861         - application/json
3862         - application/xml
3863       produces:
3864         - application/json
3865         - application/xml
3866       responses:
3867         "default":
3868           description: Response codes found in [response codes](https://wiki.onap.org/).
3869       parameters:
3870         - name: cloud-owner
3871           in: path
3872           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3873           required: true
3874           type: string
3875           example: __CLOUD-OWNER__
3876         - name: cloud-region-id
3877           in: path
3878           description: Identifier used by the vendor for the region. Second part of composite key
3879           required: true
3880           type: string
3881           example: __CLOUD-REGION-ID__
3882         - name: tenant-id
3883           in: path
3884           description: Unique id relative to the cloud-region.
3885           required: true
3886           type: string
3887           example: __TENANT-ID__
3888         - name: vserver-id
3889           in: path
3890           description: Unique identifier for this vserver relative to its tenant
3891           required: true
3892           type: string
3893           example: __VSERVER-ID__
3894         - name: interface-name
3895           in: path
3896           description: Name given to the interface
3897           required: true
3898           type: string
3899           example: __INTERFACE-NAME__
3900         - name: l3-interface-ipv6-address
3901           in: path
3902           description: IP address
3903           required: true
3904           type: string
3905           example: __L3-INTERFACE-IPV6-ADDRESS__
3906         - name: body
3907           in: body
3908           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
3909           required: true
3910           schema:
3911             $ref: "#/definitions/relationship"
3912     delete:
3913       tags:
3914         - CloudInfrastructure
3915       summary: delete an existing relationship
3916       description: delete an existing relationship
3917       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
3918       consumes:
3919         - application/json
3920         - application/xml
3921       produces:
3922         - application/json
3923         - application/xml
3924       responses:
3925         "default":
3926           description: Response codes found in [response codes](https://wiki.onap.org/).
3927       parameters:
3928         - name: cloud-owner
3929           in: path
3930           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3931           required: true
3932           type: string
3933           example: __CLOUD-OWNER__
3934         - name: cloud-region-id
3935           in: path
3936           description: Identifier used by the vendor for the region. Second part of composite key
3937           required: true
3938           type: string
3939           example: __CLOUD-REGION-ID__
3940         - name: tenant-id
3941           in: path
3942           description: Unique id relative to the cloud-region.
3943           required: true
3944           type: string
3945           example: __TENANT-ID__
3946         - name: vserver-id
3947           in: path
3948           description: Unique identifier for this vserver relative to its tenant
3949           required: true
3950           type: string
3951           example: __VSERVER-ID__
3952         - name: interface-name
3953           in: path
3954           description: Name given to the interface
3955           required: true
3956           type: string
3957           example: __INTERFACE-NAME__
3958         - name: l3-interface-ipv6-address
3959           in: path
3960           description: IP address
3961           required: true
3962           type: string
3963           example: __L3-INTERFACE-IPV6-ADDRESS__
3964   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
3965     get:
3966       tags:
3967         - CloudInfrastructure
3968       summary: returns l3-interface-ipv6-address-list
3969       description: returns l3-interface-ipv6-address-list
3970       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
3971       produces:
3972         - application/json
3973         - application/xml
3974       responses:
3975         "200":
3976           description: successful operation
3977           schema:
3978               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
3979         "default":
3980           description: Response codes found in [response codes](https://wiki.onap.org/).
3981       parameters:
3982         - name: cloud-owner
3983           in: path
3984           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3985           required: true
3986           type: string
3987           example: __CLOUD-OWNER__
3988         - name: cloud-region-id
3989           in: path
3990           description: Identifier used by the vendor for the region. Second part of composite key
3991           required: true
3992           type: string
3993           example: __CLOUD-REGION-ID__
3994         - name: tenant-id
3995           in: path
3996           description: Unique id relative to the cloud-region.
3997           required: true
3998           type: string
3999           example: __TENANT-ID__
4000         - name: vserver-id
4001           in: path
4002           description: Unique identifier for this vserver relative to its tenant
4003           required: true
4004           type: string
4005           example: __VSERVER-ID__
4006         - name: interface-name
4007           in: path
4008           description: Name given to the interface
4009           required: true
4010           type: string
4011           example: __INTERFACE-NAME__
4012         - name: l3-interface-ipv6-address
4013           in: path
4014           description: IP address
4015           required: true
4016           type: string
4017           example: __L3-INTERFACE-IPV6-ADDRESS__
4018         - name: cloud-type
4019           in: query
4020           description: Type of the cloud (e.g., openstack)
4021           required: false
4022           type: string
4023         - name: owner-defined-type
4024           in: query
4025           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
4026           required: false
4027           type: string
4028         - name: tenant-name
4029           in: query
4030           description: Readable name of tenant
4031           required: false
4032           type: string
4033         - name: vserver-name
4034           in: query
4035           description: Name of vserver
4036           required: false
4037           type: string
4038         - name: vserver-name2
4039           in: query
4040           description: Alternative name of vserver
4041           required: false
4042           type: string
4043         - name: prov-status
4044           in: query
4045           description: Trigger for operational monitoring of this resource by Service Assurance systems.
4046           required: false
4047           type: string
4048         - name: in-maint
4049           in: query
4050           required: false
4051           type: boolean
4052         - name: is-closed-loop-disabled
4053           in: query
4054           required: false
4055           type: boolean
4056         - name: interface-id
4057           in: query
4058           description: ID of interface
4059           required: false
4060           type: string
4061         - name: macaddr
4062           in: query
4063           description: MAC address for the interface
4064           required: false
4065           type: string
4066         - name: network-name
4067           in: query
4068           description: Name of the network
4069           required: false
4070           type: string
4071         - name: vlan-id-inner
4072           in: query
4073           description: Inner VLAN tag
4074           required: false
4075           type: integer
4076           format: int64
4077         - name: neutron-network-id
4078           in: query
4079           description: Neutron network id of the interface that address belongs to
4080           required: false
4081           type: string
4082         - name: neutron-subnet-id
4083           in: query
4084           description: Neutron id of subnet that address belongs to
4085           required: false
4086           type: string
4087     put:
4088       tags:
4089         - CloudInfrastructure
4090       summary: create or update an existing l3-interface-ipv6-address-list
4091       description: |
4092         Create or update an existing l3-interface-ipv6-address-list.
4093         #
4094         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
4095       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
4096       consumes:
4097         - application/json
4098         - application/xml
4099       produces:
4100         - application/json
4101         - application/xml
4102       responses:
4103         "default":
4104           description: Response codes found in [response codes](https://wiki.onap.org/).
4105       parameters:
4106         - name: cloud-owner
4107           in: path
4108           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4109           required: true
4110           type: string
4111           example: __CLOUD-OWNER__
4112         - name: cloud-region-id
4113           in: path
4114           description: Identifier used by the vendor for the region. Second part of composite key
4115           required: true
4116           type: string
4117           example: __CLOUD-REGION-ID__
4118         - name: tenant-id
4119           in: path
4120           description: Unique id relative to the cloud-region.
4121           required: true
4122           type: string
4123           example: __TENANT-ID__
4124         - name: vserver-id
4125           in: path
4126           description: Unique identifier for this vserver relative to its tenant
4127           required: true
4128           type: string
4129           example: __VSERVER-ID__
4130         - name: interface-name
4131           in: path
4132           description: Name given to the interface
4133           required: true
4134           type: string
4135           example: __INTERFACE-NAME__
4136         - name: l3-interface-ipv6-address
4137           in: path
4138           description: IP address
4139           required: true
4140           type: string
4141           example: __L3-INTERFACE-IPV6-ADDRESS__
4142         - name: body
4143           in: body
4144           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
4145           required: true
4146           schema:
4147             $ref: "#/definitions/l3-interface-ipv6-address-list"
4148     patch:
4149       tags:
4150         - CloudInfrastructure
4151       summary: update an existing l3-interface-ipv6-address-list
4152       description: |
4153         Update an existing l3-interface-ipv6-address-list
4154         #
4155         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
4156         The PUT operation will entirely replace an existing object.
4157         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
4158         #
4159         Other differences between PUT and PATCH are:
4160         #
4161         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
4162         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
4163         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
4164       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
4165       consumes:
4166         - application/json
4167         - application/xml
4168       produces:
4169         - application/json
4170         - application/xml
4171       responses:
4172         "default":
4173           description: Response codes found in [response codes](https://wiki.onap.org/).
4174       parameters:
4175         - name: cloud-owner
4176           in: path
4177           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4178           required: true
4179           type: string
4180           example: __CLOUD-OWNER__
4181         - name: cloud-region-id
4182           in: path
4183           description: Identifier used by the vendor for the region. Second part of composite key
4184           required: true
4185           type: string
4186           example: __CLOUD-REGION-ID__
4187         - name: tenant-id
4188           in: path
4189           description: Unique id relative to the cloud-region.
4190           required: true
4191           type: string
4192           example: __TENANT-ID__
4193         - name: vserver-id
4194           in: path
4195           description: Unique identifier for this vserver relative to its tenant
4196           required: true
4197           type: string
4198           example: __VSERVER-ID__
4199         - name: interface-name
4200           in: path
4201           description: Name given to the interface
4202           required: true
4203           type: string
4204           example: __INTERFACE-NAME__
4205         - name: l3-interface-ipv6-address
4206           in: path
4207           description: IP address
4208           required: true
4209           type: string
4210           example: __L3-INTERFACE-IPV6-ADDRESS__
4211         - name: body
4212           in: body
4213           description: l3-interface-ipv6-address-list object that needs to be created or updated.
4214           required: true
4215           schema:
4216             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
4217     delete:
4218       tags:
4219         - CloudInfrastructure
4220       summary: delete an existing l3-interface-ipv6-address-list
4221       description: delete an existing l3-interface-ipv6-address-list
4222       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
4223       consumes:
4224         - application/json
4225         - application/xml
4226       produces:
4227         - application/json
4228         - application/xml
4229       responses:
4230         "default":
4231           description: Response codes found in [response codes](https://wiki.onap.org/).
4232       parameters:
4233         - name: cloud-owner
4234           in: path
4235           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4236           required: true
4237           type: string
4238           example: __CLOUD-OWNER__
4239         - name: cloud-region-id
4240           in: path
4241           description: Identifier used by the vendor for the region. Second part of composite key
4242           required: true
4243           type: string
4244           example: __CLOUD-REGION-ID__
4245         - name: tenant-id
4246           in: path
4247           description: Unique id relative to the cloud-region.
4248           required: true
4249           type: string
4250           example: __TENANT-ID__
4251         - name: vserver-id
4252           in: path
4253           description: Unique identifier for this vserver relative to its tenant
4254           required: true
4255           type: string
4256           example: __VSERVER-ID__
4257         - name: interface-name
4258           in: path
4259           description: Name given to the interface
4260           required: true
4261           type: string
4262           example: __INTERFACE-NAME__
4263         - name: l3-interface-ipv6-address
4264           in: path
4265           description: IP address
4266           required: true
4267           type: string
4268           example: __L3-INTERFACE-IPV6-ADDRESS__
4269         - name: resource-version
4270           in: query
4271           description: resource-version for concurrency
4272           required: true
4273           type: string
4274   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}:
4275     get:
4276       tags:
4277         - CloudInfrastructure
4278       summary: returns l-interface
4279       description: returns l-interface
4280       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface
4281       produces:
4282         - application/json
4283         - application/xml
4284       responses:
4285         "200":
4286           description: successful operation
4287           schema:
4288               $ref: "#/getDefinitions/l-interface"
4289         "default":
4290           description: Response codes found in [response codes](https://wiki.onap.org/).
4291       parameters:
4292         - name: cloud-owner
4293           in: path
4294           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4295           required: true
4296           type: string
4297           example: __CLOUD-OWNER__
4298         - name: cloud-region-id
4299           in: path
4300           description: Identifier used by the vendor for the region. Second part of composite key
4301           required: true
4302           type: string
4303           example: __CLOUD-REGION-ID__
4304         - name: tenant-id
4305           in: path
4306           description: Unique id relative to the cloud-region.
4307           required: true
4308           type: string
4309           example: __TENANT-ID__
4310         - name: vserver-id
4311           in: path
4312           description: Unique identifier for this vserver relative to its tenant
4313           required: true
4314           type: string
4315           example: __VSERVER-ID__
4316         - name: interface-name
4317           in: path
4318           description: Name given to the interface
4319           required: true
4320           type: string
4321           example: __INTERFACE-NAME__
4322         - name: cloud-type
4323           in: query
4324           description: Type of the cloud (e.g., openstack)
4325           required: false
4326           type: string
4327         - name: owner-defined-type
4328           in: query
4329           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
4330           required: false
4331           type: string
4332         - name: tenant-name
4333           in: query
4334           description: Readable name of tenant
4335           required: false
4336           type: string
4337         - name: vserver-name
4338           in: query
4339           description: Name of vserver
4340           required: false
4341           type: string
4342         - name: vserver-name2
4343           in: query
4344           description: Alternative name of vserver
4345           required: false
4346           type: string
4347         - name: prov-status
4348           in: query
4349           description: Trigger for operational monitoring of this resource by Service Assurance systems.
4350           required: false
4351           type: string
4352         - name: in-maint
4353           in: query
4354           required: false
4355           type: boolean
4356         - name: is-closed-loop-disabled
4357           in: query
4358           required: false
4359           type: boolean
4360         - name: interface-id
4361           in: query
4362           description: ID of interface
4363           required: false
4364           type: string
4365         - name: macaddr
4366           in: query
4367           description: MAC address for the interface
4368           required: false
4369           type: string
4370         - name: network-name
4371           in: query
4372           description: Name of the network
4373           required: false
4374           type: string
4375     put:
4376       tags:
4377         - CloudInfrastructure
4378       summary: create or update an existing l-interface
4379       description: |
4380         Create or update an existing l-interface.
4381         #
4382         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
4383       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface
4384       consumes:
4385         - application/json
4386         - application/xml
4387       produces:
4388         - application/json
4389         - application/xml
4390       responses:
4391         "default":
4392           description: Response codes found in [response codes](https://wiki.onap.org/).
4393       parameters:
4394         - name: cloud-owner
4395           in: path
4396           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4397           required: true
4398           type: string
4399           example: __CLOUD-OWNER__
4400         - name: cloud-region-id
4401           in: path
4402           description: Identifier used by the vendor for the region. Second part of composite key
4403           required: true
4404           type: string
4405           example: __CLOUD-REGION-ID__
4406         - name: tenant-id
4407           in: path
4408           description: Unique id relative to the cloud-region.
4409           required: true
4410           type: string
4411           example: __TENANT-ID__
4412         - name: vserver-id
4413           in: path
4414           description: Unique identifier for this vserver relative to its tenant
4415           required: true
4416           type: string
4417           example: __VSERVER-ID__
4418         - name: interface-name
4419           in: path
4420           description: Name given to the interface
4421           required: true
4422           type: string
4423           example: __INTERFACE-NAME__
4424         - name: body
4425           in: body
4426           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json)
4427           required: true
4428           schema:
4429             $ref: "#/definitions/l-interface"
4430     patch:
4431       tags:
4432         - CloudInfrastructure
4433       summary: update an existing l-interface
4434       description: |
4435         Update an existing l-interface
4436         #
4437         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
4438         The PUT operation will entirely replace an existing object.
4439         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
4440         #
4441         Other differences between PUT and PATCH are:
4442         #
4443         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
4444         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
4445         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
4446       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface
4447       consumes:
4448         - application/json
4449         - application/xml
4450       produces:
4451         - application/json
4452         - application/xml
4453       responses:
4454         "default":
4455           description: Response codes found in [response codes](https://wiki.onap.org/).
4456       parameters:
4457         - name: cloud-owner
4458           in: path
4459           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4460           required: true
4461           type: string
4462           example: __CLOUD-OWNER__
4463         - name: cloud-region-id
4464           in: path
4465           description: Identifier used by the vendor for the region. Second part of composite key
4466           required: true
4467           type: string
4468           example: __CLOUD-REGION-ID__
4469         - name: tenant-id
4470           in: path
4471           description: Unique id relative to the cloud-region.
4472           required: true
4473           type: string
4474           example: __TENANT-ID__
4475         - name: vserver-id
4476           in: path
4477           description: Unique identifier for this vserver relative to its tenant
4478           required: true
4479           type: string
4480           example: __VSERVER-ID__
4481         - name: interface-name
4482           in: path
4483           description: Name given to the interface
4484           required: true
4485           type: string
4486           example: __INTERFACE-NAME__
4487         - name: body
4488           in: body
4489           description: l-interface object that needs to be created or updated.
4490           required: true
4491           schema:
4492             $ref: "#/patchDefinitions/l-interface"
4493     delete:
4494       tags:
4495         - CloudInfrastructure
4496       summary: delete an existing l-interface
4497       description: delete an existing l-interface
4498       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface
4499       consumes:
4500         - application/json
4501         - application/xml
4502       produces:
4503         - application/json
4504         - application/xml
4505       responses:
4506         "default":
4507           description: Response codes found in [response codes](https://wiki.onap.org/).
4508       parameters:
4509         - name: cloud-owner
4510           in: path
4511           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4512           required: true
4513           type: string
4514           example: __CLOUD-OWNER__
4515         - name: cloud-region-id
4516           in: path
4517           description: Identifier used by the vendor for the region. Second part of composite key
4518           required: true
4519           type: string
4520           example: __CLOUD-REGION-ID__
4521         - name: tenant-id
4522           in: path
4523           description: Unique id relative to the cloud-region.
4524           required: true
4525           type: string
4526           example: __TENANT-ID__
4527         - name: vserver-id
4528           in: path
4529           description: Unique identifier for this vserver relative to its tenant
4530           required: true
4531           type: string
4532           example: __VSERVER-ID__
4533         - name: interface-name
4534           in: path
4535           description: Name given to the interface
4536           required: true
4537           type: string
4538           example: __INTERFACE-NAME__
4539         - name: resource-version
4540           in: query
4541           description: resource-version for concurrency
4542           required: true
4543           type: string
4544   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces:
4545     get:
4546       tags:
4547         - CloudInfrastructure
4548       summary: returns l-interfaces
4549       description: returns l-interfaces
4550       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfaces
4551       produces:
4552         - application/json
4553         - application/xml
4554       responses:
4555         "200":
4556           description: successful operation
4557           schema:
4558               $ref: "#/getDefinitions/l-interfaces"
4559         "default":
4560           description: Response codes found in [response codes](https://wiki.onap.org/).
4561       parameters:
4562         - name: cloud-owner
4563           in: path
4564           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4565           required: true
4566           type: string
4567           example: __CLOUD-OWNER__
4568         - name: cloud-region-id
4569           in: path
4570           description: Identifier used by the vendor for the region. Second part of composite key
4571           required: true
4572           type: string
4573           example: __CLOUD-REGION-ID__
4574         - name: tenant-id
4575           in: path
4576           description: Unique id relative to the cloud-region.
4577           required: true
4578           type: string
4579           example: __TENANT-ID__
4580         - name: vserver-id
4581           in: path
4582           description: Unique identifier for this vserver relative to its tenant
4583           required: true
4584           type: string
4585           example: __VSERVER-ID__
4586         - name: cloud-type
4587           in: query
4588           description: Type of the cloud (e.g., openstack)
4589           required: false
4590           type: string
4591         - name: owner-defined-type
4592           in: query
4593           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
4594           required: false
4595           type: string
4596         - name: tenant-name
4597           in: query
4598           description: Readable name of tenant
4599           required: false
4600           type: string
4601         - name: vserver-name
4602           in: query
4603           description: Name of vserver
4604           required: false
4605           type: string
4606         - name: vserver-name2
4607           in: query
4608           description: Alternative name of vserver
4609           required: false
4610           type: string
4611         - name: prov-status
4612           in: query
4613           description: Trigger for operational monitoring of this resource by Service Assurance systems.
4614           required: false
4615           type: string
4616         - name: in-maint
4617           in: query
4618           required: false
4619           type: boolean
4620         - name: is-closed-loop-disabled
4621           in: query
4622           required: false
4623           type: boolean
4624   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}:
4625     get:
4626       tags:
4627         - CloudInfrastructure
4628       summary: returns vserver
4629       description: returns vserver
4630       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver
4631       produces:
4632         - application/json
4633         - application/xml
4634       responses:
4635         "200":
4636           description: successful operation
4637           schema:
4638               $ref: "#/getDefinitions/vserver"
4639         "default":
4640           description: Response codes found in [response codes](https://wiki.onap.org/).
4641       parameters:
4642         - name: cloud-owner
4643           in: path
4644           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4645           required: true
4646           type: string
4647           example: __CLOUD-OWNER__
4648         - name: cloud-region-id
4649           in: path
4650           description: Identifier used by the vendor for the region. Second part of composite key
4651           required: true
4652           type: string
4653           example: __CLOUD-REGION-ID__
4654         - name: tenant-id
4655           in: path
4656           description: Unique id relative to the cloud-region.
4657           required: true
4658           type: string
4659           example: __TENANT-ID__
4660         - name: vserver-id
4661           in: path
4662           description: Unique identifier for this vserver relative to its tenant
4663           required: true
4664           type: string
4665           example: __VSERVER-ID__
4666         - name: cloud-type
4667           in: query
4668           description: Type of the cloud (e.g., openstack)
4669           required: false
4670           type: string
4671         - name: owner-defined-type
4672           in: query
4673           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
4674           required: false
4675           type: string
4676         - name: tenant-name
4677           in: query
4678           description: Readable name of tenant
4679           required: false
4680           type: string
4681         - name: vserver-name
4682           in: query
4683           description: Name of vserver
4684           required: false
4685           type: string
4686         - name: vserver-name2
4687           in: query
4688           description: Alternative name of vserver
4689           required: false
4690           type: string
4691         - name: prov-status
4692           in: query
4693           description: Trigger for operational monitoring of this resource by Service Assurance systems.
4694           required: false
4695           type: string
4696         - name: in-maint
4697           in: query
4698           required: false
4699           type: boolean
4700         - name: is-closed-loop-disabled
4701           in: query
4702           required: false
4703           type: boolean
4704     put:
4705       tags:
4706         - CloudInfrastructure
4707       summary: create or update an existing vserver
4708       description: |
4709         Create or update an existing vserver.
4710         #
4711         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
4712       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver
4713       consumes:
4714         - application/json
4715         - application/xml
4716       produces:
4717         - application/json
4718         - application/xml
4719       responses:
4720         "default":
4721           description: Response codes found in [response codes](https://wiki.onap.org/).
4722       parameters:
4723         - name: cloud-owner
4724           in: path
4725           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4726           required: true
4727           type: string
4728           example: __CLOUD-OWNER__
4729         - name: cloud-region-id
4730           in: path
4731           description: Identifier used by the vendor for the region. Second part of composite key
4732           required: true
4733           type: string
4734           example: __CLOUD-REGION-ID__
4735         - name: tenant-id
4736           in: path
4737           description: Unique id relative to the cloud-region.
4738           required: true
4739           type: string
4740           example: __TENANT-ID__
4741         - name: vserver-id
4742           in: path
4743           description: Unique identifier for this vserver relative to its tenant
4744           required: true
4745           type: string
4746           example: __VSERVER-ID__
4747         - name: body
4748           in: body
4749           description: vserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json)
4750           required: true
4751           schema:
4752             $ref: "#/definitions/vserver"
4753     patch:
4754       tags:
4755         - CloudInfrastructure
4756       summary: update an existing vserver
4757       description: |
4758         Update an existing vserver
4759         #
4760         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
4761         The PUT operation will entirely replace an existing object.
4762         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
4763         #
4764         Other differences between PUT and PATCH are:
4765         #
4766         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
4767         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
4768         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
4769       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver
4770       consumes:
4771         - application/json
4772         - application/xml
4773       produces:
4774         - application/json
4775         - application/xml
4776       responses:
4777         "default":
4778           description: Response codes found in [response codes](https://wiki.onap.org/).
4779       parameters:
4780         - name: cloud-owner
4781           in: path
4782           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4783           required: true
4784           type: string
4785           example: __CLOUD-OWNER__
4786         - name: cloud-region-id
4787           in: path
4788           description: Identifier used by the vendor for the region. Second part of composite key
4789           required: true
4790           type: string
4791           example: __CLOUD-REGION-ID__
4792         - name: tenant-id
4793           in: path
4794           description: Unique id relative to the cloud-region.
4795           required: true
4796           type: string
4797           example: __TENANT-ID__
4798         - name: vserver-id
4799           in: path
4800           description: Unique identifier for this vserver relative to its tenant
4801           required: true
4802           type: string
4803           example: __VSERVER-ID__
4804         - name: body
4805           in: body
4806           description: vserver object that needs to be created or updated.
4807           required: true
4808           schema:
4809             $ref: "#/patchDefinitions/vserver"
4810     delete:
4811       tags:
4812         - CloudInfrastructure
4813       summary: delete an existing vserver
4814       description: delete an existing vserver
4815       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver
4816       consumes:
4817         - application/json
4818         - application/xml
4819       produces:
4820         - application/json
4821         - application/xml
4822       responses:
4823         "default":
4824           description: Response codes found in [response codes](https://wiki.onap.org/).
4825       parameters:
4826         - name: cloud-owner
4827           in: path
4828           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4829           required: true
4830           type: string
4831           example: __CLOUD-OWNER__
4832         - name: cloud-region-id
4833           in: path
4834           description: Identifier used by the vendor for the region. Second part of composite key
4835           required: true
4836           type: string
4837           example: __CLOUD-REGION-ID__
4838         - name: tenant-id
4839           in: path
4840           description: Unique id relative to the cloud-region.
4841           required: true
4842           type: string
4843           example: __TENANT-ID__
4844         - name: vserver-id
4845           in: path
4846           description: Unique identifier for this vserver relative to its tenant
4847           required: true
4848           type: string
4849           example: __VSERVER-ID__
4850         - name: resource-version
4851           in: query
4852           description: resource-version for concurrency
4853           required: true
4854           type: string
4855   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers:
4856     get:
4857       tags:
4858         - CloudInfrastructure
4859       summary: returns vservers
4860       description: returns vservers
4861       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVservers
4862       produces:
4863         - application/json
4864         - application/xml
4865       responses:
4866         "200":
4867           description: successful operation
4868           schema:
4869               $ref: "#/getDefinitions/vservers"
4870         "default":
4871           description: Response codes found in [response codes](https://wiki.onap.org/).
4872       parameters:
4873         - name: cloud-owner
4874           in: path
4875           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4876           required: true
4877           type: string
4878           example: __CLOUD-OWNER__
4879         - name: cloud-region-id
4880           in: path
4881           description: Identifier used by the vendor for the region. Second part of composite key
4882           required: true
4883           type: string
4884           example: __CLOUD-REGION-ID__
4885         - name: tenant-id
4886           in: path
4887           description: Unique id relative to the cloud-region.
4888           required: true
4889           type: string
4890           example: __TENANT-ID__
4891         - name: cloud-type
4892           in: query
4893           description: Type of the cloud (e.g., openstack)
4894           required: false
4895           type: string
4896         - name: owner-defined-type
4897           in: query
4898           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
4899           required: false
4900           type: string
4901         - name: tenant-name
4902           in: query
4903           description: Readable name of tenant
4904           required: false
4905           type: string
4906   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/relationship-list/relationship:
4907     put:
4908       tags:
4909         - CloudInfrastructure
4910       summary: see node definition for valid relationships
4911       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantRelationshipListRelationship
4912       consumes:
4913         - application/json
4914         - application/xml
4915       produces:
4916         - application/json
4917         - application/xml
4918       responses:
4919         "default":
4920           description: Response codes found in [response codes](https://wiki.onap.org/).
4921       parameters:
4922         - name: cloud-owner
4923           in: path
4924           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4925           required: true
4926           type: string
4927           example: __CLOUD-OWNER__
4928         - name: cloud-region-id
4929           in: path
4930           description: Identifier used by the vendor for the region. Second part of composite key
4931           required: true
4932           type: string
4933           example: __CLOUD-REGION-ID__
4934         - name: tenant-id
4935           in: path
4936           description: Unique id relative to the cloud-region.
4937           required: true
4938           type: string
4939           example: __TENANT-ID__
4940         - name: body
4941           in: body
4942           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json)
4943           required: true
4944           schema:
4945             $ref: "#/definitions/relationship"
4946     delete:
4947       tags:
4948         - CloudInfrastructure
4949       summary: delete an existing relationship
4950       description: delete an existing relationship
4951       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantRelationshipListRelationship
4952       consumes:
4953         - application/json
4954         - application/xml
4955       produces:
4956         - application/json
4957         - application/xml
4958       responses:
4959         "default":
4960           description: Response codes found in [response codes](https://wiki.onap.org/).
4961       parameters:
4962         - name: cloud-owner
4963           in: path
4964           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4965           required: true
4966           type: string
4967           example: __CLOUD-OWNER__
4968         - name: cloud-region-id
4969           in: path
4970           description: Identifier used by the vendor for the region. Second part of composite key
4971           required: true
4972           type: string
4973           example: __CLOUD-REGION-ID__
4974         - name: tenant-id
4975           in: path
4976           description: Unique id relative to the cloud-region.
4977           required: true
4978           type: string
4979           example: __TENANT-ID__
4980   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}:
4981     get:
4982       tags:
4983         - CloudInfrastructure
4984       summary: returns tenant
4985       description: returns tenant
4986       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenant
4987       produces:
4988         - application/json
4989         - application/xml
4990       responses:
4991         "200":
4992           description: successful operation
4993           schema:
4994               $ref: "#/getDefinitions/tenant"
4995         "default":
4996           description: Response codes found in [response codes](https://wiki.onap.org/).
4997       parameters:
4998         - name: cloud-owner
4999           in: path
5000           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5001           required: true
5002           type: string
5003           example: __CLOUD-OWNER__
5004         - name: cloud-region-id
5005           in: path
5006           description: Identifier used by the vendor for the region. Second part of composite key
5007           required: true
5008           type: string
5009           example: __CLOUD-REGION-ID__
5010         - name: tenant-id
5011           in: path
5012           description: Unique id relative to the cloud-region.
5013           required: true
5014           type: string
5015           example: __TENANT-ID__
5016         - name: cloud-type
5017           in: query
5018           description: Type of the cloud (e.g., openstack)
5019           required: false
5020           type: string
5021         - name: owner-defined-type
5022           in: query
5023           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
5024           required: false
5025           type: string
5026         - name: tenant-name
5027           in: query
5028           description: Readable name of tenant
5029           required: false
5030           type: string
5031     put:
5032       tags:
5033         - CloudInfrastructure
5034       summary: create or update an existing tenant
5035       description: |
5036         Create or update an existing tenant.
5037         #
5038         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
5039       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenant
5040       consumes:
5041         - application/json
5042         - application/xml
5043       produces:
5044         - application/json
5045         - application/xml
5046       responses:
5047         "default":
5048           description: Response codes found in [response codes](https://wiki.onap.org/).
5049       parameters:
5050         - name: cloud-owner
5051           in: path
5052           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5053           required: true
5054           type: string
5055           example: __CLOUD-OWNER__
5056         - name: cloud-region-id
5057           in: path
5058           description: Identifier used by the vendor for the region. Second part of composite key
5059           required: true
5060           type: string
5061           example: __CLOUD-REGION-ID__
5062         - name: tenant-id
5063           in: path
5064           description: Unique id relative to the cloud-region.
5065           required: true
5066           type: string
5067           example: __TENANT-ID__
5068         - name: body
5069           in: body
5070           description: tenant object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json)
5071           required: true
5072           schema:
5073             $ref: "#/definitions/tenant"
5074     patch:
5075       tags:
5076         - CloudInfrastructure
5077       summary: update an existing tenant
5078       description: |
5079         Update an existing tenant
5080         #
5081         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5082         The PUT operation will entirely replace an existing object.
5083         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
5084         #
5085         Other differences between PUT and PATCH are:
5086         #
5087         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
5088         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5089         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5090       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenant
5091       consumes:
5092         - application/json
5093         - application/xml
5094       produces:
5095         - application/json
5096         - application/xml
5097       responses:
5098         "default":
5099           description: Response codes found in [response codes](https://wiki.onap.org/).
5100       parameters:
5101         - name: cloud-owner
5102           in: path
5103           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5104           required: true
5105           type: string
5106           example: __CLOUD-OWNER__
5107         - name: cloud-region-id
5108           in: path
5109           description: Identifier used by the vendor for the region. Second part of composite key
5110           required: true
5111           type: string
5112           example: __CLOUD-REGION-ID__
5113         - name: tenant-id
5114           in: path
5115           description: Unique id relative to the cloud-region.
5116           required: true
5117           type: string
5118           example: __TENANT-ID__
5119         - name: body
5120           in: body
5121           description: tenant object that needs to be created or updated.
5122           required: true
5123           schema:
5124             $ref: "#/patchDefinitions/tenant"
5125     delete:
5126       tags:
5127         - CloudInfrastructure
5128       summary: delete an existing tenant
5129       description: delete an existing tenant
5130       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenant
5131       consumes:
5132         - application/json
5133         - application/xml
5134       produces:
5135         - application/json
5136         - application/xml
5137       responses:
5138         "default":
5139           description: Response codes found in [response codes](https://wiki.onap.org/).
5140       parameters:
5141         - name: cloud-owner
5142           in: path
5143           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5144           required: true
5145           type: string
5146           example: __CLOUD-OWNER__
5147         - name: cloud-region-id
5148           in: path
5149           description: Identifier used by the vendor for the region. Second part of composite key
5150           required: true
5151           type: string
5152           example: __CLOUD-REGION-ID__
5153         - name: tenant-id
5154           in: path
5155           description: Unique id relative to the cloud-region.
5156           required: true
5157           type: string
5158           example: __TENANT-ID__
5159         - name: resource-version
5160           in: query
5161           description: resource-version for concurrency
5162           required: true
5163           type: string
5164   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants:
5165     get:
5166       tags:
5167         - CloudInfrastructure
5168       summary: returns tenants
5169       description: returns tenants
5170       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenants
5171       produces:
5172         - application/json
5173         - application/xml
5174       responses:
5175         "200":
5176           description: successful operation
5177           schema:
5178               $ref: "#/getDefinitions/tenants"
5179         "default":
5180           description: Response codes found in [response codes](https://wiki.onap.org/).
5181       parameters:
5182         - name: cloud-owner
5183           in: path
5184           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5185           required: true
5186           type: string
5187           example: __CLOUD-OWNER__
5188         - name: cloud-region-id
5189           in: path
5190           description: Identifier used by the vendor for the region. Second part of composite key
5191           required: true
5192           type: string
5193           example: __CLOUD-REGION-ID__
5194         - name: cloud-type
5195           in: query
5196           description: Type of the cloud (e.g., openstack)
5197           required: false
5198           type: string
5199         - name: owner-defined-type
5200           in: query
5201           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
5202           required: false
5203           type: string
5204   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship:
5205     put:
5206       tags:
5207         - CloudInfrastructure
5208       summary: see node definition for valid relationships
5209       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship
5210       consumes:
5211         - application/json
5212         - application/xml
5213       produces:
5214         - application/json
5215         - application/xml
5216       responses:
5217         "default":
5218           description: Response codes found in [response codes](https://wiki.onap.org/).
5219       parameters:
5220         - name: cloud-owner
5221           in: path
5222           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5223           required: true
5224           type: string
5225           example: __CLOUD-OWNER__
5226         - name: cloud-region-id
5227           in: path
5228           description: Identifier used by the vendor for the region. Second part of composite key
5229           required: true
5230           type: string
5231           example: __CLOUD-REGION-ID__
5232         - name: flavor-id
5233           in: path
5234           description: Flavor id, expected to be unique across cloud-region.
5235           required: true
5236           type: string
5237           example: __FLAVOR-ID__
5238         - name: body
5239           in: body
5240           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)
5241           required: true
5242           schema:
5243             $ref: "#/definitions/relationship"
5244     delete:
5245       tags:
5246         - CloudInfrastructure
5247       summary: delete an existing relationship
5248       description: delete an existing relationship
5249       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship
5250       consumes:
5251         - application/json
5252         - application/xml
5253       produces:
5254         - application/json
5255         - application/xml
5256       responses:
5257         "default":
5258           description: Response codes found in [response codes](https://wiki.onap.org/).
5259       parameters:
5260         - name: cloud-owner
5261           in: path
5262           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5263           required: true
5264           type: string
5265           example: __CLOUD-OWNER__
5266         - name: cloud-region-id
5267           in: path
5268           description: Identifier used by the vendor for the region. Second part of composite key
5269           required: true
5270           type: string
5271           example: __CLOUD-REGION-ID__
5272         - name: flavor-id
5273           in: path
5274           description: Flavor id, expected to be unique across cloud-region.
5275           required: true
5276           type: string
5277           example: __FLAVOR-ID__
5278   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}:
5279     get:
5280       tags:
5281         - CloudInfrastructure
5282       summary: returns flavor
5283       description: returns flavor
5284       operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
5285       produces:
5286         - application/json
5287         - application/xml
5288       responses:
5289         "200":
5290           description: successful operation
5291           schema:
5292               $ref: "#/getDefinitions/flavor"
5293         "default":
5294           description: Response codes found in [response codes](https://wiki.onap.org/).
5295       parameters:
5296         - name: cloud-owner
5297           in: path
5298           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5299           required: true
5300           type: string
5301           example: __CLOUD-OWNER__
5302         - name: cloud-region-id
5303           in: path
5304           description: Identifier used by the vendor for the region. Second part of composite key
5305           required: true
5306           type: string
5307           example: __CLOUD-REGION-ID__
5308         - name: flavor-id
5309           in: path
5310           description: Flavor id, expected to be unique across cloud-region.
5311           required: true
5312           type: string
5313           example: __FLAVOR-ID__
5314         - name: cloud-type
5315           in: query
5316           description: Type of the cloud (e.g., openstack)
5317           required: false
5318           type: string
5319         - name: owner-defined-type
5320           in: query
5321           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
5322           required: false
5323           type: string
5324         - name: flavor-name
5325           in: query
5326           description: Flavor name
5327           required: false
5328           type: string
5329     put:
5330       tags:
5331         - CloudInfrastructure
5332       summary: create or update an existing flavor
5333       description: |
5334         Create or update an existing flavor.
5335         #
5336         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
5337       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
5338       consumes:
5339         - application/json
5340         - application/xml
5341       produces:
5342         - application/json
5343         - application/xml
5344       responses:
5345         "default":
5346           description: Response codes found in [response codes](https://wiki.onap.org/).
5347       parameters:
5348         - name: cloud-owner
5349           in: path
5350           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5351           required: true
5352           type: string
5353           example: __CLOUD-OWNER__
5354         - name: cloud-region-id
5355           in: path
5356           description: Identifier used by the vendor for the region. Second part of composite key
5357           required: true
5358           type: string
5359           example: __CLOUD-REGION-ID__
5360         - name: flavor-id
5361           in: path
5362           description: Flavor id, expected to be unique across cloud-region.
5363           required: true
5364           type: string
5365           example: __FLAVOR-ID__
5366         - name: body
5367           in: body
5368           description: flavor object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)
5369           required: true
5370           schema:
5371             $ref: "#/definitions/flavor"
5372     patch:
5373       tags:
5374         - CloudInfrastructure
5375       summary: update an existing flavor
5376       description: |
5377         Update an existing flavor
5378         #
5379         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5380         The PUT operation will entirely replace an existing object.
5381         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
5382         #
5383         Other differences between PUT and PATCH are:
5384         #
5385         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
5386         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5387         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5388       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
5389       consumes:
5390         - application/json
5391         - application/xml
5392       produces:
5393         - application/json
5394         - application/xml
5395       responses:
5396         "default":
5397           description: Response codes found in [response codes](https://wiki.onap.org/).
5398       parameters:
5399         - name: cloud-owner
5400           in: path
5401           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5402           required: true
5403           type: string
5404           example: __CLOUD-OWNER__
5405         - name: cloud-region-id
5406           in: path
5407           description: Identifier used by the vendor for the region. Second part of composite key
5408           required: true
5409           type: string
5410           example: __CLOUD-REGION-ID__
5411         - name: flavor-id
5412           in: path
5413           description: Flavor id, expected to be unique across cloud-region.
5414           required: true
5415           type: string
5416           example: __FLAVOR-ID__
5417         - name: body
5418           in: body
5419           description: flavor object that needs to be created or updated.
5420           required: true
5421           schema:
5422             $ref: "#/patchDefinitions/flavor"
5423     delete:
5424       tags:
5425         - CloudInfrastructure
5426       summary: delete an existing flavor
5427       description: delete an existing flavor
5428       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
5429       consumes:
5430         - application/json
5431         - application/xml
5432       produces:
5433         - application/json
5434         - application/xml
5435       responses:
5436         "default":
5437           description: Response codes found in [response codes](https://wiki.onap.org/).
5438       parameters:
5439         - name: cloud-owner
5440           in: path
5441           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5442           required: true
5443           type: string
5444           example: __CLOUD-OWNER__
5445         - name: cloud-region-id
5446           in: path
5447           description: Identifier used by the vendor for the region. Second part of composite key
5448           required: true
5449           type: string
5450           example: __CLOUD-REGION-ID__
5451         - name: flavor-id
5452           in: path
5453           description: Flavor id, expected to be unique across cloud-region.
5454           required: true
5455           type: string
5456           example: __FLAVOR-ID__
5457         - name: resource-version
5458           in: query
5459           description: resource-version for concurrency
5460           required: true
5461           type: string
5462   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors:
5463     get:
5464       tags:
5465         - CloudInfrastructure
5466       summary: returns flavors
5467       description: returns flavors
5468       operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavors
5469       produces:
5470         - application/json
5471         - application/xml
5472       responses:
5473         "200":
5474           description: successful operation
5475           schema:
5476               $ref: "#/getDefinitions/flavors"
5477         "default":
5478           description: Response codes found in [response codes](https://wiki.onap.org/).
5479       parameters:
5480         - name: cloud-owner
5481           in: path
5482           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5483           required: true
5484           type: string
5485           example: __CLOUD-OWNER__
5486         - name: cloud-region-id
5487           in: path
5488           description: Identifier used by the vendor for the region. Second part of composite key
5489           required: true
5490           type: string
5491           example: __CLOUD-REGION-ID__
5492         - name: cloud-type
5493           in: query
5494           description: Type of the cloud (e.g., openstack)
5495           required: false
5496           type: string
5497         - name: owner-defined-type
5498           in: query
5499           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
5500           required: false
5501           type: string
5502   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship:
5503     put:
5504       tags:
5505         - CloudInfrastructure
5506       summary: see node definition for valid relationships
5507       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship
5508       consumes:
5509         - application/json
5510         - application/xml
5511       produces:
5512         - application/json
5513         - application/xml
5514       responses:
5515         "default":
5516           description: Response codes found in [response codes](https://wiki.onap.org/).
5517       parameters:
5518         - name: cloud-owner
5519           in: path
5520           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5521           required: true
5522           type: string
5523           example: __CLOUD-OWNER__
5524         - name: cloud-region-id
5525           in: path
5526           description: Identifier used by the vendor for the region. Second part of composite key
5527           required: true
5528           type: string
5529           example: __CLOUD-REGION-ID__
5530         - name: group-id
5531           in: path
5532           description: Group id, expected to be unique across cloud-region.
5533           required: true
5534           type: string
5535           example: __GROUP-ID__
5536         - name: body
5537           in: body
5538           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)
5539           required: true
5540           schema:
5541             $ref: "#/definitions/relationship"
5542     delete:
5543       tags:
5544         - CloudInfrastructure
5545       summary: delete an existing relationship
5546       description: delete an existing relationship
5547       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship
5548       consumes:
5549         - application/json
5550         - application/xml
5551       produces:
5552         - application/json
5553         - application/xml
5554       responses:
5555         "default":
5556           description: Response codes found in [response codes](https://wiki.onap.org/).
5557       parameters:
5558         - name: cloud-owner
5559           in: path
5560           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5561           required: true
5562           type: string
5563           example: __CLOUD-OWNER__
5564         - name: cloud-region-id
5565           in: path
5566           description: Identifier used by the vendor for the region. Second part of composite key
5567           required: true
5568           type: string
5569           example: __CLOUD-REGION-ID__
5570         - name: group-id
5571           in: path
5572           description: Group id, expected to be unique across cloud-region.
5573           required: true
5574           type: string
5575           example: __GROUP-ID__
5576   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}:
5577     get:
5578       tags:
5579         - CloudInfrastructure
5580       summary: returns group-assignment
5581       description: returns group-assignment
5582       operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
5583       produces:
5584         - application/json
5585         - application/xml
5586       responses:
5587         "200":
5588           description: successful operation
5589           schema:
5590               $ref: "#/getDefinitions/group-assignment"
5591         "default":
5592           description: Response codes found in [response codes](https://wiki.onap.org/).
5593       parameters:
5594         - name: cloud-owner
5595           in: path
5596           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5597           required: true
5598           type: string
5599           example: __CLOUD-OWNER__
5600         - name: cloud-region-id
5601           in: path
5602           description: Identifier used by the vendor for the region. Second part of composite key
5603           required: true
5604           type: string
5605           example: __CLOUD-REGION-ID__
5606         - name: group-id
5607           in: path
5608           description: Group id, expected to be unique across cloud-region.
5609           required: true
5610           type: string
5611           example: __GROUP-ID__
5612         - name: cloud-type
5613           in: query
5614           description: Type of the cloud (e.g., openstack)
5615           required: false
5616           type: string
5617         - name: owner-defined-type
5618           in: query
5619           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
5620           required: false
5621           type: string
5622         - name: group-type
5623           in: query
5624           description: Group type - the type of group this instance refers to
5625           required: false
5626           type: string
5627         - name: group-name
5628           in: query
5629           description: Group name - name assigned to the group
5630           required: false
5631           type: string
5632     put:
5633       tags:
5634         - CloudInfrastructure
5635       summary: create or update an existing group-assignment
5636       description: |
5637         Create or update an existing group-assignment.
5638         #
5639         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
5640       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
5641       consumes:
5642         - application/json
5643         - application/xml
5644       produces:
5645         - application/json
5646         - application/xml
5647       responses:
5648         "default":
5649           description: Response codes found in [response codes](https://wiki.onap.org/).
5650       parameters:
5651         - name: cloud-owner
5652           in: path
5653           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5654           required: true
5655           type: string
5656           example: __CLOUD-OWNER__
5657         - name: cloud-region-id
5658           in: path
5659           description: Identifier used by the vendor for the region. Second part of composite key
5660           required: true
5661           type: string
5662           example: __CLOUD-REGION-ID__
5663         - name: group-id
5664           in: path
5665           description: Group id, expected to be unique across cloud-region.
5666           required: true
5667           type: string
5668           example: __GROUP-ID__
5669         - name: body
5670           in: body
5671           description: group-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)
5672           required: true
5673           schema:
5674             $ref: "#/definitions/group-assignment"
5675     patch:
5676       tags:
5677         - CloudInfrastructure
5678       summary: update an existing group-assignment
5679       description: |
5680         Update an existing group-assignment
5681         #
5682         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5683         The PUT operation will entirely replace an existing object.
5684         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
5685         #
5686         Other differences between PUT and PATCH are:
5687         #
5688         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
5689         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5690         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5691       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
5692       consumes:
5693         - application/json
5694         - application/xml
5695       produces:
5696         - application/json
5697         - application/xml
5698       responses:
5699         "default":
5700           description: Response codes found in [response codes](https://wiki.onap.org/).
5701       parameters:
5702         - name: cloud-owner
5703           in: path
5704           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5705           required: true
5706           type: string
5707           example: __CLOUD-OWNER__
5708         - name: cloud-region-id
5709           in: path
5710           description: Identifier used by the vendor for the region. Second part of composite key
5711           required: true
5712           type: string
5713           example: __CLOUD-REGION-ID__
5714         - name: group-id
5715           in: path
5716           description: Group id, expected to be unique across cloud-region.
5717           required: true
5718           type: string
5719           example: __GROUP-ID__
5720         - name: body
5721           in: body
5722           description: group-assignment object that needs to be created or updated.
5723           required: true
5724           schema:
5725             $ref: "#/patchDefinitions/group-assignment"
5726     delete:
5727       tags:
5728         - CloudInfrastructure
5729       summary: delete an existing group-assignment
5730       description: delete an existing group-assignment
5731       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
5732       consumes:
5733         - application/json
5734         - application/xml
5735       produces:
5736         - application/json
5737         - application/xml
5738       responses:
5739         "default":
5740           description: Response codes found in [response codes](https://wiki.onap.org/).
5741       parameters:
5742         - name: cloud-owner
5743           in: path
5744           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5745           required: true
5746           type: string
5747           example: __CLOUD-OWNER__
5748         - name: cloud-region-id
5749           in: path
5750           description: Identifier used by the vendor for the region. Second part of composite key
5751           required: true
5752           type: string
5753           example: __CLOUD-REGION-ID__
5754         - name: group-id
5755           in: path
5756           description: Group id, expected to be unique across cloud-region.
5757           required: true
5758           type: string
5759           example: __GROUP-ID__
5760         - name: resource-version
5761           in: query
5762           description: resource-version for concurrency
5763           required: true
5764           type: string
5765   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments:
5766     get:
5767       tags:
5768         - CloudInfrastructure
5769       summary: returns group-assignments
5770       description: returns group-assignments
5771       operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignments
5772       produces:
5773         - application/json
5774         - application/xml
5775       responses:
5776         "200":
5777           description: successful operation
5778           schema:
5779               $ref: "#/getDefinitions/group-assignments"
5780         "default":
5781           description: Response codes found in [response codes](https://wiki.onap.org/).
5782       parameters:
5783         - name: cloud-owner
5784           in: path
5785           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5786           required: true
5787           type: string
5788           example: __CLOUD-OWNER__
5789         - name: cloud-region-id
5790           in: path
5791           description: Identifier used by the vendor for the region. Second part of composite key
5792           required: true
5793           type: string
5794           example: __CLOUD-REGION-ID__
5795         - name: cloud-type
5796           in: query
5797           description: Type of the cloud (e.g., openstack)
5798           required: false
5799           type: string
5800         - name: owner-defined-type
5801           in: query
5802           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
5803           required: false
5804           type: string
5805   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship:
5806     put:
5807       tags:
5808         - CloudInfrastructure
5809       summary: see node definition for valid relationships
5810       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship
5811       consumes:
5812         - application/json
5813         - application/xml
5814       produces:
5815         - application/json
5816         - application/xml
5817       responses:
5818         "default":
5819           description: Response codes found in [response codes](https://wiki.onap.org/).
5820       parameters:
5821         - name: cloud-owner
5822           in: path
5823           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5824           required: true
5825           type: string
5826           example: __CLOUD-OWNER__
5827         - name: cloud-region-id
5828           in: path
5829           description: Identifier used by the vendor for the region. Second part of composite key
5830           required: true
5831           type: string
5832           example: __CLOUD-REGION-ID__
5833         - name: snapshot-id
5834           in: path
5835           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5836           required: true
5837           type: string
5838           example: __SNAPSHOT-ID__
5839         - name: body
5840           in: body
5841           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)
5842           required: true
5843           schema:
5844             $ref: "#/definitions/relationship"
5845     delete:
5846       tags:
5847         - CloudInfrastructure
5848       summary: delete an existing relationship
5849       description: delete an existing relationship
5850       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship
5851       consumes:
5852         - application/json
5853         - application/xml
5854       produces:
5855         - application/json
5856         - application/xml
5857       responses:
5858         "default":
5859           description: Response codes found in [response codes](https://wiki.onap.org/).
5860       parameters:
5861         - name: cloud-owner
5862           in: path
5863           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5864           required: true
5865           type: string
5866           example: __CLOUD-OWNER__
5867         - name: cloud-region-id
5868           in: path
5869           description: Identifier used by the vendor for the region. Second part of composite key
5870           required: true
5871           type: string
5872           example: __CLOUD-REGION-ID__
5873         - name: snapshot-id
5874           in: path
5875           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5876           required: true
5877           type: string
5878           example: __SNAPSHOT-ID__
5879   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}:
5880     get:
5881       tags:
5882         - CloudInfrastructure
5883       summary: returns snapshot
5884       description: returns snapshot
5885       operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5886       produces:
5887         - application/json
5888         - application/xml
5889       responses:
5890         "200":
5891           description: successful operation
5892           schema:
5893               $ref: "#/getDefinitions/snapshot"
5894         "default":
5895           description: Response codes found in [response codes](https://wiki.onap.org/).
5896       parameters:
5897         - name: cloud-owner
5898           in: path
5899           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5900           required: true
5901           type: string
5902           example: __CLOUD-OWNER__
5903         - name: cloud-region-id
5904           in: path
5905           description: Identifier used by the vendor for the region. Second part of composite key
5906           required: true
5907           type: string
5908           example: __CLOUD-REGION-ID__
5909         - name: snapshot-id
5910           in: path
5911           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5912           required: true
5913           type: string
5914           example: __SNAPSHOT-ID__
5915         - name: cloud-type
5916           in: query
5917           description: Type of the cloud (e.g., openstack)
5918           required: false
5919           type: string
5920         - name: owner-defined-type
5921           in: query
5922           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
5923           required: false
5924           type: string
5925         - name: snapshot-name
5926           in: query
5927           description: Snapshot name
5928           required: false
5929           type: string
5930         - name: application
5931           in: query
5932           description: The application that the image instantiates.
5933           required: false
5934           type: string
5935         - name: application-vendor
5936           in: query
5937           description: The vendor of the application.
5938           required: false
5939           type: string
5940         - name: application-version
5941           in: query
5942           description: The version of the application.
5943           required: false
5944           type: string
5945         - name: prev-snapshot-id
5946           in: query
5947           description: This field contains the UUID of the previous snapshot (if any).
5948           required: false
5949           type: string
5950     put:
5951       tags:
5952         - CloudInfrastructure
5953       summary: create or update an existing snapshot
5954       description: |
5955         Create or update an existing snapshot.
5956         #
5957         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
5958       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5959       consumes:
5960         - application/json
5961         - application/xml
5962       produces:
5963         - application/json
5964         - application/xml
5965       responses:
5966         "default":
5967           description: Response codes found in [response codes](https://wiki.onap.org/).
5968       parameters:
5969         - name: cloud-owner
5970           in: path
5971           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5972           required: true
5973           type: string
5974           example: __CLOUD-OWNER__
5975         - name: cloud-region-id
5976           in: path
5977           description: Identifier used by the vendor for the region. Second part of composite key
5978           required: true
5979           type: string
5980           example: __CLOUD-REGION-ID__
5981         - name: snapshot-id
5982           in: path
5983           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5984           required: true
5985           type: string
5986           example: __SNAPSHOT-ID__
5987         - name: body
5988           in: body
5989           description: snapshot object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)
5990           required: true
5991           schema:
5992             $ref: "#/definitions/snapshot"
5993     patch:
5994       tags:
5995         - CloudInfrastructure
5996       summary: update an existing snapshot
5997       description: |
5998         Update an existing snapshot
5999         #
6000         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6001         The PUT operation will entirely replace an existing object.
6002         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
6003         #
6004         Other differences between PUT and PATCH are:
6005         #
6006         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
6007         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6008         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6009       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
6010       consumes:
6011         - application/json
6012         - application/xml
6013       produces:
6014         - application/json
6015         - application/xml
6016       responses:
6017         "default":
6018           description: Response codes found in [response codes](https://wiki.onap.org/).
6019       parameters:
6020         - name: cloud-owner
6021           in: path
6022           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6023           required: true
6024           type: string
6025           example: __CLOUD-OWNER__
6026         - name: cloud-region-id
6027           in: path
6028           description: Identifier used by the vendor for the region. Second part of composite key
6029           required: true
6030           type: string
6031           example: __CLOUD-REGION-ID__
6032         - name: snapshot-id
6033           in: path
6034           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
6035           required: true
6036           type: string
6037           example: __SNAPSHOT-ID__
6038         - name: body
6039           in: body
6040           description: snapshot object that needs to be created or updated.
6041           required: true
6042           schema:
6043             $ref: "#/patchDefinitions/snapshot"
6044     delete:
6045       tags:
6046         - CloudInfrastructure
6047       summary: delete an existing snapshot
6048       description: delete an existing snapshot
6049       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
6050       consumes:
6051         - application/json
6052         - application/xml
6053       produces:
6054         - application/json
6055         - application/xml
6056       responses:
6057         "default":
6058           description: Response codes found in [response codes](https://wiki.onap.org/).
6059       parameters:
6060         - name: cloud-owner
6061           in: path
6062           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6063           required: true
6064           type: string
6065           example: __CLOUD-OWNER__
6066         - name: cloud-region-id
6067           in: path
6068           description: Identifier used by the vendor for the region. Second part of composite key
6069           required: true
6070           type: string
6071           example: __CLOUD-REGION-ID__
6072         - name: snapshot-id
6073           in: path
6074           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
6075           required: true
6076           type: string
6077           example: __SNAPSHOT-ID__
6078         - name: resource-version
6079           in: query
6080           description: resource-version for concurrency
6081           required: true
6082           type: string
6083   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots:
6084     get:
6085       tags:
6086         - CloudInfrastructure
6087       summary: returns snapshots
6088       description: returns snapshots
6089       operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshots
6090       produces:
6091         - application/json
6092         - application/xml
6093       responses:
6094         "200":
6095           description: successful operation
6096           schema:
6097               $ref: "#/getDefinitions/snapshots"
6098         "default":
6099           description: Response codes found in [response codes](https://wiki.onap.org/).
6100       parameters:
6101         - name: cloud-owner
6102           in: path
6103           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6104           required: true
6105           type: string
6106           example: __CLOUD-OWNER__
6107         - name: cloud-region-id
6108           in: path
6109           description: Identifier used by the vendor for the region. Second part of composite key
6110           required: true
6111           type: string
6112           example: __CLOUD-REGION-ID__
6113         - name: cloud-type
6114           in: query
6115           description: Type of the cloud (e.g., openstack)
6116           required: false
6117           type: string
6118         - name: owner-defined-type
6119           in: query
6120           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
6121           required: false
6122           type: string
6123   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship:
6124     put:
6125       tags:
6126         - CloudInfrastructure
6127       summary: see node definition for valid relationships
6128       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship
6129       consumes:
6130         - application/json
6131         - application/xml
6132       produces:
6133         - application/json
6134         - application/xml
6135       responses:
6136         "default":
6137           description: Response codes found in [response codes](https://wiki.onap.org/).
6138       parameters:
6139         - name: cloud-owner
6140           in: path
6141           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6142           required: true
6143           type: string
6144           example: __CLOUD-OWNER__
6145         - name: cloud-region-id
6146           in: path
6147           description: Identifier used by the vendor for the region. Second part of composite key
6148           required: true
6149           type: string
6150           example: __CLOUD-REGION-ID__
6151         - name: image-id
6152           in: path
6153           description: Image id, expected to be unique across cloud region
6154           required: true
6155           type: string
6156           example: __IMAGE-ID__
6157         - name: body
6158           in: body
6159           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)
6160           required: true
6161           schema:
6162             $ref: "#/definitions/relationship"
6163     delete:
6164       tags:
6165         - CloudInfrastructure
6166       summary: delete an existing relationship
6167       description: delete an existing relationship
6168       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship
6169       consumes:
6170         - application/json
6171         - application/xml
6172       produces:
6173         - application/json
6174         - application/xml
6175       responses:
6176         "default":
6177           description: Response codes found in [response codes](https://wiki.onap.org/).
6178       parameters:
6179         - name: cloud-owner
6180           in: path
6181           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6182           required: true
6183           type: string
6184           example: __CLOUD-OWNER__
6185         - name: cloud-region-id
6186           in: path
6187           description: Identifier used by the vendor for the region. Second part of composite key
6188           required: true
6189           type: string
6190           example: __CLOUD-REGION-ID__
6191         - name: image-id
6192           in: path
6193           description: Image id, expected to be unique across cloud region
6194           required: true
6195           type: string
6196           example: __IMAGE-ID__
6197   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}:
6198     get:
6199       tags:
6200         - CloudInfrastructure
6201       summary: returns metadatum
6202       description: returns metadatum
6203       operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
6204       produces:
6205         - application/json
6206         - application/xml
6207       responses:
6208         "200":
6209           description: successful operation
6210           schema:
6211               $ref: "#/getDefinitions/metadatum"
6212         "default":
6213           description: Response codes found in [response codes](https://wiki.onap.org/).
6214       parameters:
6215         - name: cloud-owner
6216           in: path
6217           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6218           required: true
6219           type: string
6220           example: __CLOUD-OWNER__
6221         - name: cloud-region-id
6222           in: path
6223           description: Identifier used by the vendor for the region. Second part of composite key
6224           required: true
6225           type: string
6226           example: __CLOUD-REGION-ID__
6227         - name: image-id
6228           in: path
6229           description: Image id, expected to be unique across cloud region
6230           required: true
6231           type: string
6232           example: __IMAGE-ID__
6233         - name: metaname
6234           in: path
6235           required: true
6236           type: string
6237           example: __METANAME__
6238         - name: cloud-type
6239           in: query
6240           description: Type of the cloud (e.g., openstack)
6241           required: false
6242           type: string
6243         - name: owner-defined-type
6244           in: query
6245           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
6246           required: false
6247           type: string
6248         - name: image-name
6249           in: query
6250           description: Image name
6251           required: false
6252           type: string
6253         - name: application
6254           in: query
6255           description: The application that the image instantiates.
6256           required: false
6257           type: string
6258         - name: application-vendor
6259           in: query
6260           description: The vendor of the application.
6261           required: false
6262           type: string
6263         - name: application-version
6264           in: query
6265           description: The version of the application.
6266           required: false
6267           type: string
6268     put:
6269       tags:
6270         - CloudInfrastructure
6271       summary: create or update an existing metadatum
6272       description: |
6273         Create or update an existing metadatum.
6274         #
6275         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
6276       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
6277       consumes:
6278         - application/json
6279         - application/xml
6280       produces:
6281         - application/json
6282         - application/xml
6283       responses:
6284         "default":
6285           description: Response codes found in [response codes](https://wiki.onap.org/).
6286       parameters:
6287         - name: cloud-owner
6288           in: path
6289           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6290           required: true
6291           type: string
6292           example: __CLOUD-OWNER__
6293         - name: cloud-region-id
6294           in: path
6295           description: Identifier used by the vendor for the region. Second part of composite key
6296           required: true
6297           type: string
6298           example: __CLOUD-REGION-ID__
6299         - name: image-id
6300           in: path
6301           description: Image id, expected to be unique across cloud region
6302           required: true
6303           type: string
6304           example: __IMAGE-ID__
6305         - name: metaname
6306           in: path
6307           required: true
6308           type: string
6309           example: __METANAME__
6310         - name: body
6311           in: body
6312           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum.json)
6313           required: true
6314           schema:
6315             $ref: "#/definitions/metadatum"
6316     patch:
6317       tags:
6318         - CloudInfrastructure
6319       summary: update an existing metadatum
6320       description: |
6321         Update an existing metadatum
6322         #
6323         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6324         The PUT operation will entirely replace an existing object.
6325         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
6326         #
6327         Other differences between PUT and PATCH are:
6328         #
6329         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
6330         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6331         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6332       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
6333       consumes:
6334         - application/json
6335         - application/xml
6336       produces:
6337         - application/json
6338         - application/xml
6339       responses:
6340         "default":
6341           description: Response codes found in [response codes](https://wiki.onap.org/).
6342       parameters:
6343         - name: cloud-owner
6344           in: path
6345           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6346           required: true
6347           type: string
6348           example: __CLOUD-OWNER__
6349         - name: cloud-region-id
6350           in: path
6351           description: Identifier used by the vendor for the region. Second part of composite key
6352           required: true
6353           type: string
6354           example: __CLOUD-REGION-ID__
6355         - name: image-id
6356           in: path
6357           description: Image id, expected to be unique across cloud region
6358           required: true
6359           type: string
6360           example: __IMAGE-ID__
6361         - name: metaname
6362           in: path
6363           required: true
6364           type: string
6365           example: __METANAME__
6366         - name: body
6367           in: body
6368           description: metadatum object that needs to be created or updated.
6369           required: true
6370           schema:
6371             $ref: "#/patchDefinitions/metadatum"
6372     delete:
6373       tags:
6374         - CloudInfrastructure
6375       summary: delete an existing metadatum
6376       description: delete an existing metadatum
6377       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
6378       consumes:
6379         - application/json
6380         - application/xml
6381       produces:
6382         - application/json
6383         - application/xml
6384       responses:
6385         "default":
6386           description: Response codes found in [response codes](https://wiki.onap.org/).
6387       parameters:
6388         - name: cloud-owner
6389           in: path
6390           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6391           required: true
6392           type: string
6393           example: __CLOUD-OWNER__
6394         - name: cloud-region-id
6395           in: path
6396           description: Identifier used by the vendor for the region. Second part of composite key
6397           required: true
6398           type: string
6399           example: __CLOUD-REGION-ID__
6400         - name: image-id
6401           in: path
6402           description: Image id, expected to be unique across cloud region
6403           required: true
6404           type: string
6405           example: __IMAGE-ID__
6406         - name: metaname
6407           in: path
6408           required: true
6409           type: string
6410           example: __METANAME__
6411         - name: resource-version
6412           in: query
6413           description: resource-version for concurrency
6414           required: true
6415           type: string
6416   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata:
6417     get:
6418       tags:
6419         - CloudInfrastructure
6420       summary: returns metadata
6421       description: returns metadata
6422       operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadata
6423       produces:
6424         - application/json
6425         - application/xml
6426       responses:
6427         "200":
6428           description: successful operation
6429           schema:
6430               $ref: "#/getDefinitions/metadata"
6431         "default":
6432           description: Response codes found in [response codes](https://wiki.onap.org/).
6433       parameters:
6434         - name: cloud-owner
6435           in: path
6436           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6437           required: true
6438           type: string
6439           example: __CLOUD-OWNER__
6440         - name: cloud-region-id
6441           in: path
6442           description: Identifier used by the vendor for the region. Second part of composite key
6443           required: true
6444           type: string
6445           example: __CLOUD-REGION-ID__
6446         - name: image-id
6447           in: path
6448           description: Image id, expected to be unique across cloud region
6449           required: true
6450           type: string
6451           example: __IMAGE-ID__
6452         - name: cloud-type
6453           in: query
6454           description: Type of the cloud (e.g., openstack)
6455           required: false
6456           type: string
6457         - name: owner-defined-type
6458           in: query
6459           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
6460           required: false
6461           type: string
6462         - name: image-name
6463           in: query
6464           description: Image name
6465           required: false
6466           type: string
6467         - name: application
6468           in: query
6469           description: The application that the image instantiates.
6470           required: false
6471           type: string
6472         - name: application-vendor
6473           in: query
6474           description: The vendor of the application.
6475           required: false
6476           type: string
6477         - name: application-version
6478           in: query
6479           description: The version of the application.
6480           required: false
6481           type: string
6482   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}:
6483     get:
6484       tags:
6485         - CloudInfrastructure
6486       summary: returns image
6487       description: returns image
6488       operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImage
6489       produces:
6490         - application/json
6491         - application/xml
6492       responses:
6493         "200":
6494           description: successful operation
6495           schema:
6496               $ref: "#/getDefinitions/image"
6497         "default":
6498           description: Response codes found in [response codes](https://wiki.onap.org/).
6499       parameters:
6500         - name: cloud-owner
6501           in: path
6502           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6503           required: true
6504           type: string
6505           example: __CLOUD-OWNER__
6506         - name: cloud-region-id
6507           in: path
6508           description: Identifier used by the vendor for the region. Second part of composite key
6509           required: true
6510           type: string
6511           example: __CLOUD-REGION-ID__
6512         - name: image-id
6513           in: path
6514           description: Image id, expected to be unique across cloud region
6515           required: true
6516           type: string
6517           example: __IMAGE-ID__
6518         - name: cloud-type
6519           in: query
6520           description: Type of the cloud (e.g., openstack)
6521           required: false
6522           type: string
6523         - name: owner-defined-type
6524           in: query
6525           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
6526           required: false
6527           type: string
6528         - name: image-name
6529           in: query
6530           description: Image name
6531           required: false
6532           type: string
6533         - name: application
6534           in: query
6535           description: The application that the image instantiates.
6536           required: false
6537           type: string
6538         - name: application-vendor
6539           in: query
6540           description: The vendor of the application.
6541           required: false
6542           type: string
6543         - name: application-version
6544           in: query
6545           description: The version of the application.
6546           required: false
6547           type: string
6548     put:
6549       tags:
6550         - CloudInfrastructure
6551       summary: create or update an existing image
6552       description: |
6553         Create or update an existing image.
6554         #
6555         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
6556       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage
6557       consumes:
6558         - application/json
6559         - application/xml
6560       produces:
6561         - application/json
6562         - application/xml
6563       responses:
6564         "default":
6565           description: Response codes found in [response codes](https://wiki.onap.org/).
6566       parameters:
6567         - name: cloud-owner
6568           in: path
6569           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6570           required: true
6571           type: string
6572           example: __CLOUD-OWNER__
6573         - name: cloud-region-id
6574           in: path
6575           description: Identifier used by the vendor for the region. Second part of composite key
6576           required: true
6577           type: string
6578           example: __CLOUD-REGION-ID__
6579         - name: image-id
6580           in: path
6581           description: Image id, expected to be unique across cloud region
6582           required: true
6583           type: string
6584           example: __IMAGE-ID__
6585         - name: body
6586           in: body
6587           description: image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)
6588           required: true
6589           schema:
6590             $ref: "#/definitions/image"
6591     patch:
6592       tags:
6593         - CloudInfrastructure
6594       summary: update an existing image
6595       description: |
6596         Update an existing image
6597         #
6598         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6599         The PUT operation will entirely replace an existing object.
6600         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
6601         #
6602         Other differences between PUT and PATCH are:
6603         #
6604         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
6605         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6606         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6607       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage
6608       consumes:
6609         - application/json
6610         - application/xml
6611       produces:
6612         - application/json
6613         - application/xml
6614       responses:
6615         "default":
6616           description: Response codes found in [response codes](https://wiki.onap.org/).
6617       parameters:
6618         - name: cloud-owner
6619           in: path
6620           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6621           required: true
6622           type: string
6623           example: __CLOUD-OWNER__
6624         - name: cloud-region-id
6625           in: path
6626           description: Identifier used by the vendor for the region. Second part of composite key
6627           required: true
6628           type: string
6629           example: __CLOUD-REGION-ID__
6630         - name: image-id
6631           in: path
6632           description: Image id, expected to be unique across cloud region
6633           required: true
6634           type: string
6635           example: __IMAGE-ID__
6636         - name: body
6637           in: body
6638           description: image object that needs to be created or updated.
6639           required: true
6640           schema:
6641             $ref: "#/patchDefinitions/image"
6642     delete:
6643       tags:
6644         - CloudInfrastructure
6645       summary: delete an existing image
6646       description: delete an existing image
6647       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImage
6648       consumes:
6649         - application/json
6650         - application/xml
6651       produces:
6652         - application/json
6653         - application/xml
6654       responses:
6655         "default":
6656           description: Response codes found in [response codes](https://wiki.onap.org/).
6657       parameters:
6658         - name: cloud-owner
6659           in: path
6660           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6661           required: true
6662           type: string
6663           example: __CLOUD-OWNER__
6664         - name: cloud-region-id
6665           in: path
6666           description: Identifier used by the vendor for the region. Second part of composite key
6667           required: true
6668           type: string
6669           example: __CLOUD-REGION-ID__
6670         - name: image-id
6671           in: path
6672           description: Image id, expected to be unique across cloud region
6673           required: true
6674           type: string
6675           example: __IMAGE-ID__
6676         - name: resource-version
6677           in: query
6678           description: resource-version for concurrency
6679           required: true
6680           type: string
6681   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images:
6682     get:
6683       tags:
6684         - CloudInfrastructure
6685       summary: returns images
6686       description: returns images
6687       operationId: getCloudInfrastructureCloudRegionsCloudRegionImages
6688       produces:
6689         - application/json
6690         - application/xml
6691       responses:
6692         "200":
6693           description: successful operation
6694           schema:
6695               $ref: "#/getDefinitions/images"
6696         "default":
6697           description: Response codes found in [response codes](https://wiki.onap.org/).
6698       parameters:
6699         - name: cloud-owner
6700           in: path
6701           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6702           required: true
6703           type: string
6704           example: __CLOUD-OWNER__
6705         - name: cloud-region-id
6706           in: path
6707           description: Identifier used by the vendor for the region. Second part of composite key
6708           required: true
6709           type: string
6710           example: __CLOUD-REGION-ID__
6711         - name: cloud-type
6712           in: query
6713           description: Type of the cloud (e.g., openstack)
6714           required: false
6715           type: string
6716         - name: owner-defined-type
6717           in: query
6718           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
6719           required: false
6720           type: string
6721   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship:
6722     put:
6723       tags:
6724         - CloudInfrastructure
6725       summary: see node definition for valid relationships
6726       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship
6727       consumes:
6728         - application/json
6729         - application/xml
6730       produces:
6731         - application/json
6732         - application/xml
6733       responses:
6734         "default":
6735           description: Response codes found in [response codes](https://wiki.onap.org/).
6736       parameters:
6737         - name: cloud-owner
6738           in: path
6739           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6740           required: true
6741           type: string
6742           example: __CLOUD-OWNER__
6743         - name: cloud-region-id
6744           in: path
6745           description: Identifier used by the vendor for the region. Second part of composite key
6746           required: true
6747           type: string
6748           example: __CLOUD-REGION-ID__
6749         - name: switch-name
6750           in: path
6751           description: DVS switch name
6752           required: true
6753           type: string
6754           example: __SWITCH-NAME__
6755         - name: body
6756           in: body
6757           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)
6758           required: true
6759           schema:
6760             $ref: "#/definitions/relationship"
6761     delete:
6762       tags:
6763         - CloudInfrastructure
6764       summary: delete an existing relationship
6765       description: delete an existing relationship
6766       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship
6767       consumes:
6768         - application/json
6769         - application/xml
6770       produces:
6771         - application/json
6772         - application/xml
6773       responses:
6774         "default":
6775           description: Response codes found in [response codes](https://wiki.onap.org/).
6776       parameters:
6777         - name: cloud-owner
6778           in: path
6779           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6780           required: true
6781           type: string
6782           example: __CLOUD-OWNER__
6783         - name: cloud-region-id
6784           in: path
6785           description: Identifier used by the vendor for the region. Second part of composite key
6786           required: true
6787           type: string
6788           example: __CLOUD-REGION-ID__
6789         - name: switch-name
6790           in: path
6791           description: DVS switch name
6792           required: true
6793           type: string
6794           example: __SWITCH-NAME__
6795   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}:
6796     get:
6797       tags:
6798         - CloudInfrastructure
6799       summary: returns dvs-switch
6800       description: returns dvs-switch
6801       operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6802       produces:
6803         - application/json
6804         - application/xml
6805       responses:
6806         "200":
6807           description: successful operation
6808           schema:
6809               $ref: "#/getDefinitions/dvs-switch"
6810         "default":
6811           description: Response codes found in [response codes](https://wiki.onap.org/).
6812       parameters:
6813         - name: cloud-owner
6814           in: path
6815           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6816           required: true
6817           type: string
6818           example: __CLOUD-OWNER__
6819         - name: cloud-region-id
6820           in: path
6821           description: Identifier used by the vendor for the region. Second part of composite key
6822           required: true
6823           type: string
6824           example: __CLOUD-REGION-ID__
6825         - name: switch-name
6826           in: path
6827           description: DVS switch name
6828           required: true
6829           type: string
6830           example: __SWITCH-NAME__
6831         - name: cloud-type
6832           in: query
6833           description: Type of the cloud (e.g., openstack)
6834           required: false
6835           type: string
6836         - name: owner-defined-type
6837           in: query
6838           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
6839           required: false
6840           type: string
6841         - name: vcenter-url
6842           in: query
6843           description: URL used to reach the vcenter
6844           required: false
6845           type: string
6846     put:
6847       tags:
6848         - CloudInfrastructure
6849       summary: create or update an existing dvs-switch
6850       description: |
6851         Create or update an existing dvs-switch.
6852         #
6853         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
6854       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6855       consumes:
6856         - application/json
6857         - application/xml
6858       produces:
6859         - application/json
6860         - application/xml
6861       responses:
6862         "default":
6863           description: Response codes found in [response codes](https://wiki.onap.org/).
6864       parameters:
6865         - name: cloud-owner
6866           in: path
6867           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6868           required: true
6869           type: string
6870           example: __CLOUD-OWNER__
6871         - name: cloud-region-id
6872           in: path
6873           description: Identifier used by the vendor for the region. Second part of composite key
6874           required: true
6875           type: string
6876           example: __CLOUD-REGION-ID__
6877         - name: switch-name
6878           in: path
6879           description: DVS switch name
6880           required: true
6881           type: string
6882           example: __SWITCH-NAME__
6883         - name: body
6884           in: body
6885           description: dvs-switch object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)
6886           required: true
6887           schema:
6888             $ref: "#/definitions/dvs-switch"
6889     patch:
6890       tags:
6891         - CloudInfrastructure
6892       summary: update an existing dvs-switch
6893       description: |
6894         Update an existing dvs-switch
6895         #
6896         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6897         The PUT operation will entirely replace an existing object.
6898         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
6899         #
6900         Other differences between PUT and PATCH are:
6901         #
6902         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
6903         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6904         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6905       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6906       consumes:
6907         - application/json
6908         - application/xml
6909       produces:
6910         - application/json
6911         - application/xml
6912       responses:
6913         "default":
6914           description: Response codes found in [response codes](https://wiki.onap.org/).
6915       parameters:
6916         - name: cloud-owner
6917           in: path
6918           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6919           required: true
6920           type: string
6921           example: __CLOUD-OWNER__
6922         - name: cloud-region-id
6923           in: path
6924           description: Identifier used by the vendor for the region. Second part of composite key
6925           required: true
6926           type: string
6927           example: __CLOUD-REGION-ID__
6928         - name: switch-name
6929           in: path
6930           description: DVS switch name
6931           required: true
6932           type: string
6933           example: __SWITCH-NAME__
6934         - name: body
6935           in: body
6936           description: dvs-switch object that needs to be created or updated.
6937           required: true
6938           schema:
6939             $ref: "#/patchDefinitions/dvs-switch"
6940     delete:
6941       tags:
6942         - CloudInfrastructure
6943       summary: delete an existing dvs-switch
6944       description: delete an existing dvs-switch
6945       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6946       consumes:
6947         - application/json
6948         - application/xml
6949       produces:
6950         - application/json
6951         - application/xml
6952       responses:
6953         "default":
6954           description: Response codes found in [response codes](https://wiki.onap.org/).
6955       parameters:
6956         - name: cloud-owner
6957           in: path
6958           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6959           required: true
6960           type: string
6961           example: __CLOUD-OWNER__
6962         - name: cloud-region-id
6963           in: path
6964           description: Identifier used by the vendor for the region. Second part of composite key
6965           required: true
6966           type: string
6967           example: __CLOUD-REGION-ID__
6968         - name: switch-name
6969           in: path
6970           description: DVS switch name
6971           required: true
6972           type: string
6973           example: __SWITCH-NAME__
6974         - name: resource-version
6975           in: query
6976           description: resource-version for concurrency
6977           required: true
6978           type: string
6979   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches:
6980     get:
6981       tags:
6982         - CloudInfrastructure
6983       summary: returns dvs-switches
6984       description: returns dvs-switches
6985       operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitches
6986       produces:
6987         - application/json
6988         - application/xml
6989       responses:
6990         "200":
6991           description: successful operation
6992           schema:
6993               $ref: "#/getDefinitions/dvs-switches"
6994         "default":
6995           description: Response codes found in [response codes](https://wiki.onap.org/).
6996       parameters:
6997         - name: cloud-owner
6998           in: path
6999           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7000           required: true
7001           type: string
7002           example: __CLOUD-OWNER__
7003         - name: cloud-region-id
7004           in: path
7005           description: Identifier used by the vendor for the region. Second part of composite key
7006           required: true
7007           type: string
7008           example: __CLOUD-REGION-ID__
7009         - name: cloud-type
7010           in: query
7011           description: Type of the cloud (e.g., openstack)
7012           required: false
7013           type: string
7014         - name: owner-defined-type
7015           in: query
7016           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
7017           required: false
7018           type: string
7019   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship:
7020     put:
7021       tags:
7022         - CloudInfrastructure
7023       summary: see node definition for valid relationships
7024       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship
7025       consumes:
7026         - application/json
7027         - application/xml
7028       produces:
7029         - application/json
7030         - application/xml
7031       responses:
7032         "default":
7033           description: Response codes found in [response codes](https://wiki.onap.org/).
7034       parameters:
7035         - name: cloud-owner
7036           in: path
7037           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7038           required: true
7039           type: string
7040           example: __CLOUD-OWNER__
7041         - name: cloud-region-id
7042           in: path
7043           description: Identifier used by the vendor for the region. Second part of composite key
7044           required: true
7045           type: string
7046           example: __CLOUD-REGION-ID__
7047         - name: network-uuid
7048           in: path
7049           description: UUID of the network. Unique across a cloud-region
7050           required: true
7051           type: string
7052           example: __NETWORK-UUID__
7053         - name: body
7054           in: body
7055           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)
7056           required: true
7057           schema:
7058             $ref: "#/definitions/relationship"
7059     delete:
7060       tags:
7061         - CloudInfrastructure
7062       summary: delete an existing relationship
7063       description: delete an existing relationship
7064       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship
7065       consumes:
7066         - application/json
7067         - application/xml
7068       produces:
7069         - application/json
7070         - application/xml
7071       responses:
7072         "default":
7073           description: Response codes found in [response codes](https://wiki.onap.org/).
7074       parameters:
7075         - name: cloud-owner
7076           in: path
7077           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7078           required: true
7079           type: string
7080           example: __CLOUD-OWNER__
7081         - name: cloud-region-id
7082           in: path
7083           description: Identifier used by the vendor for the region. Second part of composite key
7084           required: true
7085           type: string
7086           example: __CLOUD-REGION-ID__
7087         - name: network-uuid
7088           in: path
7089           description: UUID of the network. Unique across a cloud-region
7090           required: true
7091           type: string
7092           example: __NETWORK-UUID__
7093   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}:
7094     get:
7095       tags:
7096         - CloudInfrastructure
7097       summary: returns oam-network
7098       description: returns oam-network
7099       operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
7100       produces:
7101         - application/json
7102         - application/xml
7103       responses:
7104         "200":
7105           description: successful operation
7106           schema:
7107               $ref: "#/getDefinitions/oam-network"
7108         "default":
7109           description: Response codes found in [response codes](https://wiki.onap.org/).
7110       parameters:
7111         - name: cloud-owner
7112           in: path
7113           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7114           required: true
7115           type: string
7116           example: __CLOUD-OWNER__
7117         - name: cloud-region-id
7118           in: path
7119           description: Identifier used by the vendor for the region. Second part of composite key
7120           required: true
7121           type: string
7122           example: __CLOUD-REGION-ID__
7123         - name: network-uuid
7124           in: path
7125           description: UUID of the network. Unique across a cloud-region
7126           required: true
7127           type: string
7128           example: __NETWORK-UUID__
7129         - name: cloud-type
7130           in: query
7131           description: Type of the cloud (e.g., openstack)
7132           required: false
7133           type: string
7134         - name: owner-defined-type
7135           in: query
7136           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
7137           required: false
7138           type: string
7139         - name: network-name
7140           in: query
7141           description: Name of the network.
7142           required: false
7143           type: string
7144         - name: cvlan-tag
7145           in: query
7146           description: cvlan-id
7147           required: false
7148           type: integer
7149           format: int64
7150     put:
7151       tags:
7152         - CloudInfrastructure
7153       summary: create or update an existing oam-network
7154       description: |
7155         Create or update an existing oam-network.
7156         #
7157         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
7158       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
7159       consumes:
7160         - application/json
7161         - application/xml
7162       produces:
7163         - application/json
7164         - application/xml
7165       responses:
7166         "default":
7167           description: Response codes found in [response codes](https://wiki.onap.org/).
7168       parameters:
7169         - name: cloud-owner
7170           in: path
7171           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7172           required: true
7173           type: string
7174           example: __CLOUD-OWNER__
7175         - name: cloud-region-id
7176           in: path
7177           description: Identifier used by the vendor for the region. Second part of composite key
7178           required: true
7179           type: string
7180           example: __CLOUD-REGION-ID__
7181         - name: network-uuid
7182           in: path
7183           description: UUID of the network. Unique across a cloud-region
7184           required: true
7185           type: string
7186           example: __NETWORK-UUID__
7187         - name: body
7188           in: body
7189           description: oam-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)
7190           required: true
7191           schema:
7192             $ref: "#/definitions/oam-network"
7193     patch:
7194       tags:
7195         - CloudInfrastructure
7196       summary: update an existing oam-network
7197       description: |
7198         Update an existing oam-network
7199         #
7200         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7201         The PUT operation will entirely replace an existing object.
7202         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
7203         #
7204         Other differences between PUT and PATCH are:
7205         #
7206         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
7207         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7208         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7209       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
7210       consumes:
7211         - application/json
7212         - application/xml
7213       produces:
7214         - application/json
7215         - application/xml
7216       responses:
7217         "default":
7218           description: Response codes found in [response codes](https://wiki.onap.org/).
7219       parameters:
7220         - name: cloud-owner
7221           in: path
7222           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7223           required: true
7224           type: string
7225           example: __CLOUD-OWNER__
7226         - name: cloud-region-id
7227           in: path
7228           description: Identifier used by the vendor for the region. Second part of composite key
7229           required: true
7230           type: string
7231           example: __CLOUD-REGION-ID__
7232         - name: network-uuid
7233           in: path
7234           description: UUID of the network. Unique across a cloud-region
7235           required: true
7236           type: string
7237           example: __NETWORK-UUID__
7238         - name: body
7239           in: body
7240           description: oam-network object that needs to be created or updated.
7241           required: true
7242           schema:
7243             $ref: "#/patchDefinitions/oam-network"
7244     delete:
7245       tags:
7246         - CloudInfrastructure
7247       summary: delete an existing oam-network
7248       description: delete an existing oam-network
7249       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
7250       consumes:
7251         - application/json
7252         - application/xml
7253       produces:
7254         - application/json
7255         - application/xml
7256       responses:
7257         "default":
7258           description: Response codes found in [response codes](https://wiki.onap.org/).
7259       parameters:
7260         - name: cloud-owner
7261           in: path
7262           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7263           required: true
7264           type: string
7265           example: __CLOUD-OWNER__
7266         - name: cloud-region-id
7267           in: path
7268           description: Identifier used by the vendor for the region. Second part of composite key
7269           required: true
7270           type: string
7271           example: __CLOUD-REGION-ID__
7272         - name: network-uuid
7273           in: path
7274           description: UUID of the network. Unique across a cloud-region
7275           required: true
7276           type: string
7277           example: __NETWORK-UUID__
7278         - name: resource-version
7279           in: query
7280           description: resource-version for concurrency
7281           required: true
7282           type: string
7283   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks:
7284     get:
7285       tags:
7286         - CloudInfrastructure
7287       summary: returns oam-networks
7288       description: returns oam-networks
7289       operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworks
7290       produces:
7291         - application/json
7292         - application/xml
7293       responses:
7294         "200":
7295           description: successful operation
7296           schema:
7297               $ref: "#/getDefinitions/oam-networks"
7298         "default":
7299           description: Response codes found in [response codes](https://wiki.onap.org/).
7300       parameters:
7301         - name: cloud-owner
7302           in: path
7303           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7304           required: true
7305           type: string
7306           example: __CLOUD-OWNER__
7307         - name: cloud-region-id
7308           in: path
7309           description: Identifier used by the vendor for the region. Second part of composite key
7310           required: true
7311           type: string
7312           example: __CLOUD-REGION-ID__
7313         - name: cloud-type
7314           in: query
7315           description: Type of the cloud (e.g., openstack)
7316           required: false
7317           type: string
7318         - name: owner-defined-type
7319           in: query
7320           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
7321           required: false
7322           type: string
7323   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship:
7324     put:
7325       tags:
7326         - CloudInfrastructure
7327       summary: see node definition for valid relationships
7328       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship
7329       consumes:
7330         - application/json
7331         - application/xml
7332       produces:
7333         - application/json
7334         - application/xml
7335       responses:
7336         "default":
7337           description: Response codes found in [response codes](https://wiki.onap.org/).
7338       parameters:
7339         - name: cloud-owner
7340           in: path
7341           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7342           required: true
7343           type: string
7344           example: __CLOUD-OWNER__
7345         - name: cloud-region-id
7346           in: path
7347           description: Identifier used by the vendor for the region. Second part of composite key
7348           required: true
7349           type: string
7350           example: __CLOUD-REGION-ID__
7351         - name: availability-zone-name
7352           in: path
7353           description: Name of the availability zone.  Unique across a cloud region
7354           required: true
7355           type: string
7356           example: __AVAILABILITY-ZONE-NAME__
7357         - name: body
7358           in: body
7359           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)
7360           required: true
7361           schema:
7362             $ref: "#/definitions/relationship"
7363     delete:
7364       tags:
7365         - CloudInfrastructure
7366       summary: delete an existing relationship
7367       description: delete an existing relationship
7368       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship
7369       consumes:
7370         - application/json
7371         - application/xml
7372       produces:
7373         - application/json
7374         - application/xml
7375       responses:
7376         "default":
7377           description: Response codes found in [response codes](https://wiki.onap.org/).
7378       parameters:
7379         - name: cloud-owner
7380           in: path
7381           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7382           required: true
7383           type: string
7384           example: __CLOUD-OWNER__
7385         - name: cloud-region-id
7386           in: path
7387           description: Identifier used by the vendor for the region. Second part of composite key
7388           required: true
7389           type: string
7390           example: __CLOUD-REGION-ID__
7391         - name: availability-zone-name
7392           in: path
7393           description: Name of the availability zone.  Unique across a cloud region
7394           required: true
7395           type: string
7396           example: __AVAILABILITY-ZONE-NAME__
7397   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}:
7398     get:
7399       tags:
7400         - CloudInfrastructure
7401       summary: returns availability-zone
7402       description: returns availability-zone
7403       operationId: getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
7404       produces:
7405         - application/json
7406         - application/xml
7407       responses:
7408         "200":
7409           description: successful operation
7410           schema:
7411               $ref: "#/getDefinitions/availability-zone"
7412         "default":
7413           description: Response codes found in [response codes](https://wiki.onap.org/).
7414       parameters:
7415         - name: cloud-owner
7416           in: path
7417           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7418           required: true
7419           type: string
7420           example: __CLOUD-OWNER__
7421         - name: cloud-region-id
7422           in: path
7423           description: Identifier used by the vendor for the region. Second part of composite key
7424           required: true
7425           type: string
7426           example: __CLOUD-REGION-ID__
7427         - name: availability-zone-name
7428           in: path
7429           description: Name of the availability zone.  Unique across a cloud region
7430           required: true
7431           type: string
7432           example: __AVAILABILITY-ZONE-NAME__
7433         - name: cloud-type
7434           in: query
7435           description: Type of the cloud (e.g., openstack)
7436           required: false
7437           type: string
7438         - name: owner-defined-type
7439           in: query
7440           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
7441           required: false
7442           type: string
7443     put:
7444       tags:
7445         - CloudInfrastructure
7446       summary: create or update an existing availability-zone
7447       description: |
7448         Create or update an existing availability-zone.
7449         #
7450         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
7451       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
7452       consumes:
7453         - application/json
7454         - application/xml
7455       produces:
7456         - application/json
7457         - application/xml
7458       responses:
7459         "default":
7460           description: Response codes found in [response codes](https://wiki.onap.org/).
7461       parameters:
7462         - name: cloud-owner
7463           in: path
7464           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7465           required: true
7466           type: string
7467           example: __CLOUD-OWNER__
7468         - name: cloud-region-id
7469           in: path
7470           description: Identifier used by the vendor for the region. Second part of composite key
7471           required: true
7472           type: string
7473           example: __CLOUD-REGION-ID__
7474         - name: availability-zone-name
7475           in: path
7476           description: Name of the availability zone.  Unique across a cloud region
7477           required: true
7478           type: string
7479           example: __AVAILABILITY-ZONE-NAME__
7480         - name: body
7481           in: body
7482           description: availability-zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)
7483           required: true
7484           schema:
7485             $ref: "#/definitions/availability-zone"
7486     patch:
7487       tags:
7488         - CloudInfrastructure
7489       summary: update an existing availability-zone
7490       description: |
7491         Update an existing availability-zone
7492         #
7493         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7494         The PUT operation will entirely replace an existing object.
7495         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
7496         #
7497         Other differences between PUT and PATCH are:
7498         #
7499         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
7500         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7501         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7502       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
7503       consumes:
7504         - application/json
7505         - application/xml
7506       produces:
7507         - application/json
7508         - application/xml
7509       responses:
7510         "default":
7511           description: Response codes found in [response codes](https://wiki.onap.org/).
7512       parameters:
7513         - name: cloud-owner
7514           in: path
7515           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7516           required: true
7517           type: string
7518           example: __CLOUD-OWNER__
7519         - name: cloud-region-id
7520           in: path
7521           description: Identifier used by the vendor for the region. Second part of composite key
7522           required: true
7523           type: string
7524           example: __CLOUD-REGION-ID__
7525         - name: availability-zone-name
7526           in: path
7527           description: Name of the availability zone.  Unique across a cloud region
7528           required: true
7529           type: string
7530           example: __AVAILABILITY-ZONE-NAME__
7531         - name: body
7532           in: body
7533           description: availability-zone object that needs to be created or updated.
7534           required: true
7535           schema:
7536             $ref: "#/patchDefinitions/availability-zone"
7537     delete:
7538       tags:
7539         - CloudInfrastructure
7540       summary: delete an existing availability-zone
7541       description: delete an existing availability-zone
7542       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
7543       consumes:
7544         - application/json
7545         - application/xml
7546       produces:
7547         - application/json
7548         - application/xml
7549       responses:
7550         "default":
7551           description: Response codes found in [response codes](https://wiki.onap.org/).
7552       parameters:
7553         - name: cloud-owner
7554           in: path
7555           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7556           required: true
7557           type: string
7558           example: __CLOUD-OWNER__
7559         - name: cloud-region-id
7560           in: path
7561           description: Identifier used by the vendor for the region. Second part of composite key
7562           required: true
7563           type: string
7564           example: __CLOUD-REGION-ID__
7565         - name: availability-zone-name
7566           in: path
7567           description: Name of the availability zone.  Unique across a cloud region
7568           required: true
7569           type: string
7570           example: __AVAILABILITY-ZONE-NAME__
7571         - name: resource-version
7572           in: query
7573           description: resource-version for concurrency
7574           required: true
7575           type: string
7576   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones:
7577     get:
7578       tags:
7579         - CloudInfrastructure
7580       summary: returns availability-zones
7581       description: returns availability-zones
7582       operationId: getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZones
7583       produces:
7584         - application/json
7585         - application/xml
7586       responses:
7587         "200":
7588           description: successful operation
7589           schema:
7590               $ref: "#/getDefinitions/availability-zones"
7591         "default":
7592           description: Response codes found in [response codes](https://wiki.onap.org/).
7593       parameters:
7594         - name: cloud-owner
7595           in: path
7596           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7597           required: true
7598           type: string
7599           example: __CLOUD-OWNER__
7600         - name: cloud-region-id
7601           in: path
7602           description: Identifier used by the vendor for the region. Second part of composite key
7603           required: true
7604           type: string
7605           example: __CLOUD-REGION-ID__
7606         - name: cloud-type
7607           in: query
7608           description: Type of the cloud (e.g., openstack)
7609           required: false
7610           type: string
7611         - name: owner-defined-type
7612           in: query
7613           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
7614           required: false
7615           type: string
7616   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/relationship-list/relationship:
7617     put:
7618       tags:
7619         - CloudInfrastructure
7620       summary: see node definition for valid relationships
7621       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship
7622       consumes:
7623         - application/json
7624         - application/xml
7625       produces:
7626         - application/json
7627         - application/xml
7628       responses:
7629         "default":
7630           description: Response codes found in [response codes](https://wiki.onap.org/).
7631       parameters:
7632         - name: cloud-owner
7633           in: path
7634           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7635           required: true
7636           type: string
7637           example: __CLOUD-OWNER__
7638         - name: cloud-region-id
7639           in: path
7640           description: Identifier used by the vendor for the region. Second part of composite key
7641           required: true
7642           type: string
7643           example: __CLOUD-REGION-ID__
7644         - name: body
7645           in: body
7646           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegion.json)
7647           required: true
7648           schema:
7649             $ref: "#/definitions/relationship"
7650     delete:
7651       tags:
7652         - CloudInfrastructure
7653       summary: delete an existing relationship
7654       description: delete an existing relationship
7655       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship
7656       consumes:
7657         - application/json
7658         - application/xml
7659       produces:
7660         - application/json
7661         - application/xml
7662       responses:
7663         "default":
7664           description: Response codes found in [response codes](https://wiki.onap.org/).
7665       parameters:
7666         - name: cloud-owner
7667           in: path
7668           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7669           required: true
7670           type: string
7671           example: __CLOUD-OWNER__
7672         - name: cloud-region-id
7673           in: path
7674           description: Identifier used by the vendor for the region. Second part of composite key
7675           required: true
7676           type: string
7677           example: __CLOUD-REGION-ID__
7678   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}:
7679     get:
7680       tags:
7681         - CloudInfrastructure
7682       summary: returns cloud-region
7683       description: returns cloud-region
7684       operationId: getCloudInfrastructureCloudRegionsCloudRegion
7685       produces:
7686         - application/json
7687         - application/xml
7688       responses:
7689         "200":
7690           description: successful operation
7691           schema:
7692               $ref: "#/getDefinitions/cloud-region"
7693         "default":
7694           description: Response codes found in [response codes](https://wiki.onap.org/).
7695       parameters:
7696         - name: cloud-owner
7697           in: path
7698           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7699           required: true
7700           type: string
7701           example: __CLOUD-OWNER__
7702         - name: cloud-region-id
7703           in: path
7704           description: Identifier used by the vendor for the region. Second part of composite key
7705           required: true
7706           type: string
7707           example: __CLOUD-REGION-ID__
7708         - name: cloud-type
7709           in: query
7710           description: Type of the cloud (e.g., openstack)
7711           required: false
7712           type: string
7713         - name: owner-defined-type
7714           in: query
7715           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
7716           required: false
7717           type: string
7718     put:
7719       tags:
7720         - CloudInfrastructure
7721       summary: create or update an existing cloud-region
7722       description: |
7723         Create or update an existing cloud-region.
7724         #
7725         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
7726       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegion
7727       consumes:
7728         - application/json
7729         - application/xml
7730       produces:
7731         - application/json
7732         - application/xml
7733       responses:
7734         "default":
7735           description: Response codes found in [response codes](https://wiki.onap.org/).
7736       parameters:
7737         - name: cloud-owner
7738           in: path
7739           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7740           required: true
7741           type: string
7742           example: __CLOUD-OWNER__
7743         - name: cloud-region-id
7744           in: path
7745           description: Identifier used by the vendor for the region. Second part of composite key
7746           required: true
7747           type: string
7748           example: __CLOUD-REGION-ID__
7749         - name: body
7750           in: body
7751           description: cloud-region object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegion.json)
7752           required: true
7753           schema:
7754             $ref: "#/definitions/cloud-region"
7755     patch:
7756       tags:
7757         - CloudInfrastructure
7758       summary: update an existing cloud-region
7759       description: |
7760         Update an existing cloud-region
7761         #
7762         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7763         The PUT operation will entirely replace an existing object.
7764         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
7765         #
7766         Other differences between PUT and PATCH are:
7767         #
7768         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
7769         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7770         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7771       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegion
7772       consumes:
7773         - application/json
7774         - application/xml
7775       produces:
7776         - application/json
7777         - application/xml
7778       responses:
7779         "default":
7780           description: Response codes found in [response codes](https://wiki.onap.org/).
7781       parameters:
7782         - name: cloud-owner
7783           in: path
7784           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7785           required: true
7786           type: string
7787           example: __CLOUD-OWNER__
7788         - name: cloud-region-id
7789           in: path
7790           description: Identifier used by the vendor for the region. Second part of composite key
7791           required: true
7792           type: string
7793           example: __CLOUD-REGION-ID__
7794         - name: body
7795           in: body
7796           description: cloud-region object that needs to be created or updated.
7797           required: true
7798           schema:
7799             $ref: "#/patchDefinitions/cloud-region"
7800     delete:
7801       tags:
7802         - CloudInfrastructure
7803       summary: delete an existing cloud-region
7804       description: delete an existing cloud-region
7805       operationId: deleteCloudInfrastructureCloudRegionsCloudRegion
7806       consumes:
7807         - application/json
7808         - application/xml
7809       produces:
7810         - application/json
7811         - application/xml
7812       responses:
7813         "default":
7814           description: Response codes found in [response codes](https://wiki.onap.org/).
7815       parameters:
7816         - name: cloud-owner
7817           in: path
7818           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7819           required: true
7820           type: string
7821           example: __CLOUD-OWNER__
7822         - name: cloud-region-id
7823           in: path
7824           description: Identifier used by the vendor for the region. Second part of composite key
7825           required: true
7826           type: string
7827           example: __CLOUD-REGION-ID__
7828         - name: resource-version
7829           in: query
7830           description: resource-version for concurrency
7831           required: true
7832           type: string
7833   /cloud-infrastructure/cloud-regions:
7834     get:
7835       tags:
7836         - CloudInfrastructure
7837       summary: returns cloud-regions
7838       description: returns cloud-regions
7839       operationId: getCloudInfrastructureCloudRegions
7840       produces:
7841         - application/json
7842         - application/xml
7843       responses:
7844         "200":
7845           description: successful operation
7846           schema:
7847               $ref: "#/getDefinitions/cloud-regions"
7848         "default":
7849           description: Response codes found in [response codes](https://wiki.onap.org/).
7850   /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship:
7851     put:
7852       tags:
7853         - CloudInfrastructure
7854       summary: see node definition for valid relationships
7855       operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship
7856       consumes:
7857         - application/json
7858         - application/xml
7859       produces:
7860         - application/json
7861         - application/xml
7862       responses:
7863         "default":
7864           description: Response codes found in [response codes](https://wiki.onap.org/).
7865       parameters:
7866         - name: nm-profile-name
7867           in: path
7868           description: Unique name of network profile.
7869           required: true
7870           type: string
7871           example: __NM-PROFILE-NAME__
7872         - name: body
7873           in: body
7874           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureNetworkProfilesNetworkProfile.json)
7875           required: true
7876           schema:
7877             $ref: "#/definitions/relationship"
7878     delete:
7879       tags:
7880         - CloudInfrastructure
7881       summary: delete an existing relationship
7882       description: delete an existing relationship
7883       operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship
7884       consumes:
7885         - application/json
7886         - application/xml
7887       produces:
7888         - application/json
7889         - application/xml
7890       responses:
7891         "default":
7892           description: Response codes found in [response codes](https://wiki.onap.org/).
7893       parameters:
7894         - name: nm-profile-name
7895           in: path
7896           description: Unique name of network profile.
7897           required: true
7898           type: string
7899           example: __NM-PROFILE-NAME__
7900   /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}:
7901     get:
7902       tags:
7903         - CloudInfrastructure
7904       summary: returns network-profile
7905       description: returns network-profile
7906       operationId: getCloudInfrastructureNetworkProfilesNetworkProfile
7907       produces:
7908         - application/json
7909         - application/xml
7910       responses:
7911         "200":
7912           description: successful operation
7913           schema:
7914               $ref: "#/getDefinitions/network-profile"
7915         "default":
7916           description: Response codes found in [response codes](https://wiki.onap.org/).
7917       parameters:
7918         - name: nm-profile-name
7919           in: path
7920           description: Unique name of network profile.
7921           required: true
7922           type: string
7923           example: __NM-PROFILE-NAME__
7924     put:
7925       tags:
7926         - CloudInfrastructure
7927       summary: create or update an existing network-profile
7928       description: |
7929         Create or update an existing network-profile.
7930         #
7931         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
7932       operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfile
7933       consumes:
7934         - application/json
7935         - application/xml
7936       produces:
7937         - application/json
7938         - application/xml
7939       responses:
7940         "default":
7941           description: Response codes found in [response codes](https://wiki.onap.org/).
7942       parameters:
7943         - name: nm-profile-name
7944           in: path
7945           description: Unique name of network profile.
7946           required: true
7947           type: string
7948           example: __NM-PROFILE-NAME__
7949         - name: body
7950           in: body
7951           description: network-profile object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureNetworkProfilesNetworkProfile.json)
7952           required: true
7953           schema:
7954             $ref: "#/definitions/network-profile"
7955     patch:
7956       tags:
7957         - CloudInfrastructure
7958       summary: update an existing network-profile
7959       description: |
7960         Update an existing network-profile
7961         #
7962         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7963         The PUT operation will entirely replace an existing object.
7964         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
7965         #
7966         Other differences between PUT and PATCH are:
7967         #
7968         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
7969         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7970         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7971       operationId: UpdateCloudInfrastructureNetworkProfilesNetworkProfile
7972       consumes:
7973         - application/json
7974         - application/xml
7975       produces:
7976         - application/json
7977         - application/xml
7978       responses:
7979         "default":
7980           description: Response codes found in [response codes](https://wiki.onap.org/).
7981       parameters:
7982         - name: nm-profile-name
7983           in: path
7984           description: Unique name of network profile.
7985           required: true
7986           type: string
7987           example: __NM-PROFILE-NAME__
7988         - name: body
7989           in: body
7990           description: network-profile object that needs to be created or updated.
7991           required: true
7992           schema:
7993             $ref: "#/patchDefinitions/network-profile"
7994     delete:
7995       tags:
7996         - CloudInfrastructure
7997       summary: delete an existing network-profile
7998       description: delete an existing network-profile
7999       operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfile
8000       consumes:
8001         - application/json
8002         - application/xml
8003       produces:
8004         - application/json
8005         - application/xml
8006       responses:
8007         "default":
8008           description: Response codes found in [response codes](https://wiki.onap.org/).
8009       parameters:
8010         - name: nm-profile-name
8011           in: path
8012           description: Unique name of network profile.
8013           required: true
8014           type: string
8015           example: __NM-PROFILE-NAME__
8016         - name: resource-version
8017           in: query
8018           description: resource-version for concurrency
8019           required: true
8020           type: string
8021   /cloud-infrastructure/network-profiles:
8022     get:
8023       tags:
8024         - CloudInfrastructure
8025       summary: returns network-profiles
8026       description: returns network-profiles
8027       operationId: getCloudInfrastructureNetworkProfiles
8028       produces:
8029         - application/json
8030         - application/xml
8031       responses:
8032         "200":
8033           description: successful operation
8034           schema:
8035               $ref: "#/getDefinitions/network-profiles"
8036         "default":
8037           description: Response codes found in [response codes](https://wiki.onap.org/).
8038   /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship:
8039     put:
8040       tags:
8041         - CloudInfrastructure
8042       summary: see node definition for valid relationships
8043       operationId: createOrUpdateCloudInfrastructurePserversPserverRelationshipListRelationship
8044       consumes:
8045         - application/json
8046         - application/xml
8047       produces:
8048         - application/json
8049         - application/xml
8050       responses:
8051         "default":
8052           description: Response codes found in [response codes](https://wiki.onap.org/).
8053       parameters:
8054         - name: hostname
8055           in: path
8056           description: Value from executing hostname on the compute node.
8057           required: true
8058           type: string
8059           example: __HOSTNAME__
8060         - name: body
8061           in: body
8062           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserver.json)
8063           required: true
8064           schema:
8065             $ref: "#/definitions/relationship"
8066     delete:
8067       tags:
8068         - CloudInfrastructure
8069       summary: delete an existing relationship
8070       description: delete an existing relationship
8071       operationId: deleteCloudInfrastructurePserversPserverRelationshipListRelationship
8072       consumes:
8073         - application/json
8074         - application/xml
8075       produces:
8076         - application/json
8077         - application/xml
8078       responses:
8079         "default":
8080           description: Response codes found in [response codes](https://wiki.onap.org/).
8081       parameters:
8082         - name: hostname
8083           in: path
8084           description: Value from executing hostname on the compute node.
8085           required: true
8086           type: string
8087           example: __HOSTNAME__
8088   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
8089     put:
8090       tags:
8091         - CloudInfrastructure
8092       summary: see node definition for valid relationships
8093       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship
8094       consumes:
8095         - application/json
8096         - application/xml
8097       produces:
8098         - application/json
8099         - application/xml
8100       responses:
8101         "default":
8102           description: Response codes found in [response codes](https://wiki.onap.org/).
8103       parameters:
8104         - name: hostname
8105           in: path
8106           description: Value from executing hostname on the compute node.
8107           required: true
8108           type: string
8109           example: __HOSTNAME__
8110         - name: interface-name
8111           in: path
8112           description: Name that identifies the physical interface
8113           required: true
8114           type: string
8115           example: __INTERFACE-NAME__
8116         - name: body
8117           in: body
8118           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterface.json)
8119           required: true
8120           schema:
8121             $ref: "#/definitions/relationship"
8122     delete:
8123       tags:
8124         - CloudInfrastructure
8125       summary: delete an existing relationship
8126       description: delete an existing relationship
8127       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship
8128       consumes:
8129         - application/json
8130         - application/xml
8131       produces:
8132         - application/json
8133         - application/xml
8134       responses:
8135         "default":
8136           description: Response codes found in [response codes](https://wiki.onap.org/).
8137       parameters:
8138         - name: hostname
8139           in: path
8140           description: Value from executing hostname on the compute node.
8141           required: true
8142           type: string
8143           example: __HOSTNAME__
8144         - name: interface-name
8145           in: path
8146           description: Name that identifies the physical interface
8147           required: true
8148           type: string
8149           example: __INTERFACE-NAME__
8150   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
8151     put:
8152       tags:
8153         - CloudInfrastructure
8154       summary: see node definition for valid relationships
8155       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
8156       consumes:
8157         - application/json
8158         - application/xml
8159       produces:
8160         - application/json
8161         - application/xml
8162       responses:
8163         "default":
8164           description: Response codes found in [response codes](https://wiki.onap.org/).
8165       parameters:
8166         - name: hostname
8167           in: path
8168           description: Value from executing hostname on the compute node.
8169           required: true
8170           type: string
8171           example: __HOSTNAME__
8172         - name: interface-name
8173           in: path
8174           description: Name that identifies the physical interface
8175           required: true
8176           type: string
8177           example: __INTERFACE-NAME__
8178         - name: interface-name
8179           in: path
8180           description: Name given to the interface
8181           required: true
8182           type: string
8183           example: __INTERFACE-NAME__
8184         - name: vlan-interface
8185           in: path
8186           description: String that identifies the interface
8187           required: true
8188           type: string
8189           example: __VLAN-INTERFACE__
8190         - name: body
8191           in: body
8192           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
8193           required: true
8194           schema:
8195             $ref: "#/definitions/relationship"
8196     delete:
8197       tags:
8198         - CloudInfrastructure
8199       summary: delete an existing relationship
8200       description: delete an existing relationship
8201       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
8202       consumes:
8203         - application/json
8204         - application/xml
8205       produces:
8206         - application/json
8207         - application/xml
8208       responses:
8209         "default":
8210           description: Response codes found in [response codes](https://wiki.onap.org/).
8211       parameters:
8212         - name: hostname
8213           in: path
8214           description: Value from executing hostname on the compute node.
8215           required: true
8216           type: string
8217           example: __HOSTNAME__
8218         - name: interface-name
8219           in: path
8220           description: Name that identifies the physical interface
8221           required: true
8222           type: string
8223           example: __INTERFACE-NAME__
8224         - name: interface-name
8225           in: path
8226           description: Name given to the interface
8227           required: true
8228           type: string
8229           example: __INTERFACE-NAME__
8230         - name: vlan-interface
8231           in: path
8232           description: String that identifies the interface
8233           required: true
8234           type: string
8235           example: __VLAN-INTERFACE__
8236   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
8237     put:
8238       tags:
8239         - CloudInfrastructure
8240       summary: see node definition for valid relationships
8241       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
8242       consumes:
8243         - application/json
8244         - application/xml
8245       produces:
8246         - application/json
8247         - application/xml
8248       responses:
8249         "default":
8250           description: Response codes found in [response codes](https://wiki.onap.org/).
8251       parameters:
8252         - name: hostname
8253           in: path
8254           description: Value from executing hostname on the compute node.
8255           required: true
8256           type: string
8257           example: __HOSTNAME__
8258         - name: interface-name
8259           in: path
8260           description: Name that identifies the physical interface
8261           required: true
8262           type: string
8263           example: __INTERFACE-NAME__
8264         - name: interface-name
8265           in: path
8266           description: Name given to the interface
8267           required: true
8268           type: string
8269           example: __INTERFACE-NAME__
8270         - name: vlan-interface
8271           in: path
8272           description: String that identifies the interface
8273           required: true
8274           type: string
8275           example: __VLAN-INTERFACE__
8276         - name: l3-interface-ipv4-address
8277           in: path
8278           description: IP address
8279           required: true
8280           type: string
8281           example: __L3-INTERFACE-IPV4-ADDRESS__
8282         - name: body
8283           in: body
8284           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
8285           required: true
8286           schema:
8287             $ref: "#/definitions/relationship"
8288     delete:
8289       tags:
8290         - CloudInfrastructure
8291       summary: delete an existing relationship
8292       description: delete an existing relationship
8293       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
8294       consumes:
8295         - application/json
8296         - application/xml
8297       produces:
8298         - application/json
8299         - application/xml
8300       responses:
8301         "default":
8302           description: Response codes found in [response codes](https://wiki.onap.org/).
8303       parameters:
8304         - name: hostname
8305           in: path
8306           description: Value from executing hostname on the compute node.
8307           required: true
8308           type: string
8309           example: __HOSTNAME__
8310         - name: interface-name
8311           in: path
8312           description: Name that identifies the physical interface
8313           required: true
8314           type: string
8315           example: __INTERFACE-NAME__
8316         - name: interface-name
8317           in: path
8318           description: Name given to the interface
8319           required: true
8320           type: string
8321           example: __INTERFACE-NAME__
8322         - name: vlan-interface
8323           in: path
8324           description: String that identifies the interface
8325           required: true
8326           type: string
8327           example: __VLAN-INTERFACE__
8328         - name: l3-interface-ipv4-address
8329           in: path
8330           description: IP address
8331           required: true
8332           type: string
8333           example: __L3-INTERFACE-IPV4-ADDRESS__
8334   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
8335     get:
8336       tags:
8337         - CloudInfrastructure
8338       summary: returns l3-interface-ipv4-address-list
8339       description: returns l3-interface-ipv4-address-list
8340       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
8341       produces:
8342         - application/json
8343         - application/xml
8344       responses:
8345         "200":
8346           description: successful operation
8347           schema:
8348               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
8349         "default":
8350           description: Response codes found in [response codes](https://wiki.onap.org/).
8351       parameters:
8352         - name: hostname
8353           in: path
8354           description: Value from executing hostname on the compute node.
8355           required: true
8356           type: string
8357           example: __HOSTNAME__
8358         - name: interface-name
8359           in: path
8360           description: Name that identifies the physical interface
8361           required: true
8362           type: string
8363           example: __INTERFACE-NAME__
8364         - name: interface-name
8365           in: path
8366           description: Name given to the interface
8367           required: true
8368           type: string
8369           example: __INTERFACE-NAME__
8370         - name: vlan-interface
8371           in: path
8372           description: String that identifies the interface
8373           required: true
8374           type: string
8375           example: __VLAN-INTERFACE__
8376         - name: l3-interface-ipv4-address
8377           in: path
8378           description: IP address
8379           required: true
8380           type: string
8381           example: __L3-INTERFACE-IPV4-ADDRESS__
8382         - name: inv-status
8383           in: query
8384           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
8385           required: false
8386           type: string
8387         - name: pserver-id
8388           in: query
8389           description: ID of Pserver
8390           required: false
8391           type: string
8392         - name: in-maint
8393           in: query
8394           required: false
8395           type: boolean
8396         - name: pserver-name2
8397           in: query
8398           description: alternative pserver name
8399           required: false
8400           type: string
8401         - name: prov-status
8402           in: query
8403           description: Trigger for operational monitoring of this resource by Service Assurance systems.
8404           required: false
8405           type: string
8406         - name: interface-id
8407           in: query
8408           description: ID of interface
8409           required: false
8410           type: string
8411         - name: macaddr
8412           in: query
8413           description: MAC address for the interface
8414           required: false
8415           type: string
8416         - name: network-name
8417           in: query
8418           description: Name of the network
8419           required: false
8420           type: string
8421         - name: vlan-id-inner
8422           in: query
8423           description: Inner VLAN tag
8424           required: false
8425           type: integer
8426           format: int64
8427         - name: vpn-id
8428           in: query
8429           description: This indicates the customers VPN ID associated with this vlan
8430           required: false
8431           type: string
8432         - name: vlan-id-inner
8433           in: query
8434           description: Inner VLAN tag
8435           required: false
8436           type: integer
8437           format: int64
8438         - name: neutron-network-id
8439           in: query
8440           description: Neutron network id of the interface that address belongs to
8441           required: false
8442           type: string
8443         - name: neutron-subnet-id
8444           in: query
8445           description: Neutron id of subnet that address belongs to
8446           required: false
8447           type: string
8448     put:
8449       tags:
8450         - CloudInfrastructure
8451       summary: create or update an existing l3-interface-ipv4-address-list
8452       description: |
8453         Create or update an existing l3-interface-ipv4-address-list.
8454         #
8455         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
8456       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
8457       consumes:
8458         - application/json
8459         - application/xml
8460       produces:
8461         - application/json
8462         - application/xml
8463       responses:
8464         "default":
8465           description: Response codes found in [response codes](https://wiki.onap.org/).
8466       parameters:
8467         - name: hostname
8468           in: path
8469           description: Value from executing hostname on the compute node.
8470           required: true
8471           type: string
8472           example: __HOSTNAME__
8473         - name: interface-name
8474           in: path
8475           description: Name that identifies the physical interface
8476           required: true
8477           type: string
8478           example: __INTERFACE-NAME__
8479         - name: interface-name
8480           in: path
8481           description: Name given to the interface
8482           required: true
8483           type: string
8484           example: __INTERFACE-NAME__
8485         - name: vlan-interface
8486           in: path
8487           description: String that identifies the interface
8488           required: true
8489           type: string
8490           example: __VLAN-INTERFACE__
8491         - name: l3-interface-ipv4-address
8492           in: path
8493           description: IP address
8494           required: true
8495           type: string
8496           example: __L3-INTERFACE-IPV4-ADDRESS__
8497         - name: body
8498           in: body
8499           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
8500           required: true
8501           schema:
8502             $ref: "#/definitions/l3-interface-ipv4-address-list"
8503     patch:
8504       tags:
8505         - CloudInfrastructure
8506       summary: update an existing l3-interface-ipv4-address-list
8507       description: |
8508         Update an existing l3-interface-ipv4-address-list
8509         #
8510         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8511         The PUT operation will entirely replace an existing object.
8512         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
8513         #
8514         Other differences between PUT and PATCH are:
8515         #
8516         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
8517         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8518         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8519       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
8520       consumes:
8521         - application/json
8522         - application/xml
8523       produces:
8524         - application/json
8525         - application/xml
8526       responses:
8527         "default":
8528           description: Response codes found in [response codes](https://wiki.onap.org/).
8529       parameters:
8530         - name: hostname
8531           in: path
8532           description: Value from executing hostname on the compute node.
8533           required: true
8534           type: string
8535           example: __HOSTNAME__
8536         - name: interface-name
8537           in: path
8538           description: Name that identifies the physical interface
8539           required: true
8540           type: string
8541           example: __INTERFACE-NAME__
8542         - name: interface-name
8543           in: path
8544           description: Name given to the interface
8545           required: true
8546           type: string
8547           example: __INTERFACE-NAME__
8548         - name: vlan-interface
8549           in: path
8550           description: String that identifies the interface
8551           required: true
8552           type: string
8553           example: __VLAN-INTERFACE__
8554         - name: l3-interface-ipv4-address
8555           in: path
8556           description: IP address
8557           required: true
8558           type: string
8559           example: __L3-INTERFACE-IPV4-ADDRESS__
8560         - name: body
8561           in: body
8562           description: l3-interface-ipv4-address-list object that needs to be created or updated.
8563           required: true
8564           schema:
8565             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
8566     delete:
8567       tags:
8568         - CloudInfrastructure
8569       summary: delete an existing l3-interface-ipv4-address-list
8570       description: delete an existing l3-interface-ipv4-address-list
8571       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
8572       consumes:
8573         - application/json
8574         - application/xml
8575       produces:
8576         - application/json
8577         - application/xml
8578       responses:
8579         "default":
8580           description: Response codes found in [response codes](https://wiki.onap.org/).
8581       parameters:
8582         - name: hostname
8583           in: path
8584           description: Value from executing hostname on the compute node.
8585           required: true
8586           type: string
8587           example: __HOSTNAME__
8588         - name: interface-name
8589           in: path
8590           description: Name that identifies the physical interface
8591           required: true
8592           type: string
8593           example: __INTERFACE-NAME__
8594         - name: interface-name
8595           in: path
8596           description: Name given to the interface
8597           required: true
8598           type: string
8599           example: __INTERFACE-NAME__
8600         - name: vlan-interface
8601           in: path
8602           description: String that identifies the interface
8603           required: true
8604           type: string
8605           example: __VLAN-INTERFACE__
8606         - name: l3-interface-ipv4-address
8607           in: path
8608           description: IP address
8609           required: true
8610           type: string
8611           example: __L3-INTERFACE-IPV4-ADDRESS__
8612         - name: resource-version
8613           in: query
8614           description: resource-version for concurrency
8615           required: true
8616           type: string
8617   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
8618     put:
8619       tags:
8620         - CloudInfrastructure
8621       summary: see node definition for valid relationships
8622       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
8623       consumes:
8624         - application/json
8625         - application/xml
8626       produces:
8627         - application/json
8628         - application/xml
8629       responses:
8630         "default":
8631           description: Response codes found in [response codes](https://wiki.onap.org/).
8632       parameters:
8633         - name: hostname
8634           in: path
8635           description: Value from executing hostname on the compute node.
8636           required: true
8637           type: string
8638           example: __HOSTNAME__
8639         - name: interface-name
8640           in: path
8641           description: Name that identifies the physical interface
8642           required: true
8643           type: string
8644           example: __INTERFACE-NAME__
8645         - name: interface-name
8646           in: path
8647           description: Name given to the interface
8648           required: true
8649           type: string
8650           example: __INTERFACE-NAME__
8651         - name: vlan-interface
8652           in: path
8653           description: String that identifies the interface
8654           required: true
8655           type: string
8656           example: __VLAN-INTERFACE__
8657         - name: l3-interface-ipv6-address
8658           in: path
8659           description: IP address
8660           required: true
8661           type: string
8662           example: __L3-INTERFACE-IPV6-ADDRESS__
8663         - name: body
8664           in: body
8665           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
8666           required: true
8667           schema:
8668             $ref: "#/definitions/relationship"
8669     delete:
8670       tags:
8671         - CloudInfrastructure
8672       summary: delete an existing relationship
8673       description: delete an existing relationship
8674       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
8675       consumes:
8676         - application/json
8677         - application/xml
8678       produces:
8679         - application/json
8680         - application/xml
8681       responses:
8682         "default":
8683           description: Response codes found in [response codes](https://wiki.onap.org/).
8684       parameters:
8685         - name: hostname
8686           in: path
8687           description: Value from executing hostname on the compute node.
8688           required: true
8689           type: string
8690           example: __HOSTNAME__
8691         - name: interface-name
8692           in: path
8693           description: Name that identifies the physical interface
8694           required: true
8695           type: string
8696           example: __INTERFACE-NAME__
8697         - name: interface-name
8698           in: path
8699           description: Name given to the interface
8700           required: true
8701           type: string
8702           example: __INTERFACE-NAME__
8703         - name: vlan-interface
8704           in: path
8705           description: String that identifies the interface
8706           required: true
8707           type: string
8708           example: __VLAN-INTERFACE__
8709         - name: l3-interface-ipv6-address
8710           in: path
8711           description: IP address
8712           required: true
8713           type: string
8714           example: __L3-INTERFACE-IPV6-ADDRESS__
8715   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
8716     get:
8717       tags:
8718         - CloudInfrastructure
8719       summary: returns l3-interface-ipv6-address-list
8720       description: returns l3-interface-ipv6-address-list
8721       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
8722       produces:
8723         - application/json
8724         - application/xml
8725       responses:
8726         "200":
8727           description: successful operation
8728           schema:
8729               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
8730         "default":
8731           description: Response codes found in [response codes](https://wiki.onap.org/).
8732       parameters:
8733         - name: hostname
8734           in: path
8735           description: Value from executing hostname on the compute node.
8736           required: true
8737           type: string
8738           example: __HOSTNAME__
8739         - name: interface-name
8740           in: path
8741           description: Name that identifies the physical interface
8742           required: true
8743           type: string
8744           example: __INTERFACE-NAME__
8745         - name: interface-name
8746           in: path
8747           description: Name given to the interface
8748           required: true
8749           type: string
8750           example: __INTERFACE-NAME__
8751         - name: vlan-interface
8752           in: path
8753           description: String that identifies the interface
8754           required: true
8755           type: string
8756           example: __VLAN-INTERFACE__
8757         - name: l3-interface-ipv6-address
8758           in: path
8759           description: IP address
8760           required: true
8761           type: string
8762           example: __L3-INTERFACE-IPV6-ADDRESS__
8763         - name: inv-status
8764           in: query
8765           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
8766           required: false
8767           type: string
8768         - name: pserver-id
8769           in: query
8770           description: ID of Pserver
8771           required: false
8772           type: string
8773         - name: in-maint
8774           in: query
8775           required: false
8776           type: boolean
8777         - name: pserver-name2
8778           in: query
8779           description: alternative pserver name
8780           required: false
8781           type: string
8782         - name: prov-status
8783           in: query
8784           description: Trigger for operational monitoring of this resource by Service Assurance systems.
8785           required: false
8786           type: string
8787         - name: interface-id
8788           in: query
8789           description: ID of interface
8790           required: false
8791           type: string
8792         - name: macaddr
8793           in: query
8794           description: MAC address for the interface
8795           required: false
8796           type: string
8797         - name: network-name
8798           in: query
8799           description: Name of the network
8800           required: false
8801           type: string
8802         - name: vlan-id-inner
8803           in: query
8804           description: Inner VLAN tag
8805           required: false
8806           type: integer
8807           format: int64
8808         - name: vpn-id
8809           in: query
8810           description: This indicates the customers VPN ID associated with this vlan
8811           required: false
8812           type: string
8813         - name: vlan-id-inner
8814           in: query
8815           description: Inner VLAN tag
8816           required: false
8817           type: integer
8818           format: int64
8819         - name: neutron-network-id
8820           in: query
8821           description: Neutron network id of the interface that address belongs to
8822           required: false
8823           type: string
8824         - name: neutron-subnet-id
8825           in: query
8826           description: Neutron id of subnet that address belongs to
8827           required: false
8828           type: string
8829     put:
8830       tags:
8831         - CloudInfrastructure
8832       summary: create or update an existing l3-interface-ipv6-address-list
8833       description: |
8834         Create or update an existing l3-interface-ipv6-address-list.
8835         #
8836         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
8837       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
8838       consumes:
8839         - application/json
8840         - application/xml
8841       produces:
8842         - application/json
8843         - application/xml
8844       responses:
8845         "default":
8846           description: Response codes found in [response codes](https://wiki.onap.org/).
8847       parameters:
8848         - name: hostname
8849           in: path
8850           description: Value from executing hostname on the compute node.
8851           required: true
8852           type: string
8853           example: __HOSTNAME__
8854         - name: interface-name
8855           in: path
8856           description: Name that identifies the physical interface
8857           required: true
8858           type: string
8859           example: __INTERFACE-NAME__
8860         - name: interface-name
8861           in: path
8862           description: Name given to the interface
8863           required: true
8864           type: string
8865           example: __INTERFACE-NAME__
8866         - name: vlan-interface
8867           in: path
8868           description: String that identifies the interface
8869           required: true
8870           type: string
8871           example: __VLAN-INTERFACE__
8872         - name: l3-interface-ipv6-address
8873           in: path
8874           description: IP address
8875           required: true
8876           type: string
8877           example: __L3-INTERFACE-IPV6-ADDRESS__
8878         - name: body
8879           in: body
8880           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
8881           required: true
8882           schema:
8883             $ref: "#/definitions/l3-interface-ipv6-address-list"
8884     patch:
8885       tags:
8886         - CloudInfrastructure
8887       summary: update an existing l3-interface-ipv6-address-list
8888       description: |
8889         Update an existing l3-interface-ipv6-address-list
8890         #
8891         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8892         The PUT operation will entirely replace an existing object.
8893         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
8894         #
8895         Other differences between PUT and PATCH are:
8896         #
8897         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
8898         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8899         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8900       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
8901       consumes:
8902         - application/json
8903         - application/xml
8904       produces:
8905         - application/json
8906         - application/xml
8907       responses:
8908         "default":
8909           description: Response codes found in [response codes](https://wiki.onap.org/).
8910       parameters:
8911         - name: hostname
8912           in: path
8913           description: Value from executing hostname on the compute node.
8914           required: true
8915           type: string
8916           example: __HOSTNAME__
8917         - name: interface-name
8918           in: path
8919           description: Name that identifies the physical interface
8920           required: true
8921           type: string
8922           example: __INTERFACE-NAME__
8923         - name: interface-name
8924           in: path
8925           description: Name given to the interface
8926           required: true
8927           type: string
8928           example: __INTERFACE-NAME__
8929         - name: vlan-interface
8930           in: path
8931           description: String that identifies the interface
8932           required: true
8933           type: string
8934           example: __VLAN-INTERFACE__
8935         - name: l3-interface-ipv6-address
8936           in: path
8937           description: IP address
8938           required: true
8939           type: string
8940           example: __L3-INTERFACE-IPV6-ADDRESS__
8941         - name: body
8942           in: body
8943           description: l3-interface-ipv6-address-list object that needs to be created or updated.
8944           required: true
8945           schema:
8946             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
8947     delete:
8948       tags:
8949         - CloudInfrastructure
8950       summary: delete an existing l3-interface-ipv6-address-list
8951       description: delete an existing l3-interface-ipv6-address-list
8952       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
8953       consumes:
8954         - application/json
8955         - application/xml
8956       produces:
8957         - application/json
8958         - application/xml
8959       responses:
8960         "default":
8961           description: Response codes found in [response codes](https://wiki.onap.org/).
8962       parameters:
8963         - name: hostname
8964           in: path
8965           description: Value from executing hostname on the compute node.
8966           required: true
8967           type: string
8968           example: __HOSTNAME__
8969         - name: interface-name
8970           in: path
8971           description: Name that identifies the physical interface
8972           required: true
8973           type: string
8974           example: __INTERFACE-NAME__
8975         - name: interface-name
8976           in: path
8977           description: Name given to the interface
8978           required: true
8979           type: string
8980           example: __INTERFACE-NAME__
8981         - name: vlan-interface
8982           in: path
8983           description: String that identifies the interface
8984           required: true
8985           type: string
8986           example: __VLAN-INTERFACE__
8987         - name: l3-interface-ipv6-address
8988           in: path
8989           description: IP address
8990           required: true
8991           type: string
8992           example: __L3-INTERFACE-IPV6-ADDRESS__
8993         - name: resource-version
8994           in: query
8995           description: resource-version for concurrency
8996           required: true
8997           type: string
8998   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
8999     get:
9000       tags:
9001         - CloudInfrastructure
9002       summary: returns vlan
9003       description: returns vlan
9004       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
9005       produces:
9006         - application/json
9007         - application/xml
9008       responses:
9009         "200":
9010           description: successful operation
9011           schema:
9012               $ref: "#/getDefinitions/vlan"
9013         "default":
9014           description: Response codes found in [response codes](https://wiki.onap.org/).
9015       parameters:
9016         - name: hostname
9017           in: path
9018           description: Value from executing hostname on the compute node.
9019           required: true
9020           type: string
9021           example: __HOSTNAME__
9022         - name: interface-name
9023           in: path
9024           description: Name that identifies the physical interface
9025           required: true
9026           type: string
9027           example: __INTERFACE-NAME__
9028         - name: interface-name
9029           in: path
9030           description: Name given to the interface
9031           required: true
9032           type: string
9033           example: __INTERFACE-NAME__
9034         - name: vlan-interface
9035           in: path
9036           description: String that identifies the interface
9037           required: true
9038           type: string
9039           example: __VLAN-INTERFACE__
9040         - name: inv-status
9041           in: query
9042           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
9043           required: false
9044           type: string
9045         - name: pserver-id
9046           in: query
9047           description: ID of Pserver
9048           required: false
9049           type: string
9050         - name: in-maint
9051           in: query
9052           required: false
9053           type: boolean
9054         - name: pserver-name2
9055           in: query
9056           description: alternative pserver name
9057           required: false
9058           type: string
9059         - name: prov-status
9060           in: query
9061           description: Trigger for operational monitoring of this resource by Service Assurance systems.
9062           required: false
9063           type: string
9064         - name: interface-id
9065           in: query
9066           description: ID of interface
9067           required: false
9068           type: string
9069         - name: macaddr
9070           in: query
9071           description: MAC address for the interface
9072           required: false
9073           type: string
9074         - name: network-name
9075           in: query
9076           description: Name of the network
9077           required: false
9078           type: string
9079         - name: vlan-id-inner
9080           in: query
9081           description: Inner VLAN tag
9082           required: false
9083           type: integer
9084           format: int64
9085         - name: vpn-id
9086           in: query
9087           description: This indicates the customers VPN ID associated with this vlan
9088           required: false
9089           type: string
9090     put:
9091       tags:
9092         - CloudInfrastructure
9093       summary: create or update an existing vlan
9094       description: |
9095         Create or update an existing vlan.
9096         #
9097         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
9098       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
9099       consumes:
9100         - application/json
9101         - application/xml
9102       produces:
9103         - application/json
9104         - application/xml
9105       responses:
9106         "default":
9107           description: Response codes found in [response codes](https://wiki.onap.org/).
9108       parameters:
9109         - name: hostname
9110           in: path
9111           description: Value from executing hostname on the compute node.
9112           required: true
9113           type: string
9114           example: __HOSTNAME__
9115         - name: interface-name
9116           in: path
9117           description: Name that identifies the physical interface
9118           required: true
9119           type: string
9120           example: __INTERFACE-NAME__
9121         - name: interface-name
9122           in: path
9123           description: Name given to the interface
9124           required: true
9125           type: string
9126           example: __INTERFACE-NAME__
9127         - name: vlan-interface
9128           in: path
9129           description: String that identifies the interface
9130           required: true
9131           type: string
9132           example: __VLAN-INTERFACE__
9133         - name: body
9134           in: body
9135           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
9136           required: true
9137           schema:
9138             $ref: "#/definitions/vlan"
9139     patch:
9140       tags:
9141         - CloudInfrastructure
9142       summary: update an existing vlan
9143       description: |
9144         Update an existing vlan
9145         #
9146         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9147         The PUT operation will entirely replace an existing object.
9148         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
9149         #
9150         Other differences between PUT and PATCH are:
9151         #
9152         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
9153         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9154         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9155       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
9156       consumes:
9157         - application/json
9158         - application/xml
9159       produces:
9160         - application/json
9161         - application/xml
9162       responses:
9163         "default":
9164           description: Response codes found in [response codes](https://wiki.onap.org/).
9165       parameters:
9166         - name: hostname
9167           in: path
9168           description: Value from executing hostname on the compute node.
9169           required: true
9170           type: string
9171           example: __HOSTNAME__
9172         - name: interface-name
9173           in: path
9174           description: Name that identifies the physical interface
9175           required: true
9176           type: string
9177           example: __INTERFACE-NAME__
9178         - name: interface-name
9179           in: path
9180           description: Name given to the interface
9181           required: true
9182           type: string
9183           example: __INTERFACE-NAME__
9184         - name: vlan-interface
9185           in: path
9186           description: String that identifies the interface
9187           required: true
9188           type: string
9189           example: __VLAN-INTERFACE__
9190         - name: body
9191           in: body
9192           description: vlan object that needs to be created or updated.
9193           required: true
9194           schema:
9195             $ref: "#/patchDefinitions/vlan"
9196     delete:
9197       tags:
9198         - CloudInfrastructure
9199       summary: delete an existing vlan
9200       description: delete an existing vlan
9201       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
9202       consumes:
9203         - application/json
9204         - application/xml
9205       produces:
9206         - application/json
9207         - application/xml
9208       responses:
9209         "default":
9210           description: Response codes found in [response codes](https://wiki.onap.org/).
9211       parameters:
9212         - name: hostname
9213           in: path
9214           description: Value from executing hostname on the compute node.
9215           required: true
9216           type: string
9217           example: __HOSTNAME__
9218         - name: interface-name
9219           in: path
9220           description: Name that identifies the physical interface
9221           required: true
9222           type: string
9223           example: __INTERFACE-NAME__
9224         - name: interface-name
9225           in: path
9226           description: Name given to the interface
9227           required: true
9228           type: string
9229           example: __INTERFACE-NAME__
9230         - name: vlan-interface
9231           in: path
9232           description: String that identifies the interface
9233           required: true
9234           type: string
9235           example: __VLAN-INTERFACE__
9236         - name: resource-version
9237           in: query
9238           description: resource-version for concurrency
9239           required: true
9240           type: string
9241   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
9242     get:
9243       tags:
9244         - CloudInfrastructure
9245       summary: returns vlans
9246       description: returns vlans
9247       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlans
9248       produces:
9249         - application/json
9250         - application/xml
9251       responses:
9252         "200":
9253           description: successful operation
9254           schema:
9255               $ref: "#/getDefinitions/vlans"
9256         "default":
9257           description: Response codes found in [response codes](https://wiki.onap.org/).
9258       parameters:
9259         - name: hostname
9260           in: path
9261           description: Value from executing hostname on the compute node.
9262           required: true
9263           type: string
9264           example: __HOSTNAME__
9265         - name: interface-name
9266           in: path
9267           description: Name that identifies the physical interface
9268           required: true
9269           type: string
9270           example: __INTERFACE-NAME__
9271         - name: interface-name
9272           in: path
9273           description: Name given to the interface
9274           required: true
9275           type: string
9276           example: __INTERFACE-NAME__
9277         - name: inv-status
9278           in: query
9279           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
9280           required: false
9281           type: string
9282         - name: pserver-id
9283           in: query
9284           description: ID of Pserver
9285           required: false
9286           type: string
9287         - name: in-maint
9288           in: query
9289           required: false
9290           type: boolean
9291         - name: pserver-name2
9292           in: query
9293           description: alternative pserver name
9294           required: false
9295           type: string
9296         - name: prov-status
9297           in: query
9298           description: Trigger for operational monitoring of this resource by Service Assurance systems.
9299           required: false
9300           type: string
9301         - name: interface-id
9302           in: query
9303           description: ID of interface
9304           required: false
9305           type: string
9306         - name: macaddr
9307           in: query
9308           description: MAC address for the interface
9309           required: false
9310           type: string
9311         - name: network-name
9312           in: query
9313           description: Name of the network
9314           required: false
9315           type: string
9316   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
9317     put:
9318       tags:
9319         - CloudInfrastructure
9320       summary: see node definition for valid relationships
9321       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
9322       consumes:
9323         - application/json
9324         - application/xml
9325       produces:
9326         - application/json
9327         - application/xml
9328       responses:
9329         "default":
9330           description: Response codes found in [response codes](https://wiki.onap.org/).
9331       parameters:
9332         - name: hostname
9333           in: path
9334           description: Value from executing hostname on the compute node.
9335           required: true
9336           type: string
9337           example: __HOSTNAME__
9338         - name: interface-name
9339           in: path
9340           description: Name that identifies the physical interface
9341           required: true
9342           type: string
9343           example: __INTERFACE-NAME__
9344         - name: interface-name
9345           in: path
9346           description: Name given to the interface
9347           required: true
9348           type: string
9349           example: __INTERFACE-NAME__
9350         - name: pci-id
9351           in: path
9352           description: PCI ID used to identify the sriov-vf
9353           required: true
9354           type: string
9355           example: __PCI-ID__
9356         - name: body
9357           in: body
9358           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
9359           required: true
9360           schema:
9361             $ref: "#/definitions/relationship"
9362     delete:
9363       tags:
9364         - CloudInfrastructure
9365       summary: delete an existing relationship
9366       description: delete an existing relationship
9367       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
9368       consumes:
9369         - application/json
9370         - application/xml
9371       produces:
9372         - application/json
9373         - application/xml
9374       responses:
9375         "default":
9376           description: Response codes found in [response codes](https://wiki.onap.org/).
9377       parameters:
9378         - name: hostname
9379           in: path
9380           description: Value from executing hostname on the compute node.
9381           required: true
9382           type: string
9383           example: __HOSTNAME__
9384         - name: interface-name
9385           in: path
9386           description: Name that identifies the physical interface
9387           required: true
9388           type: string
9389           example: __INTERFACE-NAME__
9390         - name: interface-name
9391           in: path
9392           description: Name given to the interface
9393           required: true
9394           type: string
9395           example: __INTERFACE-NAME__
9396         - name: pci-id
9397           in: path
9398           description: PCI ID used to identify the sriov-vf
9399           required: true
9400           type: string
9401           example: __PCI-ID__
9402   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
9403     get:
9404       tags:
9405         - CloudInfrastructure
9406       summary: returns sriov-vf
9407       description: returns sriov-vf
9408       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
9409       produces:
9410         - application/json
9411         - application/xml
9412       responses:
9413         "200":
9414           description: successful operation
9415           schema:
9416               $ref: "#/getDefinitions/sriov-vf"
9417         "default":
9418           description: Response codes found in [response codes](https://wiki.onap.org/).
9419       parameters:
9420         - name: hostname
9421           in: path
9422           description: Value from executing hostname on the compute node.
9423           required: true
9424           type: string
9425           example: __HOSTNAME__
9426         - name: interface-name
9427           in: path
9428           description: Name that identifies the physical interface
9429           required: true
9430           type: string
9431           example: __INTERFACE-NAME__
9432         - name: interface-name
9433           in: path
9434           description: Name given to the interface
9435           required: true
9436           type: string
9437           example: __INTERFACE-NAME__
9438         - name: pci-id
9439           in: path
9440           description: PCI ID used to identify the sriov-vf
9441           required: true
9442           type: string
9443           example: __PCI-ID__
9444         - name: inv-status
9445           in: query
9446           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
9447           required: false
9448           type: string
9449         - name: pserver-id
9450           in: query
9451           description: ID of Pserver
9452           required: false
9453           type: string
9454         - name: in-maint
9455           in: query
9456           required: false
9457           type: boolean
9458         - name: pserver-name2
9459           in: query
9460           description: alternative pserver name
9461           required: false
9462           type: string
9463         - name: prov-status
9464           in: query
9465           description: Trigger for operational monitoring of this resource by Service Assurance systems.
9466           required: false
9467           type: string
9468         - name: interface-id
9469           in: query
9470           description: ID of interface
9471           required: false
9472           type: string
9473         - name: macaddr
9474           in: query
9475           description: MAC address for the interface
9476           required: false
9477           type: string
9478         - name: network-name
9479           in: query
9480           description: Name of the network
9481           required: false
9482           type: string
9483         - name: vf-vlan-filter
9484           in: query
9485           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
9486           required: false
9487           type: string
9488         - name: vf-mac-filter
9489           in: query
9490           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
9491           required: false
9492           type: string
9493         - name: vf-vlan-strip
9494           in: query
9495           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
9496           required: false
9497           type: boolean
9498         - name: neutron-network-id
9499           in: query
9500           description: Neutron network id of the interface
9501           required: false
9502           type: string
9503     put:
9504       tags:
9505         - CloudInfrastructure
9506       summary: create or update an existing sriov-vf
9507       description: |
9508         Create or update an existing sriov-vf.
9509         #
9510         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
9511       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
9512       consumes:
9513         - application/json
9514         - application/xml
9515       produces:
9516         - application/json
9517         - application/xml
9518       responses:
9519         "default":
9520           description: Response codes found in [response codes](https://wiki.onap.org/).
9521       parameters:
9522         - name: hostname
9523           in: path
9524           description: Value from executing hostname on the compute node.
9525           required: true
9526           type: string
9527           example: __HOSTNAME__
9528         - name: interface-name
9529           in: path
9530           description: Name that identifies the physical interface
9531           required: true
9532           type: string
9533           example: __INTERFACE-NAME__
9534         - name: interface-name
9535           in: path
9536           description: Name given to the interface
9537           required: true
9538           type: string
9539           example: __INTERFACE-NAME__
9540         - name: pci-id
9541           in: path
9542           description: PCI ID used to identify the sriov-vf
9543           required: true
9544           type: string
9545           example: __PCI-ID__
9546         - name: body
9547           in: body
9548           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
9549           required: true
9550           schema:
9551             $ref: "#/definitions/sriov-vf"
9552     patch:
9553       tags:
9554         - CloudInfrastructure
9555       summary: update an existing sriov-vf
9556       description: |
9557         Update an existing sriov-vf
9558         #
9559         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9560         The PUT operation will entirely replace an existing object.
9561         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
9562         #
9563         Other differences between PUT and PATCH are:
9564         #
9565         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
9566         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9567         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9568       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
9569       consumes:
9570         - application/json
9571         - application/xml
9572       produces:
9573         - application/json
9574         - application/xml
9575       responses:
9576         "default":
9577           description: Response codes found in [response codes](https://wiki.onap.org/).
9578       parameters:
9579         - name: hostname
9580           in: path
9581           description: Value from executing hostname on the compute node.
9582           required: true
9583           type: string
9584           example: __HOSTNAME__
9585         - name: interface-name
9586           in: path
9587           description: Name that identifies the physical interface
9588           required: true
9589           type: string
9590           example: __INTERFACE-NAME__
9591         - name: interface-name
9592           in: path
9593           description: Name given to the interface
9594           required: true
9595           type: string
9596           example: __INTERFACE-NAME__
9597         - name: pci-id
9598           in: path
9599           description: PCI ID used to identify the sriov-vf
9600           required: true
9601           type: string
9602           example: __PCI-ID__
9603         - name: body
9604           in: body
9605           description: sriov-vf object that needs to be created or updated.
9606           required: true
9607           schema:
9608             $ref: "#/patchDefinitions/sriov-vf"
9609     delete:
9610       tags:
9611         - CloudInfrastructure
9612       summary: delete an existing sriov-vf
9613       description: delete an existing sriov-vf
9614       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
9615       consumes:
9616         - application/json
9617         - application/xml
9618       produces:
9619         - application/json
9620         - application/xml
9621       responses:
9622         "default":
9623           description: Response codes found in [response codes](https://wiki.onap.org/).
9624       parameters:
9625         - name: hostname
9626           in: path
9627           description: Value from executing hostname on the compute node.
9628           required: true
9629           type: string
9630           example: __HOSTNAME__
9631         - name: interface-name
9632           in: path
9633           description: Name that identifies the physical interface
9634           required: true
9635           type: string
9636           example: __INTERFACE-NAME__
9637         - name: interface-name
9638           in: path
9639           description: Name given to the interface
9640           required: true
9641           type: string
9642           example: __INTERFACE-NAME__
9643         - name: pci-id
9644           in: path
9645           description: PCI ID used to identify the sriov-vf
9646           required: true
9647           type: string
9648           example: __PCI-ID__
9649         - name: resource-version
9650           in: query
9651           description: resource-version for concurrency
9652           required: true
9653           type: string
9654   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
9655     get:
9656       tags:
9657         - CloudInfrastructure
9658       summary: returns sriov-vfs
9659       description: returns sriov-vfs
9660       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
9661       produces:
9662         - application/json
9663         - application/xml
9664       responses:
9665         "200":
9666           description: successful operation
9667           schema:
9668               $ref: "#/getDefinitions/sriov-vfs"
9669         "default":
9670           description: Response codes found in [response codes](https://wiki.onap.org/).
9671       parameters:
9672         - name: hostname
9673           in: path
9674           description: Value from executing hostname on the compute node.
9675           required: true
9676           type: string
9677           example: __HOSTNAME__
9678         - name: interface-name
9679           in: path
9680           description: Name that identifies the physical interface
9681           required: true
9682           type: string
9683           example: __INTERFACE-NAME__
9684         - name: interface-name
9685           in: path
9686           description: Name given to the interface
9687           required: true
9688           type: string
9689           example: __INTERFACE-NAME__
9690         - name: inv-status
9691           in: query
9692           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
9693           required: false
9694           type: string
9695         - name: pserver-id
9696           in: query
9697           description: ID of Pserver
9698           required: false
9699           type: string
9700         - name: in-maint
9701           in: query
9702           required: false
9703           type: boolean
9704         - name: pserver-name2
9705           in: query
9706           description: alternative pserver name
9707           required: false
9708           type: string
9709         - name: prov-status
9710           in: query
9711           description: Trigger for operational monitoring of this resource by Service Assurance systems.
9712           required: false
9713           type: string
9714         - name: interface-id
9715           in: query
9716           description: ID of interface
9717           required: false
9718           type: string
9719         - name: macaddr
9720           in: query
9721           description: MAC address for the interface
9722           required: false
9723           type: string
9724         - name: network-name
9725           in: query
9726           description: Name of the network
9727           required: false
9728           type: string
9729   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
9730     put:
9731       tags:
9732         - CloudInfrastructure
9733       summary: see node definition for valid relationships
9734       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
9735       consumes:
9736         - application/json
9737         - application/xml
9738       produces:
9739         - application/json
9740         - application/xml
9741       responses:
9742         "default":
9743           description: Response codes found in [response codes](https://wiki.onap.org/).
9744       parameters:
9745         - name: hostname
9746           in: path
9747           description: Value from executing hostname on the compute node.
9748           required: true
9749           type: string
9750           example: __HOSTNAME__
9751         - name: interface-name
9752           in: path
9753           description: Name that identifies the physical interface
9754           required: true
9755           type: string
9756           example: __INTERFACE-NAME__
9757         - name: interface-name
9758           in: path
9759           description: Name given to the interface
9760           required: true
9761           type: string
9762           example: __INTERFACE-NAME__
9763         - name: body
9764           in: body
9765           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)
9766           required: true
9767           schema:
9768             $ref: "#/definitions/relationship"
9769     delete:
9770       tags:
9771         - CloudInfrastructure
9772       summary: delete an existing relationship
9773       description: delete an existing relationship
9774       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
9775       consumes:
9776         - application/json
9777         - application/xml
9778       produces:
9779         - application/json
9780         - application/xml
9781       responses:
9782         "default":
9783           description: Response codes found in [response codes](https://wiki.onap.org/).
9784       parameters:
9785         - name: hostname
9786           in: path
9787           description: Value from executing hostname on the compute node.
9788           required: true
9789           type: string
9790           example: __HOSTNAME__
9791         - name: interface-name
9792           in: path
9793           description: Name that identifies the physical interface
9794           required: true
9795           type: string
9796           example: __INTERFACE-NAME__
9797         - name: interface-name
9798           in: path
9799           description: Name given to the interface
9800           required: true
9801           type: string
9802           example: __INTERFACE-NAME__
9803   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
9804     put:
9805       tags:
9806         - CloudInfrastructure
9807       summary: see node definition for valid relationships
9808       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
9809       consumes:
9810         - application/json
9811         - application/xml
9812       produces:
9813         - application/json
9814         - application/xml
9815       responses:
9816         "default":
9817           description: Response codes found in [response codes](https://wiki.onap.org/).
9818       parameters:
9819         - name: hostname
9820           in: path
9821           description: Value from executing hostname on the compute node.
9822           required: true
9823           type: string
9824           example: __HOSTNAME__
9825         - name: interface-name
9826           in: path
9827           description: Name that identifies the physical interface
9828           required: true
9829           type: string
9830           example: __INTERFACE-NAME__
9831         - name: interface-name
9832           in: path
9833           description: Name given to the interface
9834           required: true
9835           type: string
9836           example: __INTERFACE-NAME__
9837         - name: l3-interface-ipv4-address
9838           in: path
9839           description: IP address
9840           required: true
9841           type: string
9842           example: __L3-INTERFACE-IPV4-ADDRESS__
9843         - name: body
9844           in: body
9845           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
9846           required: true
9847           schema:
9848             $ref: "#/definitions/relationship"
9849     delete:
9850       tags:
9851         - CloudInfrastructure
9852       summary: delete an existing relationship
9853       description: delete an existing relationship
9854       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
9855       consumes:
9856         - application/json
9857         - application/xml
9858       produces:
9859         - application/json
9860         - application/xml
9861       responses:
9862         "default":
9863           description: Response codes found in [response codes](https://wiki.onap.org/).
9864       parameters:
9865         - name: hostname
9866           in: path
9867           description: Value from executing hostname on the compute node.
9868           required: true
9869           type: string
9870           example: __HOSTNAME__
9871         - name: interface-name
9872           in: path
9873           description: Name that identifies the physical interface
9874           required: true
9875           type: string
9876           example: __INTERFACE-NAME__
9877         - name: interface-name
9878           in: path
9879           description: Name given to the interface
9880           required: true
9881           type: string
9882           example: __INTERFACE-NAME__
9883         - name: l3-interface-ipv4-address
9884           in: path
9885           description: IP address
9886           required: true
9887           type: string
9888           example: __L3-INTERFACE-IPV4-ADDRESS__
9889   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
9890     get:
9891       tags:
9892         - CloudInfrastructure
9893       summary: returns l3-interface-ipv4-address-list
9894       description: returns l3-interface-ipv4-address-list
9895       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
9896       produces:
9897         - application/json
9898         - application/xml
9899       responses:
9900         "200":
9901           description: successful operation
9902           schema:
9903               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
9904         "default":
9905           description: Response codes found in [response codes](https://wiki.onap.org/).
9906       parameters:
9907         - name: hostname
9908           in: path
9909           description: Value from executing hostname on the compute node.
9910           required: true
9911           type: string
9912           example: __HOSTNAME__
9913         - name: interface-name
9914           in: path
9915           description: Name that identifies the physical interface
9916           required: true
9917           type: string
9918           example: __INTERFACE-NAME__
9919         - name: interface-name
9920           in: path
9921           description: Name given to the interface
9922           required: true
9923           type: string
9924           example: __INTERFACE-NAME__
9925         - name: l3-interface-ipv4-address
9926           in: path
9927           description: IP address
9928           required: true
9929           type: string
9930           example: __L3-INTERFACE-IPV4-ADDRESS__
9931         - name: inv-status
9932           in: query
9933           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
9934           required: false
9935           type: string
9936         - name: pserver-id
9937           in: query
9938           description: ID of Pserver
9939           required: false
9940           type: string
9941         - name: in-maint
9942           in: query
9943           required: false
9944           type: boolean
9945         - name: pserver-name2
9946           in: query
9947           description: alternative pserver name
9948           required: false
9949           type: string
9950         - name: prov-status
9951           in: query
9952           description: Trigger for operational monitoring of this resource by Service Assurance systems.
9953           required: false
9954           type: string
9955         - name: interface-id
9956           in: query
9957           description: ID of interface
9958           required: false
9959           type: string
9960         - name: macaddr
9961           in: query
9962           description: MAC address for the interface
9963           required: false
9964           type: string
9965         - name: network-name
9966           in: query
9967           description: Name of the network
9968           required: false
9969           type: string
9970         - name: vlan-id-inner
9971           in: query
9972           description: Inner VLAN tag
9973           required: false
9974           type: integer
9975           format: int64
9976         - name: neutron-network-id
9977           in: query
9978           description: Neutron network id of the interface that address belongs to
9979           required: false
9980           type: string
9981         - name: neutron-subnet-id
9982           in: query
9983           description: Neutron id of subnet that address belongs to
9984           required: false
9985           type: string
9986     put:
9987       tags:
9988         - CloudInfrastructure
9989       summary: create or update an existing l3-interface-ipv4-address-list
9990       description: |
9991         Create or update an existing l3-interface-ipv4-address-list.
9992         #
9993         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
9994       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
9995       consumes:
9996         - application/json
9997         - application/xml
9998       produces:
9999         - application/json
10000         - application/xml
10001       responses:
10002         "default":
10003           description: Response codes found in [response codes](https://wiki.onap.org/).
10004       parameters:
10005         - name: hostname
10006           in: path
10007           description: Value from executing hostname on the compute node.
10008           required: true
10009           type: string
10010           example: __HOSTNAME__
10011         - name: interface-name
10012           in: path
10013           description: Name that identifies the physical interface
10014           required: true
10015           type: string
10016           example: __INTERFACE-NAME__
10017         - name: interface-name
10018           in: path
10019           description: Name given to the interface
10020           required: true
10021           type: string
10022           example: __INTERFACE-NAME__
10023         - name: l3-interface-ipv4-address
10024           in: path
10025           description: IP address
10026           required: true
10027           type: string
10028           example: __L3-INTERFACE-IPV4-ADDRESS__
10029         - name: body
10030           in: body
10031           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
10032           required: true
10033           schema:
10034             $ref: "#/definitions/l3-interface-ipv4-address-list"
10035     patch:
10036       tags:
10037         - CloudInfrastructure
10038       summary: update an existing l3-interface-ipv4-address-list
10039       description: |
10040         Update an existing l3-interface-ipv4-address-list
10041         #
10042         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10043         The PUT operation will entirely replace an existing object.
10044         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
10045         #
10046         Other differences between PUT and PATCH are:
10047         #
10048         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
10049         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10050         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10051       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
10052       consumes:
10053         - application/json
10054         - application/xml
10055       produces:
10056         - application/json
10057         - application/xml
10058       responses:
10059         "default":
10060           description: Response codes found in [response codes](https://wiki.onap.org/).
10061       parameters:
10062         - name: hostname
10063           in: path
10064           description: Value from executing hostname on the compute node.
10065           required: true
10066           type: string
10067           example: __HOSTNAME__
10068         - name: interface-name
10069           in: path
10070           description: Name that identifies the physical interface
10071           required: true
10072           type: string
10073           example: __INTERFACE-NAME__
10074         - name: interface-name
10075           in: path
10076           description: Name given to the interface
10077           required: true
10078           type: string
10079           example: __INTERFACE-NAME__
10080         - name: l3-interface-ipv4-address
10081           in: path
10082           description: IP address
10083           required: true
10084           type: string
10085           example: __L3-INTERFACE-IPV4-ADDRESS__
10086         - name: body
10087           in: body
10088           description: l3-interface-ipv4-address-list object that needs to be created or updated.
10089           required: true
10090           schema:
10091             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
10092     delete:
10093       tags:
10094         - CloudInfrastructure
10095       summary: delete an existing l3-interface-ipv4-address-list
10096       description: delete an existing l3-interface-ipv4-address-list
10097       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
10098       consumes:
10099         - application/json
10100         - application/xml
10101       produces:
10102         - application/json
10103         - application/xml
10104       responses:
10105         "default":
10106           description: Response codes found in [response codes](https://wiki.onap.org/).
10107       parameters:
10108         - name: hostname
10109           in: path
10110           description: Value from executing hostname on the compute node.
10111           required: true
10112           type: string
10113           example: __HOSTNAME__
10114         - name: interface-name
10115           in: path
10116           description: Name that identifies the physical interface
10117           required: true
10118           type: string
10119           example: __INTERFACE-NAME__
10120         - name: interface-name
10121           in: path
10122           description: Name given to the interface
10123           required: true
10124           type: string
10125           example: __INTERFACE-NAME__
10126         - name: l3-interface-ipv4-address
10127           in: path
10128           description: IP address
10129           required: true
10130           type: string
10131           example: __L3-INTERFACE-IPV4-ADDRESS__
10132         - name: resource-version
10133           in: query
10134           description: resource-version for concurrency
10135           required: true
10136           type: string
10137   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
10138     put:
10139       tags:
10140         - CloudInfrastructure
10141       summary: see node definition for valid relationships
10142       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
10143       consumes:
10144         - application/json
10145         - application/xml
10146       produces:
10147         - application/json
10148         - application/xml
10149       responses:
10150         "default":
10151           description: Response codes found in [response codes](https://wiki.onap.org/).
10152       parameters:
10153         - name: hostname
10154           in: path
10155           description: Value from executing hostname on the compute node.
10156           required: true
10157           type: string
10158           example: __HOSTNAME__
10159         - name: interface-name
10160           in: path
10161           description: Name that identifies the physical interface
10162           required: true
10163           type: string
10164           example: __INTERFACE-NAME__
10165         - name: interface-name
10166           in: path
10167           description: Name given to the interface
10168           required: true
10169           type: string
10170           example: __INTERFACE-NAME__
10171         - name: l3-interface-ipv6-address
10172           in: path
10173           description: IP address
10174           required: true
10175           type: string
10176           example: __L3-INTERFACE-IPV6-ADDRESS__
10177         - name: body
10178           in: body
10179           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
10180           required: true
10181           schema:
10182             $ref: "#/definitions/relationship"
10183     delete:
10184       tags:
10185         - CloudInfrastructure
10186       summary: delete an existing relationship
10187       description: delete an existing relationship
10188       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
10189       consumes:
10190         - application/json
10191         - application/xml
10192       produces:
10193         - application/json
10194         - application/xml
10195       responses:
10196         "default":
10197           description: Response codes found in [response codes](https://wiki.onap.org/).
10198       parameters:
10199         - name: hostname
10200           in: path
10201           description: Value from executing hostname on the compute node.
10202           required: true
10203           type: string
10204           example: __HOSTNAME__
10205         - name: interface-name
10206           in: path
10207           description: Name that identifies the physical interface
10208           required: true
10209           type: string
10210           example: __INTERFACE-NAME__
10211         - name: interface-name
10212           in: path
10213           description: Name given to the interface
10214           required: true
10215           type: string
10216           example: __INTERFACE-NAME__
10217         - name: l3-interface-ipv6-address
10218           in: path
10219           description: IP address
10220           required: true
10221           type: string
10222           example: __L3-INTERFACE-IPV6-ADDRESS__
10223   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
10224     get:
10225       tags:
10226         - CloudInfrastructure
10227       summary: returns l3-interface-ipv6-address-list
10228       description: returns l3-interface-ipv6-address-list
10229       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
10230       produces:
10231         - application/json
10232         - application/xml
10233       responses:
10234         "200":
10235           description: successful operation
10236           schema:
10237               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
10238         "default":
10239           description: Response codes found in [response codes](https://wiki.onap.org/).
10240       parameters:
10241         - name: hostname
10242           in: path
10243           description: Value from executing hostname on the compute node.
10244           required: true
10245           type: string
10246           example: __HOSTNAME__
10247         - name: interface-name
10248           in: path
10249           description: Name that identifies the physical interface
10250           required: true
10251           type: string
10252           example: __INTERFACE-NAME__
10253         - name: interface-name
10254           in: path
10255           description: Name given to the interface
10256           required: true
10257           type: string
10258           example: __INTERFACE-NAME__
10259         - name: l3-interface-ipv6-address
10260           in: path
10261           description: IP address
10262           required: true
10263           type: string
10264           example: __L3-INTERFACE-IPV6-ADDRESS__
10265         - name: inv-status
10266           in: query
10267           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
10268           required: false
10269           type: string
10270         - name: pserver-id
10271           in: query
10272           description: ID of Pserver
10273           required: false
10274           type: string
10275         - name: in-maint
10276           in: query
10277           required: false
10278           type: boolean
10279         - name: pserver-name2
10280           in: query
10281           description: alternative pserver name
10282           required: false
10283           type: string
10284         - name: prov-status
10285           in: query
10286           description: Trigger for operational monitoring of this resource by Service Assurance systems.
10287           required: false
10288           type: string
10289         - name: interface-id
10290           in: query
10291           description: ID of interface
10292           required: false
10293           type: string
10294         - name: macaddr
10295           in: query
10296           description: MAC address for the interface
10297           required: false
10298           type: string
10299         - name: network-name
10300           in: query
10301           description: Name of the network
10302           required: false
10303           type: string
10304         - name: vlan-id-inner
10305           in: query
10306           description: Inner VLAN tag
10307           required: false
10308           type: integer
10309           format: int64
10310         - name: neutron-network-id
10311           in: query
10312           description: Neutron network id of the interface that address belongs to
10313           required: false
10314           type: string
10315         - name: neutron-subnet-id
10316           in: query
10317           description: Neutron id of subnet that address belongs to
10318           required: false
10319           type: string
10320     put:
10321       tags:
10322         - CloudInfrastructure
10323       summary: create or update an existing l3-interface-ipv6-address-list
10324       description: |
10325         Create or update an existing l3-interface-ipv6-address-list.
10326         #
10327         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
10328       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
10329       consumes:
10330         - application/json
10331         - application/xml
10332       produces:
10333         - application/json
10334         - application/xml
10335       responses:
10336         "default":
10337           description: Response codes found in [response codes](https://wiki.onap.org/).
10338       parameters:
10339         - name: hostname
10340           in: path
10341           description: Value from executing hostname on the compute node.
10342           required: true
10343           type: string
10344           example: __HOSTNAME__
10345         - name: interface-name
10346           in: path
10347           description: Name that identifies the physical interface
10348           required: true
10349           type: string
10350           example: __INTERFACE-NAME__
10351         - name: interface-name
10352           in: path
10353           description: Name given to the interface
10354           required: true
10355           type: string
10356           example: __INTERFACE-NAME__
10357         - name: l3-interface-ipv6-address
10358           in: path
10359           description: IP address
10360           required: true
10361           type: string
10362           example: __L3-INTERFACE-IPV6-ADDRESS__
10363         - name: body
10364           in: body
10365           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
10366           required: true
10367           schema:
10368             $ref: "#/definitions/l3-interface-ipv6-address-list"
10369     patch:
10370       tags:
10371         - CloudInfrastructure
10372       summary: update an existing l3-interface-ipv6-address-list
10373       description: |
10374         Update an existing l3-interface-ipv6-address-list
10375         #
10376         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10377         The PUT operation will entirely replace an existing object.
10378         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
10379         #
10380         Other differences between PUT and PATCH are:
10381         #
10382         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
10383         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10384         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10385       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
10386       consumes:
10387         - application/json
10388         - application/xml
10389       produces:
10390         - application/json
10391         - application/xml
10392       responses:
10393         "default":
10394           description: Response codes found in [response codes](https://wiki.onap.org/).
10395       parameters:
10396         - name: hostname
10397           in: path
10398           description: Value from executing hostname on the compute node.
10399           required: true
10400           type: string
10401           example: __HOSTNAME__
10402         - name: interface-name
10403           in: path
10404           description: Name that identifies the physical interface
10405           required: true
10406           type: string
10407           example: __INTERFACE-NAME__
10408         - name: interface-name
10409           in: path
10410           description: Name given to the interface
10411           required: true
10412           type: string
10413           example: __INTERFACE-NAME__
10414         - name: l3-interface-ipv6-address
10415           in: path
10416           description: IP address
10417           required: true
10418           type: string
10419           example: __L3-INTERFACE-IPV6-ADDRESS__
10420         - name: body
10421           in: body
10422           description: l3-interface-ipv6-address-list object that needs to be created or updated.
10423           required: true
10424           schema:
10425             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
10426     delete:
10427       tags:
10428         - CloudInfrastructure
10429       summary: delete an existing l3-interface-ipv6-address-list
10430       description: delete an existing l3-interface-ipv6-address-list
10431       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
10432       consumes:
10433         - application/json
10434         - application/xml
10435       produces:
10436         - application/json
10437         - application/xml
10438       responses:
10439         "default":
10440           description: Response codes found in [response codes](https://wiki.onap.org/).
10441       parameters:
10442         - name: hostname
10443           in: path
10444           description: Value from executing hostname on the compute node.
10445           required: true
10446           type: string
10447           example: __HOSTNAME__
10448         - name: interface-name
10449           in: path
10450           description: Name that identifies the physical interface
10451           required: true
10452           type: string
10453           example: __INTERFACE-NAME__
10454         - name: interface-name
10455           in: path
10456           description: Name given to the interface
10457           required: true
10458           type: string
10459           example: __INTERFACE-NAME__
10460         - name: l3-interface-ipv6-address
10461           in: path
10462           description: IP address
10463           required: true
10464           type: string
10465           example: __L3-INTERFACE-IPV6-ADDRESS__
10466         - name: resource-version
10467           in: query
10468           description: resource-version for concurrency
10469           required: true
10470           type: string
10471   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
10472     get:
10473       tags:
10474         - CloudInfrastructure
10475       summary: returns l-interface
10476       description: returns l-interface
10477       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
10478       produces:
10479         - application/json
10480         - application/xml
10481       responses:
10482         "200":
10483           description: successful operation
10484           schema:
10485               $ref: "#/getDefinitions/l-interface"
10486         "default":
10487           description: Response codes found in [response codes](https://wiki.onap.org/).
10488       parameters:
10489         - name: hostname
10490           in: path
10491           description: Value from executing hostname on the compute node.
10492           required: true
10493           type: string
10494           example: __HOSTNAME__
10495         - name: interface-name
10496           in: path
10497           description: Name that identifies the physical interface
10498           required: true
10499           type: string
10500           example: __INTERFACE-NAME__
10501         - name: interface-name
10502           in: path
10503           description: Name given to the interface
10504           required: true
10505           type: string
10506           example: __INTERFACE-NAME__
10507         - name: inv-status
10508           in: query
10509           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
10510           required: false
10511           type: string
10512         - name: pserver-id
10513           in: query
10514           description: ID of Pserver
10515           required: false
10516           type: string
10517         - name: in-maint
10518           in: query
10519           required: false
10520           type: boolean
10521         - name: pserver-name2
10522           in: query
10523           description: alternative pserver name
10524           required: false
10525           type: string
10526         - name: prov-status
10527           in: query
10528           description: Trigger for operational monitoring of this resource by Service Assurance systems.
10529           required: false
10530           type: string
10531         - name: interface-id
10532           in: query
10533           description: ID of interface
10534           required: false
10535           type: string
10536         - name: macaddr
10537           in: query
10538           description: MAC address for the interface
10539           required: false
10540           type: string
10541         - name: network-name
10542           in: query
10543           description: Name of the network
10544           required: false
10545           type: string
10546     put:
10547       tags:
10548         - CloudInfrastructure
10549       summary: create or update an existing l-interface
10550       description: |
10551         Create or update an existing l-interface.
10552         #
10553         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
10554       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
10555       consumes:
10556         - application/json
10557         - application/xml
10558       produces:
10559         - application/json
10560         - application/xml
10561       responses:
10562         "default":
10563           description: Response codes found in [response codes](https://wiki.onap.org/).
10564       parameters:
10565         - name: hostname
10566           in: path
10567           description: Value from executing hostname on the compute node.
10568           required: true
10569           type: string
10570           example: __HOSTNAME__
10571         - name: interface-name
10572           in: path
10573           description: Name that identifies the physical interface
10574           required: true
10575           type: string
10576           example: __INTERFACE-NAME__
10577         - name: interface-name
10578           in: path
10579           description: Name given to the interface
10580           required: true
10581           type: string
10582           example: __INTERFACE-NAME__
10583         - name: body
10584           in: body
10585           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)
10586           required: true
10587           schema:
10588             $ref: "#/definitions/l-interface"
10589     patch:
10590       tags:
10591         - CloudInfrastructure
10592       summary: update an existing l-interface
10593       description: |
10594         Update an existing l-interface
10595         #
10596         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10597         The PUT operation will entirely replace an existing object.
10598         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
10599         #
10600         Other differences between PUT and PATCH are:
10601         #
10602         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
10603         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10604         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10605       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
10606       consumes:
10607         - application/json
10608         - application/xml
10609       produces:
10610         - application/json
10611         - application/xml
10612       responses:
10613         "default":
10614           description: Response codes found in [response codes](https://wiki.onap.org/).
10615       parameters:
10616         - name: hostname
10617           in: path
10618           description: Value from executing hostname on the compute node.
10619           required: true
10620           type: string
10621           example: __HOSTNAME__
10622         - name: interface-name
10623           in: path
10624           description: Name that identifies the physical interface
10625           required: true
10626           type: string
10627           example: __INTERFACE-NAME__
10628         - name: interface-name
10629           in: path
10630           description: Name given to the interface
10631           required: true
10632           type: string
10633           example: __INTERFACE-NAME__
10634         - name: body
10635           in: body
10636           description: l-interface object that needs to be created or updated.
10637           required: true
10638           schema:
10639             $ref: "#/patchDefinitions/l-interface"
10640     delete:
10641       tags:
10642         - CloudInfrastructure
10643       summary: delete an existing l-interface
10644       description: delete an existing l-interface
10645       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
10646       consumes:
10647         - application/json
10648         - application/xml
10649       produces:
10650         - application/json
10651         - application/xml
10652       responses:
10653         "default":
10654           description: Response codes found in [response codes](https://wiki.onap.org/).
10655       parameters:
10656         - name: hostname
10657           in: path
10658           description: Value from executing hostname on the compute node.
10659           required: true
10660           type: string
10661           example: __HOSTNAME__
10662         - name: interface-name
10663           in: path
10664           description: Name that identifies the physical interface
10665           required: true
10666           type: string
10667           example: __INTERFACE-NAME__
10668         - name: interface-name
10669           in: path
10670           description: Name given to the interface
10671           required: true
10672           type: string
10673           example: __INTERFACE-NAME__
10674         - name: resource-version
10675           in: query
10676           description: resource-version for concurrency
10677           required: true
10678           type: string
10679   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces:
10680     get:
10681       tags:
10682         - CloudInfrastructure
10683       summary: returns l-interfaces
10684       description: returns l-interfaces
10685       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfaces
10686       produces:
10687         - application/json
10688         - application/xml
10689       responses:
10690         "200":
10691           description: successful operation
10692           schema:
10693               $ref: "#/getDefinitions/l-interfaces"
10694         "default":
10695           description: Response codes found in [response codes](https://wiki.onap.org/).
10696       parameters:
10697         - name: hostname
10698           in: path
10699           description: Value from executing hostname on the compute node.
10700           required: true
10701           type: string
10702           example: __HOSTNAME__
10703         - name: interface-name
10704           in: path
10705           description: Name that identifies the physical interface
10706           required: true
10707           type: string
10708           example: __INTERFACE-NAME__
10709         - name: inv-status
10710           in: query
10711           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
10712           required: false
10713           type: string
10714         - name: pserver-id
10715           in: query
10716           description: ID of Pserver
10717           required: false
10718           type: string
10719         - name: in-maint
10720           in: query
10721           required: false
10722           type: boolean
10723         - name: pserver-name2
10724           in: query
10725           description: alternative pserver name
10726           required: false
10727           type: string
10728         - name: prov-status
10729           in: query
10730           description: Trigger for operational monitoring of this resource by Service Assurance systems.
10731           required: false
10732           type: string
10733   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}:
10734     get:
10735       tags:
10736         - CloudInfrastructure
10737       summary: returns p-interface
10738       description: returns p-interface
10739       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterface
10740       produces:
10741         - application/json
10742         - application/xml
10743       responses:
10744         "200":
10745           description: successful operation
10746           schema:
10747               $ref: "#/getDefinitions/p-interface"
10748         "default":
10749           description: Response codes found in [response codes](https://wiki.onap.org/).
10750       parameters:
10751         - name: hostname
10752           in: path
10753           description: Value from executing hostname on the compute node.
10754           required: true
10755           type: string
10756           example: __HOSTNAME__
10757         - name: interface-name
10758           in: path
10759           description: Name that identifies the physical interface
10760           required: true
10761           type: string
10762           example: __INTERFACE-NAME__
10763         - name: inv-status
10764           in: query
10765           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
10766           required: false
10767           type: string
10768         - name: pserver-id
10769           in: query
10770           description: ID of Pserver
10771           required: false
10772           type: string
10773         - name: in-maint
10774           in: query
10775           required: false
10776           type: boolean
10777         - name: pserver-name2
10778           in: query
10779           description: alternative pserver name
10780           required: false
10781           type: string
10782         - name: prov-status
10783           in: query
10784           description: Trigger for operational monitoring of this resource by Service Assurance systems.
10785           required: false
10786           type: string
10787     put:
10788       tags:
10789         - CloudInfrastructure
10790       summary: create or update an existing p-interface
10791       description: |
10792         Create or update an existing p-interface.
10793         #
10794         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
10795       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterface
10796       consumes:
10797         - application/json
10798         - application/xml
10799       produces:
10800         - application/json
10801         - application/xml
10802       responses:
10803         "default":
10804           description: Response codes found in [response codes](https://wiki.onap.org/).
10805       parameters:
10806         - name: hostname
10807           in: path
10808           description: Value from executing hostname on the compute node.
10809           required: true
10810           type: string
10811           example: __HOSTNAME__
10812         - name: interface-name
10813           in: path
10814           description: Name that identifies the physical interface
10815           required: true
10816           type: string
10817           example: __INTERFACE-NAME__
10818         - name: body
10819           in: body
10820           description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterface.json)
10821           required: true
10822           schema:
10823             $ref: "#/definitions/p-interface"
10824     patch:
10825       tags:
10826         - CloudInfrastructure
10827       summary: update an existing p-interface
10828       description: |
10829         Update an existing p-interface
10830         #
10831         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10832         The PUT operation will entirely replace an existing object.
10833         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
10834         #
10835         Other differences between PUT and PATCH are:
10836         #
10837         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
10838         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10839         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10840       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterface
10841       consumes:
10842         - application/json
10843         - application/xml
10844       produces:
10845         - application/json
10846         - application/xml
10847       responses:
10848         "default":
10849           description: Response codes found in [response codes](https://wiki.onap.org/).
10850       parameters:
10851         - name: hostname
10852           in: path
10853           description: Value from executing hostname on the compute node.
10854           required: true
10855           type: string
10856           example: __HOSTNAME__
10857         - name: interface-name
10858           in: path
10859           description: Name that identifies the physical interface
10860           required: true
10861           type: string
10862           example: __INTERFACE-NAME__
10863         - name: body
10864           in: body
10865           description: p-interface object that needs to be created or updated.
10866           required: true
10867           schema:
10868             $ref: "#/patchDefinitions/p-interface"
10869     delete:
10870       tags:
10871         - CloudInfrastructure
10872       summary: delete an existing p-interface
10873       description: delete an existing p-interface
10874       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterface
10875       consumes:
10876         - application/json
10877         - application/xml
10878       produces:
10879         - application/json
10880         - application/xml
10881       responses:
10882         "default":
10883           description: Response codes found in [response codes](https://wiki.onap.org/).
10884       parameters:
10885         - name: hostname
10886           in: path
10887           description: Value from executing hostname on the compute node.
10888           required: true
10889           type: string
10890           example: __HOSTNAME__
10891         - name: interface-name
10892           in: path
10893           description: Name that identifies the physical interface
10894           required: true
10895           type: string
10896           example: __INTERFACE-NAME__
10897         - name: resource-version
10898           in: query
10899           description: resource-version for concurrency
10900           required: true
10901           type: string
10902   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces:
10903     get:
10904       tags:
10905         - CloudInfrastructure
10906       summary: returns p-interfaces
10907       description: returns p-interfaces
10908       operationId: getCloudInfrastructurePserversPserverPInterfaces
10909       produces:
10910         - application/json
10911         - application/xml
10912       responses:
10913         "200":
10914           description: successful operation
10915           schema:
10916               $ref: "#/getDefinitions/p-interfaces"
10917         "default":
10918           description: Response codes found in [response codes](https://wiki.onap.org/).
10919       parameters:
10920         - name: hostname
10921           in: path
10922           description: Value from executing hostname on the compute node.
10923           required: true
10924           type: string
10925           example: __HOSTNAME__
10926         - name: inv-status
10927           in: query
10928           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
10929           required: false
10930           type: string
10931         - name: pserver-id
10932           in: query
10933           description: ID of Pserver
10934           required: false
10935           type: string
10936         - name: in-maint
10937           in: query
10938           required: false
10939           type: boolean
10940         - name: pserver-name2
10941           in: query
10942           description: alternative pserver name
10943           required: false
10944           type: string
10945   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
10946     put:
10947       tags:
10948         - CloudInfrastructure
10949       summary: see node definition for valid relationships
10950       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
10951       consumes:
10952         - application/json
10953         - application/xml
10954       produces:
10955         - application/json
10956         - application/xml
10957       responses:
10958         "default":
10959           description: Response codes found in [response codes](https://wiki.onap.org/).
10960       parameters:
10961         - name: hostname
10962           in: path
10963           description: Value from executing hostname on the compute node.
10964           required: true
10965           type: string
10966           example: __HOSTNAME__
10967         - name: interface-name
10968           in: path
10969           description: Name that identifies the link aggregate interface
10970           required: true
10971           type: string
10972           example: __INTERFACE-NAME__
10973         - name: body
10974           in: body
10975           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
10976           required: true
10977           schema:
10978             $ref: "#/definitions/relationship"
10979     delete:
10980       tags:
10981         - CloudInfrastructure
10982       summary: delete an existing relationship
10983       description: delete an existing relationship
10984       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
10985       consumes:
10986         - application/json
10987         - application/xml
10988       produces:
10989         - application/json
10990         - application/xml
10991       responses:
10992         "default":
10993           description: Response codes found in [response codes](https://wiki.onap.org/).
10994       parameters:
10995         - name: hostname
10996           in: path
10997           description: Value from executing hostname on the compute node.
10998           required: true
10999           type: string
11000           example: __HOSTNAME__
11001         - name: interface-name
11002           in: path
11003           description: Name that identifies the link aggregate interface
11004           required: true
11005           type: string
11006           example: __INTERFACE-NAME__
11007   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
11008     put:
11009       tags:
11010         - CloudInfrastructure
11011       summary: see node definition for valid relationships
11012       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
11013       consumes:
11014         - application/json
11015         - application/xml
11016       produces:
11017         - application/json
11018         - application/xml
11019       responses:
11020         "default":
11021           description: Response codes found in [response codes](https://wiki.onap.org/).
11022       parameters:
11023         - name: hostname
11024           in: path
11025           description: Value from executing hostname on the compute node.
11026           required: true
11027           type: string
11028           example: __HOSTNAME__
11029         - name: interface-name
11030           in: path
11031           description: Name that identifies the link aggregate interface
11032           required: true
11033           type: string
11034           example: __INTERFACE-NAME__
11035         - name: interface-name
11036           in: path
11037           description: Name given to the interface
11038           required: true
11039           type: string
11040           example: __INTERFACE-NAME__
11041         - name: vlan-interface
11042           in: path
11043           description: String that identifies the interface
11044           required: true
11045           type: string
11046           example: __VLAN-INTERFACE__
11047         - name: body
11048           in: body
11049           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
11050           required: true
11051           schema:
11052             $ref: "#/definitions/relationship"
11053     delete:
11054       tags:
11055         - CloudInfrastructure
11056       summary: delete an existing relationship
11057       description: delete an existing relationship
11058       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
11059       consumes:
11060         - application/json
11061         - application/xml
11062       produces:
11063         - application/json
11064         - application/xml
11065       responses:
11066         "default":
11067           description: Response codes found in [response codes](https://wiki.onap.org/).
11068       parameters:
11069         - name: hostname
11070           in: path
11071           description: Value from executing hostname on the compute node.
11072           required: true
11073           type: string
11074           example: __HOSTNAME__
11075         - name: interface-name
11076           in: path
11077           description: Name that identifies the link aggregate interface
11078           required: true
11079           type: string
11080           example: __INTERFACE-NAME__
11081         - name: interface-name
11082           in: path
11083           description: Name given to the interface
11084           required: true
11085           type: string
11086           example: __INTERFACE-NAME__
11087         - name: vlan-interface
11088           in: path
11089           description: String that identifies the interface
11090           required: true
11091           type: string
11092           example: __VLAN-INTERFACE__
11093   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
11094     put:
11095       tags:
11096         - CloudInfrastructure
11097       summary: see node definition for valid relationships
11098       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
11099       consumes:
11100         - application/json
11101         - application/xml
11102       produces:
11103         - application/json
11104         - application/xml
11105       responses:
11106         "default":
11107           description: Response codes found in [response codes](https://wiki.onap.org/).
11108       parameters:
11109         - name: hostname
11110           in: path
11111           description: Value from executing hostname on the compute node.
11112           required: true
11113           type: string
11114           example: __HOSTNAME__
11115         - name: interface-name
11116           in: path
11117           description: Name that identifies the link aggregate interface
11118           required: true
11119           type: string
11120           example: __INTERFACE-NAME__
11121         - name: interface-name
11122           in: path
11123           description: Name given to the interface
11124           required: true
11125           type: string
11126           example: __INTERFACE-NAME__
11127         - name: vlan-interface
11128           in: path
11129           description: String that identifies the interface
11130           required: true
11131           type: string
11132           example: __VLAN-INTERFACE__
11133         - name: l3-interface-ipv4-address
11134           in: path
11135           description: IP address
11136           required: true
11137           type: string
11138           example: __L3-INTERFACE-IPV4-ADDRESS__
11139         - name: body
11140           in: body
11141           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
11142           required: true
11143           schema:
11144             $ref: "#/definitions/relationship"
11145     delete:
11146       tags:
11147         - CloudInfrastructure
11148       summary: delete an existing relationship
11149       description: delete an existing relationship
11150       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
11151       consumes:
11152         - application/json
11153         - application/xml
11154       produces:
11155         - application/json
11156         - application/xml
11157       responses:
11158         "default":
11159           description: Response codes found in [response codes](https://wiki.onap.org/).
11160       parameters:
11161         - name: hostname
11162           in: path
11163           description: Value from executing hostname on the compute node.
11164           required: true
11165           type: string
11166           example: __HOSTNAME__
11167         - name: interface-name
11168           in: path
11169           description: Name that identifies the link aggregate interface
11170           required: true
11171           type: string
11172           example: __INTERFACE-NAME__
11173         - name: interface-name
11174           in: path
11175           description: Name given to the interface
11176           required: true
11177           type: string
11178           example: __INTERFACE-NAME__
11179         - name: vlan-interface
11180           in: path
11181           description: String that identifies the interface
11182           required: true
11183           type: string
11184           example: __VLAN-INTERFACE__
11185         - name: l3-interface-ipv4-address
11186           in: path
11187           description: IP address
11188           required: true
11189           type: string
11190           example: __L3-INTERFACE-IPV4-ADDRESS__
11191   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
11192     get:
11193       tags:
11194         - CloudInfrastructure
11195       summary: returns l3-interface-ipv4-address-list
11196       description: returns l3-interface-ipv4-address-list
11197       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
11198       produces:
11199         - application/json
11200         - application/xml
11201       responses:
11202         "200":
11203           description: successful operation
11204           schema:
11205               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
11206         "default":
11207           description: Response codes found in [response codes](https://wiki.onap.org/).
11208       parameters:
11209         - name: hostname
11210           in: path
11211           description: Value from executing hostname on the compute node.
11212           required: true
11213           type: string
11214           example: __HOSTNAME__
11215         - name: interface-name
11216           in: path
11217           description: Name that identifies the link aggregate interface
11218           required: true
11219           type: string
11220           example: __INTERFACE-NAME__
11221         - name: interface-name
11222           in: path
11223           description: Name given to the interface
11224           required: true
11225           type: string
11226           example: __INTERFACE-NAME__
11227         - name: vlan-interface
11228           in: path
11229           description: String that identifies the interface
11230           required: true
11231           type: string
11232           example: __VLAN-INTERFACE__
11233         - name: l3-interface-ipv4-address
11234           in: path
11235           description: IP address
11236           required: true
11237           type: string
11238           example: __L3-INTERFACE-IPV4-ADDRESS__
11239         - name: inv-status
11240           in: query
11241           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
11242           required: false
11243           type: string
11244         - name: pserver-id
11245           in: query
11246           description: ID of Pserver
11247           required: false
11248           type: string
11249         - name: in-maint
11250           in: query
11251           required: false
11252           type: boolean
11253         - name: pserver-name2
11254           in: query
11255           description: alternative pserver name
11256           required: false
11257           type: string
11258         - name: interface-id
11259           in: query
11260           description: ID of interface
11261           required: false
11262           type: string
11263         - name: interface-role
11264           in: query
11265           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
11266           required: false
11267           type: string
11268         - name: interface-id
11269           in: query
11270           description: ID of interface
11271           required: false
11272           type: string
11273         - name: macaddr
11274           in: query
11275           description: MAC address for the interface
11276           required: false
11277           type: string
11278         - name: network-name
11279           in: query
11280           description: Name of the network
11281           required: false
11282           type: string
11283         - name: vlan-id-inner
11284           in: query
11285           description: Inner VLAN tag
11286           required: false
11287           type: integer
11288           format: int64
11289         - name: vpn-id
11290           in: query
11291           description: This indicates the customers VPN ID associated with this vlan
11292           required: false
11293           type: string
11294         - name: vlan-id-inner
11295           in: query
11296           description: Inner VLAN tag
11297           required: false
11298           type: integer
11299           format: int64
11300         - name: neutron-network-id
11301           in: query
11302           description: Neutron network id of the interface that address belongs to
11303           required: false
11304           type: string
11305         - name: neutron-subnet-id
11306           in: query
11307           description: Neutron id of subnet that address belongs to
11308           required: false
11309           type: string
11310     put:
11311       tags:
11312         - CloudInfrastructure
11313       summary: create or update an existing l3-interface-ipv4-address-list
11314       description: |
11315         Create or update an existing l3-interface-ipv4-address-list.
11316         #
11317         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
11318       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
11319       consumes:
11320         - application/json
11321         - application/xml
11322       produces:
11323         - application/json
11324         - application/xml
11325       responses:
11326         "default":
11327           description: Response codes found in [response codes](https://wiki.onap.org/).
11328       parameters:
11329         - name: hostname
11330           in: path
11331           description: Value from executing hostname on the compute node.
11332           required: true
11333           type: string
11334           example: __HOSTNAME__
11335         - name: interface-name
11336           in: path
11337           description: Name that identifies the link aggregate interface
11338           required: true
11339           type: string
11340           example: __INTERFACE-NAME__
11341         - name: interface-name
11342           in: path
11343           description: Name given to the interface
11344           required: true
11345           type: string
11346           example: __INTERFACE-NAME__
11347         - name: vlan-interface
11348           in: path
11349           description: String that identifies the interface
11350           required: true
11351           type: string
11352           example: __VLAN-INTERFACE__
11353         - name: l3-interface-ipv4-address
11354           in: path
11355           description: IP address
11356           required: true
11357           type: string
11358           example: __L3-INTERFACE-IPV4-ADDRESS__
11359         - name: body
11360           in: body
11361           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
11362           required: true
11363           schema:
11364             $ref: "#/definitions/l3-interface-ipv4-address-list"
11365     patch:
11366       tags:
11367         - CloudInfrastructure
11368       summary: update an existing l3-interface-ipv4-address-list
11369       description: |
11370         Update an existing l3-interface-ipv4-address-list
11371         #
11372         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11373         The PUT operation will entirely replace an existing object.
11374         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
11375         #
11376         Other differences between PUT and PATCH are:
11377         #
11378         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
11379         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11380         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11381       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
11382       consumes:
11383         - application/json
11384         - application/xml
11385       produces:
11386         - application/json
11387         - application/xml
11388       responses:
11389         "default":
11390           description: Response codes found in [response codes](https://wiki.onap.org/).
11391       parameters:
11392         - name: hostname
11393           in: path
11394           description: Value from executing hostname on the compute node.
11395           required: true
11396           type: string
11397           example: __HOSTNAME__
11398         - name: interface-name
11399           in: path
11400           description: Name that identifies the link aggregate interface
11401           required: true
11402           type: string
11403           example: __INTERFACE-NAME__
11404         - name: interface-name
11405           in: path
11406           description: Name given to the interface
11407           required: true
11408           type: string
11409           example: __INTERFACE-NAME__
11410         - name: vlan-interface
11411           in: path
11412           description: String that identifies the interface
11413           required: true
11414           type: string
11415           example: __VLAN-INTERFACE__
11416         - name: l3-interface-ipv4-address
11417           in: path
11418           description: IP address
11419           required: true
11420           type: string
11421           example: __L3-INTERFACE-IPV4-ADDRESS__
11422         - name: body
11423           in: body
11424           description: l3-interface-ipv4-address-list object that needs to be created or updated.
11425           required: true
11426           schema:
11427             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
11428     delete:
11429       tags:
11430         - CloudInfrastructure
11431       summary: delete an existing l3-interface-ipv4-address-list
11432       description: delete an existing l3-interface-ipv4-address-list
11433       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
11434       consumes:
11435         - application/json
11436         - application/xml
11437       produces:
11438         - application/json
11439         - application/xml
11440       responses:
11441         "default":
11442           description: Response codes found in [response codes](https://wiki.onap.org/).
11443       parameters:
11444         - name: hostname
11445           in: path
11446           description: Value from executing hostname on the compute node.
11447           required: true
11448           type: string
11449           example: __HOSTNAME__
11450         - name: interface-name
11451           in: path
11452           description: Name that identifies the link aggregate interface
11453           required: true
11454           type: string
11455           example: __INTERFACE-NAME__
11456         - name: interface-name
11457           in: path
11458           description: Name given to the interface
11459           required: true
11460           type: string
11461           example: __INTERFACE-NAME__
11462         - name: vlan-interface
11463           in: path
11464           description: String that identifies the interface
11465           required: true
11466           type: string
11467           example: __VLAN-INTERFACE__
11468         - name: l3-interface-ipv4-address
11469           in: path
11470           description: IP address
11471           required: true
11472           type: string
11473           example: __L3-INTERFACE-IPV4-ADDRESS__
11474         - name: resource-version
11475           in: query
11476           description: resource-version for concurrency
11477           required: true
11478           type: string
11479   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
11480     put:
11481       tags:
11482         - CloudInfrastructure
11483       summary: see node definition for valid relationships
11484       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
11485       consumes:
11486         - application/json
11487         - application/xml
11488       produces:
11489         - application/json
11490         - application/xml
11491       responses:
11492         "default":
11493           description: Response codes found in [response codes](https://wiki.onap.org/).
11494       parameters:
11495         - name: hostname
11496           in: path
11497           description: Value from executing hostname on the compute node.
11498           required: true
11499           type: string
11500           example: __HOSTNAME__
11501         - name: interface-name
11502           in: path
11503           description: Name that identifies the link aggregate interface
11504           required: true
11505           type: string
11506           example: __INTERFACE-NAME__
11507         - name: interface-name
11508           in: path
11509           description: Name given to the interface
11510           required: true
11511           type: string
11512           example: __INTERFACE-NAME__
11513         - name: vlan-interface
11514           in: path
11515           description: String that identifies the interface
11516           required: true
11517           type: string
11518           example: __VLAN-INTERFACE__
11519         - name: l3-interface-ipv6-address
11520           in: path
11521           description: IP address
11522           required: true
11523           type: string
11524           example: __L3-INTERFACE-IPV6-ADDRESS__
11525         - name: body
11526           in: body
11527           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
11528           required: true
11529           schema:
11530             $ref: "#/definitions/relationship"
11531     delete:
11532       tags:
11533         - CloudInfrastructure
11534       summary: delete an existing relationship
11535       description: delete an existing relationship
11536       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
11537       consumes:
11538         - application/json
11539         - application/xml
11540       produces:
11541         - application/json
11542         - application/xml
11543       responses:
11544         "default":
11545           description: Response codes found in [response codes](https://wiki.onap.org/).
11546       parameters:
11547         - name: hostname
11548           in: path
11549           description: Value from executing hostname on the compute node.
11550           required: true
11551           type: string
11552           example: __HOSTNAME__
11553         - name: interface-name
11554           in: path
11555           description: Name that identifies the link aggregate interface
11556           required: true
11557           type: string
11558           example: __INTERFACE-NAME__
11559         - name: interface-name
11560           in: path
11561           description: Name given to the interface
11562           required: true
11563           type: string
11564           example: __INTERFACE-NAME__
11565         - name: vlan-interface
11566           in: path
11567           description: String that identifies the interface
11568           required: true
11569           type: string
11570           example: __VLAN-INTERFACE__
11571         - name: l3-interface-ipv6-address
11572           in: path
11573           description: IP address
11574           required: true
11575           type: string
11576           example: __L3-INTERFACE-IPV6-ADDRESS__
11577   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
11578     get:
11579       tags:
11580         - CloudInfrastructure
11581       summary: returns l3-interface-ipv6-address-list
11582       description: returns l3-interface-ipv6-address-list
11583       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
11584       produces:
11585         - application/json
11586         - application/xml
11587       responses:
11588         "200":
11589           description: successful operation
11590           schema:
11591               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
11592         "default":
11593           description: Response codes found in [response codes](https://wiki.onap.org/).
11594       parameters:
11595         - name: hostname
11596           in: path
11597           description: Value from executing hostname on the compute node.
11598           required: true
11599           type: string
11600           example: __HOSTNAME__
11601         - name: interface-name
11602           in: path
11603           description: Name that identifies the link aggregate interface
11604           required: true
11605           type: string
11606           example: __INTERFACE-NAME__
11607         - name: interface-name
11608           in: path
11609           description: Name given to the interface
11610           required: true
11611           type: string
11612           example: __INTERFACE-NAME__
11613         - name: vlan-interface
11614           in: path
11615           description: String that identifies the interface
11616           required: true
11617           type: string
11618           example: __VLAN-INTERFACE__
11619         - name: l3-interface-ipv6-address
11620           in: path
11621           description: IP address
11622           required: true
11623           type: string
11624           example: __L3-INTERFACE-IPV6-ADDRESS__
11625         - name: inv-status
11626           in: query
11627           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
11628           required: false
11629           type: string
11630         - name: pserver-id
11631           in: query
11632           description: ID of Pserver
11633           required: false
11634           type: string
11635         - name: in-maint
11636           in: query
11637           required: false
11638           type: boolean
11639         - name: pserver-name2
11640           in: query
11641           description: alternative pserver name
11642           required: false
11643           type: string
11644         - name: interface-id
11645           in: query
11646           description: ID of interface
11647           required: false
11648           type: string
11649         - name: interface-role
11650           in: query
11651           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
11652           required: false
11653           type: string
11654         - name: interface-id
11655           in: query
11656           description: ID of interface
11657           required: false
11658           type: string
11659         - name: macaddr
11660           in: query
11661           description: MAC address for the interface
11662           required: false
11663           type: string
11664         - name: network-name
11665           in: query
11666           description: Name of the network
11667           required: false
11668           type: string
11669         - name: vlan-id-inner
11670           in: query
11671           description: Inner VLAN tag
11672           required: false
11673           type: integer
11674           format: int64
11675         - name: vpn-id
11676           in: query
11677           description: This indicates the customers VPN ID associated with this vlan
11678           required: false
11679           type: string
11680         - name: vlan-id-inner
11681           in: query
11682           description: Inner VLAN tag
11683           required: false
11684           type: integer
11685           format: int64
11686         - name: neutron-network-id
11687           in: query
11688           description: Neutron network id of the interface that address belongs to
11689           required: false
11690           type: string
11691         - name: neutron-subnet-id
11692           in: query
11693           description: Neutron id of subnet that address belongs to
11694           required: false
11695           type: string
11696     put:
11697       tags:
11698         - CloudInfrastructure
11699       summary: create or update an existing l3-interface-ipv6-address-list
11700       description: |
11701         Create or update an existing l3-interface-ipv6-address-list.
11702         #
11703         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
11704       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
11705       consumes:
11706         - application/json
11707         - application/xml
11708       produces:
11709         - application/json
11710         - application/xml
11711       responses:
11712         "default":
11713           description: Response codes found in [response codes](https://wiki.onap.org/).
11714       parameters:
11715         - name: hostname
11716           in: path
11717           description: Value from executing hostname on the compute node.
11718           required: true
11719           type: string
11720           example: __HOSTNAME__
11721         - name: interface-name
11722           in: path
11723           description: Name that identifies the link aggregate interface
11724           required: true
11725           type: string
11726           example: __INTERFACE-NAME__
11727         - name: interface-name
11728           in: path
11729           description: Name given to the interface
11730           required: true
11731           type: string
11732           example: __INTERFACE-NAME__
11733         - name: vlan-interface
11734           in: path
11735           description: String that identifies the interface
11736           required: true
11737           type: string
11738           example: __VLAN-INTERFACE__
11739         - name: l3-interface-ipv6-address
11740           in: path
11741           description: IP address
11742           required: true
11743           type: string
11744           example: __L3-INTERFACE-IPV6-ADDRESS__
11745         - name: body
11746           in: body
11747           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
11748           required: true
11749           schema:
11750             $ref: "#/definitions/l3-interface-ipv6-address-list"
11751     patch:
11752       tags:
11753         - CloudInfrastructure
11754       summary: update an existing l3-interface-ipv6-address-list
11755       description: |
11756         Update an existing l3-interface-ipv6-address-list
11757         #
11758         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11759         The PUT operation will entirely replace an existing object.
11760         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
11761         #
11762         Other differences between PUT and PATCH are:
11763         #
11764         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
11765         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11766         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11767       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
11768       consumes:
11769         - application/json
11770         - application/xml
11771       produces:
11772         - application/json
11773         - application/xml
11774       responses:
11775         "default":
11776           description: Response codes found in [response codes](https://wiki.onap.org/).
11777       parameters:
11778         - name: hostname
11779           in: path
11780           description: Value from executing hostname on the compute node.
11781           required: true
11782           type: string
11783           example: __HOSTNAME__
11784         - name: interface-name
11785           in: path
11786           description: Name that identifies the link aggregate interface
11787           required: true
11788           type: string
11789           example: __INTERFACE-NAME__
11790         - name: interface-name
11791           in: path
11792           description: Name given to the interface
11793           required: true
11794           type: string
11795           example: __INTERFACE-NAME__
11796         - name: vlan-interface
11797           in: path
11798           description: String that identifies the interface
11799           required: true
11800           type: string
11801           example: __VLAN-INTERFACE__
11802         - name: l3-interface-ipv6-address
11803           in: path
11804           description: IP address
11805           required: true
11806           type: string
11807           example: __L3-INTERFACE-IPV6-ADDRESS__
11808         - name: body
11809           in: body
11810           description: l3-interface-ipv6-address-list object that needs to be created or updated.
11811           required: true
11812           schema:
11813             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
11814     delete:
11815       tags:
11816         - CloudInfrastructure
11817       summary: delete an existing l3-interface-ipv6-address-list
11818       description: delete an existing l3-interface-ipv6-address-list
11819       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
11820       consumes:
11821         - application/json
11822         - application/xml
11823       produces:
11824         - application/json
11825         - application/xml
11826       responses:
11827         "default":
11828           description: Response codes found in [response codes](https://wiki.onap.org/).
11829       parameters:
11830         - name: hostname
11831           in: path
11832           description: Value from executing hostname on the compute node.
11833           required: true
11834           type: string
11835           example: __HOSTNAME__
11836         - name: interface-name
11837           in: path
11838           description: Name that identifies the link aggregate interface
11839           required: true
11840           type: string
11841           example: __INTERFACE-NAME__
11842         - name: interface-name
11843           in: path
11844           description: Name given to the interface
11845           required: true
11846           type: string
11847           example: __INTERFACE-NAME__
11848         - name: vlan-interface
11849           in: path
11850           description: String that identifies the interface
11851           required: true
11852           type: string
11853           example: __VLAN-INTERFACE__
11854         - name: l3-interface-ipv6-address
11855           in: path
11856           description: IP address
11857           required: true
11858           type: string
11859           example: __L3-INTERFACE-IPV6-ADDRESS__
11860         - name: resource-version
11861           in: query
11862           description: resource-version for concurrency
11863           required: true
11864           type: string
11865   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
11866     get:
11867       tags:
11868         - CloudInfrastructure
11869       summary: returns vlan
11870       description: returns vlan
11871       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
11872       produces:
11873         - application/json
11874         - application/xml
11875       responses:
11876         "200":
11877           description: successful operation
11878           schema:
11879               $ref: "#/getDefinitions/vlan"
11880         "default":
11881           description: Response codes found in [response codes](https://wiki.onap.org/).
11882       parameters:
11883         - name: hostname
11884           in: path
11885           description: Value from executing hostname on the compute node.
11886           required: true
11887           type: string
11888           example: __HOSTNAME__
11889         - name: interface-name
11890           in: path
11891           description: Name that identifies the link aggregate interface
11892           required: true
11893           type: string
11894           example: __INTERFACE-NAME__
11895         - name: interface-name
11896           in: path
11897           description: Name given to the interface
11898           required: true
11899           type: string
11900           example: __INTERFACE-NAME__
11901         - name: vlan-interface
11902           in: path
11903           description: String that identifies the interface
11904           required: true
11905           type: string
11906           example: __VLAN-INTERFACE__
11907         - name: inv-status
11908           in: query
11909           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
11910           required: false
11911           type: string
11912         - name: pserver-id
11913           in: query
11914           description: ID of Pserver
11915           required: false
11916           type: string
11917         - name: in-maint
11918           in: query
11919           required: false
11920           type: boolean
11921         - name: pserver-name2
11922           in: query
11923           description: alternative pserver name
11924           required: false
11925           type: string
11926         - name: interface-id
11927           in: query
11928           description: ID of interface
11929           required: false
11930           type: string
11931         - name: interface-role
11932           in: query
11933           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
11934           required: false
11935           type: string
11936         - name: interface-id
11937           in: query
11938           description: ID of interface
11939           required: false
11940           type: string
11941         - name: macaddr
11942           in: query
11943           description: MAC address for the interface
11944           required: false
11945           type: string
11946         - name: network-name
11947           in: query
11948           description: Name of the network
11949           required: false
11950           type: string
11951         - name: vlan-id-inner
11952           in: query
11953           description: Inner VLAN tag
11954           required: false
11955           type: integer
11956           format: int64
11957         - name: vpn-id
11958           in: query
11959           description: This indicates the customers VPN ID associated with this vlan
11960           required: false
11961           type: string
11962     put:
11963       tags:
11964         - CloudInfrastructure
11965       summary: create or update an existing vlan
11966       description: |
11967         Create or update an existing vlan.
11968         #
11969         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
11970       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
11971       consumes:
11972         - application/json
11973         - application/xml
11974       produces:
11975         - application/json
11976         - application/xml
11977       responses:
11978         "default":
11979           description: Response codes found in [response codes](https://wiki.onap.org/).
11980       parameters:
11981         - name: hostname
11982           in: path
11983           description: Value from executing hostname on the compute node.
11984           required: true
11985           type: string
11986           example: __HOSTNAME__
11987         - name: interface-name
11988           in: path
11989           description: Name that identifies the link aggregate interface
11990           required: true
11991           type: string
11992           example: __INTERFACE-NAME__
11993         - name: interface-name
11994           in: path
11995           description: Name given to the interface
11996           required: true
11997           type: string
11998           example: __INTERFACE-NAME__
11999         - name: vlan-interface
12000           in: path
12001           description: String that identifies the interface
12002           required: true
12003           type: string
12004           example: __VLAN-INTERFACE__
12005         - name: body
12006           in: body
12007           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
12008           required: true
12009           schema:
12010             $ref: "#/definitions/vlan"
12011     patch:
12012       tags:
12013         - CloudInfrastructure
12014       summary: update an existing vlan
12015       description: |
12016         Update an existing vlan
12017         #
12018         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12019         The PUT operation will entirely replace an existing object.
12020         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
12021         #
12022         Other differences between PUT and PATCH are:
12023         #
12024         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
12025         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12026         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12027       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
12028       consumes:
12029         - application/json
12030         - application/xml
12031       produces:
12032         - application/json
12033         - application/xml
12034       responses:
12035         "default":
12036           description: Response codes found in [response codes](https://wiki.onap.org/).
12037       parameters:
12038         - name: hostname
12039           in: path
12040           description: Value from executing hostname on the compute node.
12041           required: true
12042           type: string
12043           example: __HOSTNAME__
12044         - name: interface-name
12045           in: path
12046           description: Name that identifies the link aggregate interface
12047           required: true
12048           type: string
12049           example: __INTERFACE-NAME__
12050         - name: interface-name
12051           in: path
12052           description: Name given to the interface
12053           required: true
12054           type: string
12055           example: __INTERFACE-NAME__
12056         - name: vlan-interface
12057           in: path
12058           description: String that identifies the interface
12059           required: true
12060           type: string
12061           example: __VLAN-INTERFACE__
12062         - name: body
12063           in: body
12064           description: vlan object that needs to be created or updated.
12065           required: true
12066           schema:
12067             $ref: "#/patchDefinitions/vlan"
12068     delete:
12069       tags:
12070         - CloudInfrastructure
12071       summary: delete an existing vlan
12072       description: delete an existing vlan
12073       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
12074       consumes:
12075         - application/json
12076         - application/xml
12077       produces:
12078         - application/json
12079         - application/xml
12080       responses:
12081         "default":
12082           description: Response codes found in [response codes](https://wiki.onap.org/).
12083       parameters:
12084         - name: hostname
12085           in: path
12086           description: Value from executing hostname on the compute node.
12087           required: true
12088           type: string
12089           example: __HOSTNAME__
12090         - name: interface-name
12091           in: path
12092           description: Name that identifies the link aggregate interface
12093           required: true
12094           type: string
12095           example: __INTERFACE-NAME__
12096         - name: interface-name
12097           in: path
12098           description: Name given to the interface
12099           required: true
12100           type: string
12101           example: __INTERFACE-NAME__
12102         - name: vlan-interface
12103           in: path
12104           description: String that identifies the interface
12105           required: true
12106           type: string
12107           example: __VLAN-INTERFACE__
12108         - name: resource-version
12109           in: query
12110           description: resource-version for concurrency
12111           required: true
12112           type: string
12113   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
12114     get:
12115       tags:
12116         - CloudInfrastructure
12117       summary: returns vlans
12118       description: returns vlans
12119       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
12120       produces:
12121         - application/json
12122         - application/xml
12123       responses:
12124         "200":
12125           description: successful operation
12126           schema:
12127               $ref: "#/getDefinitions/vlans"
12128         "default":
12129           description: Response codes found in [response codes](https://wiki.onap.org/).
12130       parameters:
12131         - name: hostname
12132           in: path
12133           description: Value from executing hostname on the compute node.
12134           required: true
12135           type: string
12136           example: __HOSTNAME__
12137         - name: interface-name
12138           in: path
12139           description: Name that identifies the link aggregate interface
12140           required: true
12141           type: string
12142           example: __INTERFACE-NAME__
12143         - name: interface-name
12144           in: path
12145           description: Name given to the interface
12146           required: true
12147           type: string
12148           example: __INTERFACE-NAME__
12149         - name: inv-status
12150           in: query
12151           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
12152           required: false
12153           type: string
12154         - name: pserver-id
12155           in: query
12156           description: ID of Pserver
12157           required: false
12158           type: string
12159         - name: in-maint
12160           in: query
12161           required: false
12162           type: boolean
12163         - name: pserver-name2
12164           in: query
12165           description: alternative pserver name
12166           required: false
12167           type: string
12168         - name: interface-id
12169           in: query
12170           description: ID of interface
12171           required: false
12172           type: string
12173         - name: interface-role
12174           in: query
12175           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
12176           required: false
12177           type: string
12178         - name: interface-id
12179           in: query
12180           description: ID of interface
12181           required: false
12182           type: string
12183         - name: macaddr
12184           in: query
12185           description: MAC address for the interface
12186           required: false
12187           type: string
12188         - name: network-name
12189           in: query
12190           description: Name of the network
12191           required: false
12192           type: string
12193   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
12194     put:
12195       tags:
12196         - CloudInfrastructure
12197       summary: see node definition for valid relationships
12198       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
12199       consumes:
12200         - application/json
12201         - application/xml
12202       produces:
12203         - application/json
12204         - application/xml
12205       responses:
12206         "default":
12207           description: Response codes found in [response codes](https://wiki.onap.org/).
12208       parameters:
12209         - name: hostname
12210           in: path
12211           description: Value from executing hostname on the compute node.
12212           required: true
12213           type: string
12214           example: __HOSTNAME__
12215         - name: interface-name
12216           in: path
12217           description: Name that identifies the link aggregate interface
12218           required: true
12219           type: string
12220           example: __INTERFACE-NAME__
12221         - name: interface-name
12222           in: path
12223           description: Name given to the interface
12224           required: true
12225           type: string
12226           example: __INTERFACE-NAME__
12227         - name: pci-id
12228           in: path
12229           description: PCI ID used to identify the sriov-vf
12230           required: true
12231           type: string
12232           example: __PCI-ID__
12233         - name: body
12234           in: body
12235           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
12236           required: true
12237           schema:
12238             $ref: "#/definitions/relationship"
12239     delete:
12240       tags:
12241         - CloudInfrastructure
12242       summary: delete an existing relationship
12243       description: delete an existing relationship
12244       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
12245       consumes:
12246         - application/json
12247         - application/xml
12248       produces:
12249         - application/json
12250         - application/xml
12251       responses:
12252         "default":
12253           description: Response codes found in [response codes](https://wiki.onap.org/).
12254       parameters:
12255         - name: hostname
12256           in: path
12257           description: Value from executing hostname on the compute node.
12258           required: true
12259           type: string
12260           example: __HOSTNAME__
12261         - name: interface-name
12262           in: path
12263           description: Name that identifies the link aggregate interface
12264           required: true
12265           type: string
12266           example: __INTERFACE-NAME__
12267         - name: interface-name
12268           in: path
12269           description: Name given to the interface
12270           required: true
12271           type: string
12272           example: __INTERFACE-NAME__
12273         - name: pci-id
12274           in: path
12275           description: PCI ID used to identify the sriov-vf
12276           required: true
12277           type: string
12278           example: __PCI-ID__
12279   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
12280     get:
12281       tags:
12282         - CloudInfrastructure
12283       summary: returns sriov-vf
12284       description: returns sriov-vf
12285       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
12286       produces:
12287         - application/json
12288         - application/xml
12289       responses:
12290         "200":
12291           description: successful operation
12292           schema:
12293               $ref: "#/getDefinitions/sriov-vf"
12294         "default":
12295           description: Response codes found in [response codes](https://wiki.onap.org/).
12296       parameters:
12297         - name: hostname
12298           in: path
12299           description: Value from executing hostname on the compute node.
12300           required: true
12301           type: string
12302           example: __HOSTNAME__
12303         - name: interface-name
12304           in: path
12305           description: Name that identifies the link aggregate interface
12306           required: true
12307           type: string
12308           example: __INTERFACE-NAME__
12309         - name: interface-name
12310           in: path
12311           description: Name given to the interface
12312           required: true
12313           type: string
12314           example: __INTERFACE-NAME__
12315         - name: pci-id
12316           in: path
12317           description: PCI ID used to identify the sriov-vf
12318           required: true
12319           type: string
12320           example: __PCI-ID__
12321         - name: inv-status
12322           in: query
12323           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
12324           required: false
12325           type: string
12326         - name: pserver-id
12327           in: query
12328           description: ID of Pserver
12329           required: false
12330           type: string
12331         - name: in-maint
12332           in: query
12333           required: false
12334           type: boolean
12335         - name: pserver-name2
12336           in: query
12337           description: alternative pserver name
12338           required: false
12339           type: string
12340         - name: interface-id
12341           in: query
12342           description: ID of interface
12343           required: false
12344           type: string
12345         - name: interface-role
12346           in: query
12347           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
12348           required: false
12349           type: string
12350         - name: interface-id
12351           in: query
12352           description: ID of interface
12353           required: false
12354           type: string
12355         - name: macaddr
12356           in: query
12357           description: MAC address for the interface
12358           required: false
12359           type: string
12360         - name: network-name
12361           in: query
12362           description: Name of the network
12363           required: false
12364           type: string
12365         - name: vf-vlan-filter
12366           in: query
12367           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
12368           required: false
12369           type: string
12370         - name: vf-mac-filter
12371           in: query
12372           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
12373           required: false
12374           type: string
12375         - name: vf-vlan-strip
12376           in: query
12377           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
12378           required: false
12379           type: boolean
12380         - name: neutron-network-id
12381           in: query
12382           description: Neutron network id of the interface
12383           required: false
12384           type: string
12385     put:
12386       tags:
12387         - CloudInfrastructure
12388       summary: create or update an existing sriov-vf
12389       description: |
12390         Create or update an existing sriov-vf.
12391         #
12392         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
12393       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
12394       consumes:
12395         - application/json
12396         - application/xml
12397       produces:
12398         - application/json
12399         - application/xml
12400       responses:
12401         "default":
12402           description: Response codes found in [response codes](https://wiki.onap.org/).
12403       parameters:
12404         - name: hostname
12405           in: path
12406           description: Value from executing hostname on the compute node.
12407           required: true
12408           type: string
12409           example: __HOSTNAME__
12410         - name: interface-name
12411           in: path
12412           description: Name that identifies the link aggregate interface
12413           required: true
12414           type: string
12415           example: __INTERFACE-NAME__
12416         - name: interface-name
12417           in: path
12418           description: Name given to the interface
12419           required: true
12420           type: string
12421           example: __INTERFACE-NAME__
12422         - name: pci-id
12423           in: path
12424           description: PCI ID used to identify the sriov-vf
12425           required: true
12426           type: string
12427           example: __PCI-ID__
12428         - name: body
12429           in: body
12430           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
12431           required: true
12432           schema:
12433             $ref: "#/definitions/sriov-vf"
12434     patch:
12435       tags:
12436         - CloudInfrastructure
12437       summary: update an existing sriov-vf
12438       description: |
12439         Update an existing sriov-vf
12440         #
12441         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12442         The PUT operation will entirely replace an existing object.
12443         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
12444         #
12445         Other differences between PUT and PATCH are:
12446         #
12447         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
12448         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12449         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12450       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
12451       consumes:
12452         - application/json
12453         - application/xml
12454       produces:
12455         - application/json
12456         - application/xml
12457       responses:
12458         "default":
12459           description: Response codes found in [response codes](https://wiki.onap.org/).
12460       parameters:
12461         - name: hostname
12462           in: path
12463           description: Value from executing hostname on the compute node.
12464           required: true
12465           type: string
12466           example: __HOSTNAME__
12467         - name: interface-name
12468           in: path
12469           description: Name that identifies the link aggregate interface
12470           required: true
12471           type: string
12472           example: __INTERFACE-NAME__
12473         - name: interface-name
12474           in: path
12475           description: Name given to the interface
12476           required: true
12477           type: string
12478           example: __INTERFACE-NAME__
12479         - name: pci-id
12480           in: path
12481           description: PCI ID used to identify the sriov-vf
12482           required: true
12483           type: string
12484           example: __PCI-ID__
12485         - name: body
12486           in: body
12487           description: sriov-vf object that needs to be created or updated.
12488           required: true
12489           schema:
12490             $ref: "#/patchDefinitions/sriov-vf"
12491     delete:
12492       tags:
12493         - CloudInfrastructure
12494       summary: delete an existing sriov-vf
12495       description: delete an existing sriov-vf
12496       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
12497       consumes:
12498         - application/json
12499         - application/xml
12500       produces:
12501         - application/json
12502         - application/xml
12503       responses:
12504         "default":
12505           description: Response codes found in [response codes](https://wiki.onap.org/).
12506       parameters:
12507         - name: hostname
12508           in: path
12509           description: Value from executing hostname on the compute node.
12510           required: true
12511           type: string
12512           example: __HOSTNAME__
12513         - name: interface-name
12514           in: path
12515           description: Name that identifies the link aggregate interface
12516           required: true
12517           type: string
12518           example: __INTERFACE-NAME__
12519         - name: interface-name
12520           in: path
12521           description: Name given to the interface
12522           required: true
12523           type: string
12524           example: __INTERFACE-NAME__
12525         - name: pci-id
12526           in: path
12527           description: PCI ID used to identify the sriov-vf
12528           required: true
12529           type: string
12530           example: __PCI-ID__
12531         - name: resource-version
12532           in: query
12533           description: resource-version for concurrency
12534           required: true
12535           type: string
12536   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
12537     get:
12538       tags:
12539         - CloudInfrastructure
12540       summary: returns sriov-vfs
12541       description: returns sriov-vfs
12542       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
12543       produces:
12544         - application/json
12545         - application/xml
12546       responses:
12547         "200":
12548           description: successful operation
12549           schema:
12550               $ref: "#/getDefinitions/sriov-vfs"
12551         "default":
12552           description: Response codes found in [response codes](https://wiki.onap.org/).
12553       parameters:
12554         - name: hostname
12555           in: path
12556           description: Value from executing hostname on the compute node.
12557           required: true
12558           type: string
12559           example: __HOSTNAME__
12560         - name: interface-name
12561           in: path
12562           description: Name that identifies the link aggregate interface
12563           required: true
12564           type: string
12565           example: __INTERFACE-NAME__
12566         - name: interface-name
12567           in: path
12568           description: Name given to the interface
12569           required: true
12570           type: string
12571           example: __INTERFACE-NAME__
12572         - name: inv-status
12573           in: query
12574           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
12575           required: false
12576           type: string
12577         - name: pserver-id
12578           in: query
12579           description: ID of Pserver
12580           required: false
12581           type: string
12582         - name: in-maint
12583           in: query
12584           required: false
12585           type: boolean
12586         - name: pserver-name2
12587           in: query
12588           description: alternative pserver name
12589           required: false
12590           type: string
12591         - name: interface-id
12592           in: query
12593           description: ID of interface
12594           required: false
12595           type: string
12596         - name: interface-role
12597           in: query
12598           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
12599           required: false
12600           type: string
12601         - name: interface-id
12602           in: query
12603           description: ID of interface
12604           required: false
12605           type: string
12606         - name: macaddr
12607           in: query
12608           description: MAC address for the interface
12609           required: false
12610           type: string
12611         - name: network-name
12612           in: query
12613           description: Name of the network
12614           required: false
12615           type: string
12616   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
12617     put:
12618       tags:
12619         - CloudInfrastructure
12620       summary: see node definition for valid relationships
12621       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
12622       consumes:
12623         - application/json
12624         - application/xml
12625       produces:
12626         - application/json
12627         - application/xml
12628       responses:
12629         "default":
12630           description: Response codes found in [response codes](https://wiki.onap.org/).
12631       parameters:
12632         - name: hostname
12633           in: path
12634           description: Value from executing hostname on the compute node.
12635           required: true
12636           type: string
12637           example: __HOSTNAME__
12638         - name: interface-name
12639           in: path
12640           description: Name that identifies the link aggregate interface
12641           required: true
12642           type: string
12643           example: __INTERFACE-NAME__
12644         - name: interface-name
12645           in: path
12646           description: Name given to the interface
12647           required: true
12648           type: string
12649           example: __INTERFACE-NAME__
12650         - name: body
12651           in: body
12652           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
12653           required: true
12654           schema:
12655             $ref: "#/definitions/relationship"
12656     delete:
12657       tags:
12658         - CloudInfrastructure
12659       summary: delete an existing relationship
12660       description: delete an existing relationship
12661       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
12662       consumes:
12663         - application/json
12664         - application/xml
12665       produces:
12666         - application/json
12667         - application/xml
12668       responses:
12669         "default":
12670           description: Response codes found in [response codes](https://wiki.onap.org/).
12671       parameters:
12672         - name: hostname
12673           in: path
12674           description: Value from executing hostname on the compute node.
12675           required: true
12676           type: string
12677           example: __HOSTNAME__
12678         - name: interface-name
12679           in: path
12680           description: Name that identifies the link aggregate interface
12681           required: true
12682           type: string
12683           example: __INTERFACE-NAME__
12684         - name: interface-name
12685           in: path
12686           description: Name given to the interface
12687           required: true
12688           type: string
12689           example: __INTERFACE-NAME__
12690   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
12691     put:
12692       tags:
12693         - CloudInfrastructure
12694       summary: see node definition for valid relationships
12695       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
12696       consumes:
12697         - application/json
12698         - application/xml
12699       produces:
12700         - application/json
12701         - application/xml
12702       responses:
12703         "default":
12704           description: Response codes found in [response codes](https://wiki.onap.org/).
12705       parameters:
12706         - name: hostname
12707           in: path
12708           description: Value from executing hostname on the compute node.
12709           required: true
12710           type: string
12711           example: __HOSTNAME__
12712         - name: interface-name
12713           in: path
12714           description: Name that identifies the link aggregate interface
12715           required: true
12716           type: string
12717           example: __INTERFACE-NAME__
12718         - name: interface-name
12719           in: path
12720           description: Name given to the interface
12721           required: true
12722           type: string
12723           example: __INTERFACE-NAME__
12724         - name: l3-interface-ipv4-address
12725           in: path
12726           description: IP address
12727           required: true
12728           type: string
12729           example: __L3-INTERFACE-IPV4-ADDRESS__
12730         - name: body
12731           in: body
12732           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
12733           required: true
12734           schema:
12735             $ref: "#/definitions/relationship"
12736     delete:
12737       tags:
12738         - CloudInfrastructure
12739       summary: delete an existing relationship
12740       description: delete an existing relationship
12741       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
12742       consumes:
12743         - application/json
12744         - application/xml
12745       produces:
12746         - application/json
12747         - application/xml
12748       responses:
12749         "default":
12750           description: Response codes found in [response codes](https://wiki.onap.org/).
12751       parameters:
12752         - name: hostname
12753           in: path
12754           description: Value from executing hostname on the compute node.
12755           required: true
12756           type: string
12757           example: __HOSTNAME__
12758         - name: interface-name
12759           in: path
12760           description: Name that identifies the link aggregate interface
12761           required: true
12762           type: string
12763           example: __INTERFACE-NAME__
12764         - name: interface-name
12765           in: path
12766           description: Name given to the interface
12767           required: true
12768           type: string
12769           example: __INTERFACE-NAME__
12770         - name: l3-interface-ipv4-address
12771           in: path
12772           description: IP address
12773           required: true
12774           type: string
12775           example: __L3-INTERFACE-IPV4-ADDRESS__
12776   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
12777     get:
12778       tags:
12779         - CloudInfrastructure
12780       summary: returns l3-interface-ipv4-address-list
12781       description: returns l3-interface-ipv4-address-list
12782       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
12783       produces:
12784         - application/json
12785         - application/xml
12786       responses:
12787         "200":
12788           description: successful operation
12789           schema:
12790               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
12791         "default":
12792           description: Response codes found in [response codes](https://wiki.onap.org/).
12793       parameters:
12794         - name: hostname
12795           in: path
12796           description: Value from executing hostname on the compute node.
12797           required: true
12798           type: string
12799           example: __HOSTNAME__
12800         - name: interface-name
12801           in: path
12802           description: Name that identifies the link aggregate interface
12803           required: true
12804           type: string
12805           example: __INTERFACE-NAME__
12806         - name: interface-name
12807           in: path
12808           description: Name given to the interface
12809           required: true
12810           type: string
12811           example: __INTERFACE-NAME__
12812         - name: l3-interface-ipv4-address
12813           in: path
12814           description: IP address
12815           required: true
12816           type: string
12817           example: __L3-INTERFACE-IPV4-ADDRESS__
12818         - name: inv-status
12819           in: query
12820           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
12821           required: false
12822           type: string
12823         - name: pserver-id
12824           in: query
12825           description: ID of Pserver
12826           required: false
12827           type: string
12828         - name: in-maint
12829           in: query
12830           required: false
12831           type: boolean
12832         - name: pserver-name2
12833           in: query
12834           description: alternative pserver name
12835           required: false
12836           type: string
12837         - name: interface-id
12838           in: query
12839           description: ID of interface
12840           required: false
12841           type: string
12842         - name: interface-role
12843           in: query
12844           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
12845           required: false
12846           type: string
12847         - name: interface-id
12848           in: query
12849           description: ID of interface
12850           required: false
12851           type: string
12852         - name: macaddr
12853           in: query
12854           description: MAC address for the interface
12855           required: false
12856           type: string
12857         - name: network-name
12858           in: query
12859           description: Name of the network
12860           required: false
12861           type: string
12862         - name: vlan-id-inner
12863           in: query
12864           description: Inner VLAN tag
12865           required: false
12866           type: integer
12867           format: int64
12868         - name: neutron-network-id
12869           in: query
12870           description: Neutron network id of the interface that address belongs to
12871           required: false
12872           type: string
12873         - name: neutron-subnet-id
12874           in: query
12875           description: Neutron id of subnet that address belongs to
12876           required: false
12877           type: string
12878     put:
12879       tags:
12880         - CloudInfrastructure
12881       summary: create or update an existing l3-interface-ipv4-address-list
12882       description: |
12883         Create or update an existing l3-interface-ipv4-address-list.
12884         #
12885         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
12886       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
12887       consumes:
12888         - application/json
12889         - application/xml
12890       produces:
12891         - application/json
12892         - application/xml
12893       responses:
12894         "default":
12895           description: Response codes found in [response codes](https://wiki.onap.org/).
12896       parameters:
12897         - name: hostname
12898           in: path
12899           description: Value from executing hostname on the compute node.
12900           required: true
12901           type: string
12902           example: __HOSTNAME__
12903         - name: interface-name
12904           in: path
12905           description: Name that identifies the link aggregate interface
12906           required: true
12907           type: string
12908           example: __INTERFACE-NAME__
12909         - name: interface-name
12910           in: path
12911           description: Name given to the interface
12912           required: true
12913           type: string
12914           example: __INTERFACE-NAME__
12915         - name: l3-interface-ipv4-address
12916           in: path
12917           description: IP address
12918           required: true
12919           type: string
12920           example: __L3-INTERFACE-IPV4-ADDRESS__
12921         - name: body
12922           in: body
12923           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
12924           required: true
12925           schema:
12926             $ref: "#/definitions/l3-interface-ipv4-address-list"
12927     patch:
12928       tags:
12929         - CloudInfrastructure
12930       summary: update an existing l3-interface-ipv4-address-list
12931       description: |
12932         Update an existing l3-interface-ipv4-address-list
12933         #
12934         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12935         The PUT operation will entirely replace an existing object.
12936         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
12937         #
12938         Other differences between PUT and PATCH are:
12939         #
12940         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
12941         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12942         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12943       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
12944       consumes:
12945         - application/json
12946         - application/xml
12947       produces:
12948         - application/json
12949         - application/xml
12950       responses:
12951         "default":
12952           description: Response codes found in [response codes](https://wiki.onap.org/).
12953       parameters:
12954         - name: hostname
12955           in: path
12956           description: Value from executing hostname on the compute node.
12957           required: true
12958           type: string
12959           example: __HOSTNAME__
12960         - name: interface-name
12961           in: path
12962           description: Name that identifies the link aggregate interface
12963           required: true
12964           type: string
12965           example: __INTERFACE-NAME__
12966         - name: interface-name
12967           in: path
12968           description: Name given to the interface
12969           required: true
12970           type: string
12971           example: __INTERFACE-NAME__
12972         - name: l3-interface-ipv4-address
12973           in: path
12974           description: IP address
12975           required: true
12976           type: string
12977           example: __L3-INTERFACE-IPV4-ADDRESS__
12978         - name: body
12979           in: body
12980           description: l3-interface-ipv4-address-list object that needs to be created or updated.
12981           required: true
12982           schema:
12983             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
12984     delete:
12985       tags:
12986         - CloudInfrastructure
12987       summary: delete an existing l3-interface-ipv4-address-list
12988       description: delete an existing l3-interface-ipv4-address-list
12989       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
12990       consumes:
12991         - application/json
12992         - application/xml
12993       produces:
12994         - application/json
12995         - application/xml
12996       responses:
12997         "default":
12998           description: Response codes found in [response codes](https://wiki.onap.org/).
12999       parameters:
13000         - name: hostname
13001           in: path
13002           description: Value from executing hostname on the compute node.
13003           required: true
13004           type: string
13005           example: __HOSTNAME__
13006         - name: interface-name
13007           in: path
13008           description: Name that identifies the link aggregate interface
13009           required: true
13010           type: string
13011           example: __INTERFACE-NAME__
13012         - name: interface-name
13013           in: path
13014           description: Name given to the interface
13015           required: true
13016           type: string
13017           example: __INTERFACE-NAME__
13018         - name: l3-interface-ipv4-address
13019           in: path
13020           description: IP address
13021           required: true
13022           type: string
13023           example: __L3-INTERFACE-IPV4-ADDRESS__
13024         - name: resource-version
13025           in: query
13026           description: resource-version for concurrency
13027           required: true
13028           type: string
13029   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
13030     put:
13031       tags:
13032         - CloudInfrastructure
13033       summary: see node definition for valid relationships
13034       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
13035       consumes:
13036         - application/json
13037         - application/xml
13038       produces:
13039         - application/json
13040         - application/xml
13041       responses:
13042         "default":
13043           description: Response codes found in [response codes](https://wiki.onap.org/).
13044       parameters:
13045         - name: hostname
13046           in: path
13047           description: Value from executing hostname on the compute node.
13048           required: true
13049           type: string
13050           example: __HOSTNAME__
13051         - name: interface-name
13052           in: path
13053           description: Name that identifies the link aggregate interface
13054           required: true
13055           type: string
13056           example: __INTERFACE-NAME__
13057         - name: interface-name
13058           in: path
13059           description: Name given to the interface
13060           required: true
13061           type: string
13062           example: __INTERFACE-NAME__
13063         - name: l3-interface-ipv6-address
13064           in: path
13065           description: IP address
13066           required: true
13067           type: string
13068           example: __L3-INTERFACE-IPV6-ADDRESS__
13069         - name: body
13070           in: body
13071           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
13072           required: true
13073           schema:
13074             $ref: "#/definitions/relationship"
13075     delete:
13076       tags:
13077         - CloudInfrastructure
13078       summary: delete an existing relationship
13079       description: delete an existing relationship
13080       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
13081       consumes:
13082         - application/json
13083         - application/xml
13084       produces:
13085         - application/json
13086         - application/xml
13087       responses:
13088         "default":
13089           description: Response codes found in [response codes](https://wiki.onap.org/).
13090       parameters:
13091         - name: hostname
13092           in: path
13093           description: Value from executing hostname on the compute node.
13094           required: true
13095           type: string
13096           example: __HOSTNAME__
13097         - name: interface-name
13098           in: path
13099           description: Name that identifies the link aggregate interface
13100           required: true
13101           type: string
13102           example: __INTERFACE-NAME__
13103         - name: interface-name
13104           in: path
13105           description: Name given to the interface
13106           required: true
13107           type: string
13108           example: __INTERFACE-NAME__
13109         - name: l3-interface-ipv6-address
13110           in: path
13111           description: IP address
13112           required: true
13113           type: string
13114           example: __L3-INTERFACE-IPV6-ADDRESS__
13115   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
13116     get:
13117       tags:
13118         - CloudInfrastructure
13119       summary: returns l3-interface-ipv6-address-list
13120       description: returns l3-interface-ipv6-address-list
13121       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
13122       produces:
13123         - application/json
13124         - application/xml
13125       responses:
13126         "200":
13127           description: successful operation
13128           schema:
13129               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
13130         "default":
13131           description: Response codes found in [response codes](https://wiki.onap.org/).
13132       parameters:
13133         - name: hostname
13134           in: path
13135           description: Value from executing hostname on the compute node.
13136           required: true
13137           type: string
13138           example: __HOSTNAME__
13139         - name: interface-name
13140           in: path
13141           description: Name that identifies the link aggregate interface
13142           required: true
13143           type: string
13144           example: __INTERFACE-NAME__
13145         - name: interface-name
13146           in: path
13147           description: Name given to the interface
13148           required: true
13149           type: string
13150           example: __INTERFACE-NAME__
13151         - name: l3-interface-ipv6-address
13152           in: path
13153           description: IP address
13154           required: true
13155           type: string
13156           example: __L3-INTERFACE-IPV6-ADDRESS__
13157         - name: inv-status
13158           in: query
13159           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
13160           required: false
13161           type: string
13162         - name: pserver-id
13163           in: query
13164           description: ID of Pserver
13165           required: false
13166           type: string
13167         - name: in-maint
13168           in: query
13169           required: false
13170           type: boolean
13171         - name: pserver-name2
13172           in: query
13173           description: alternative pserver name
13174           required: false
13175           type: string
13176         - name: interface-id
13177           in: query
13178           description: ID of interface
13179           required: false
13180           type: string
13181         - name: interface-role
13182           in: query
13183           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
13184           required: false
13185           type: string
13186         - name: interface-id
13187           in: query
13188           description: ID of interface
13189           required: false
13190           type: string
13191         - name: macaddr
13192           in: query
13193           description: MAC address for the interface
13194           required: false
13195           type: string
13196         - name: network-name
13197           in: query
13198           description: Name of the network
13199           required: false
13200           type: string
13201         - name: vlan-id-inner
13202           in: query
13203           description: Inner VLAN tag
13204           required: false
13205           type: integer
13206           format: int64
13207         - name: neutron-network-id
13208           in: query
13209           description: Neutron network id of the interface that address belongs to
13210           required: false
13211           type: string
13212         - name: neutron-subnet-id
13213           in: query
13214           description: Neutron id of subnet that address belongs to
13215           required: false
13216           type: string
13217     put:
13218       tags:
13219         - CloudInfrastructure
13220       summary: create or update an existing l3-interface-ipv6-address-list
13221       description: |
13222         Create or update an existing l3-interface-ipv6-address-list.
13223         #
13224         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
13225       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
13226       consumes:
13227         - application/json
13228         - application/xml
13229       produces:
13230         - application/json
13231         - application/xml
13232       responses:
13233         "default":
13234           description: Response codes found in [response codes](https://wiki.onap.org/).
13235       parameters:
13236         - name: hostname
13237           in: path
13238           description: Value from executing hostname on the compute node.
13239           required: true
13240           type: string
13241           example: __HOSTNAME__
13242         - name: interface-name
13243           in: path
13244           description: Name that identifies the link aggregate interface
13245           required: true
13246           type: string
13247           example: __INTERFACE-NAME__
13248         - name: interface-name
13249           in: path
13250           description: Name given to the interface
13251           required: true
13252           type: string
13253           example: __INTERFACE-NAME__
13254         - name: l3-interface-ipv6-address
13255           in: path
13256           description: IP address
13257           required: true
13258           type: string
13259           example: __L3-INTERFACE-IPV6-ADDRESS__
13260         - name: body
13261           in: body
13262           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
13263           required: true
13264           schema:
13265             $ref: "#/definitions/l3-interface-ipv6-address-list"
13266     patch:
13267       tags:
13268         - CloudInfrastructure
13269       summary: update an existing l3-interface-ipv6-address-list
13270       description: |
13271         Update an existing l3-interface-ipv6-address-list
13272         #
13273         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13274         The PUT operation will entirely replace an existing object.
13275         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
13276         #
13277         Other differences between PUT and PATCH are:
13278         #
13279         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
13280         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13281         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13282       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
13283       consumes:
13284         - application/json
13285         - application/xml
13286       produces:
13287         - application/json
13288         - application/xml
13289       responses:
13290         "default":
13291           description: Response codes found in [response codes](https://wiki.onap.org/).
13292       parameters:
13293         - name: hostname
13294           in: path
13295           description: Value from executing hostname on the compute node.
13296           required: true
13297           type: string
13298           example: __HOSTNAME__
13299         - name: interface-name
13300           in: path
13301           description: Name that identifies the link aggregate interface
13302           required: true
13303           type: string
13304           example: __INTERFACE-NAME__
13305         - name: interface-name
13306           in: path
13307           description: Name given to the interface
13308           required: true
13309           type: string
13310           example: __INTERFACE-NAME__
13311         - name: l3-interface-ipv6-address
13312           in: path
13313           description: IP address
13314           required: true
13315           type: string
13316           example: __L3-INTERFACE-IPV6-ADDRESS__
13317         - name: body
13318           in: body
13319           description: l3-interface-ipv6-address-list object that needs to be created or updated.
13320           required: true
13321           schema:
13322             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
13323     delete:
13324       tags:
13325         - CloudInfrastructure
13326       summary: delete an existing l3-interface-ipv6-address-list
13327       description: delete an existing l3-interface-ipv6-address-list
13328       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
13329       consumes:
13330         - application/json
13331         - application/xml
13332       produces:
13333         - application/json
13334         - application/xml
13335       responses:
13336         "default":
13337           description: Response codes found in [response codes](https://wiki.onap.org/).
13338       parameters:
13339         - name: hostname
13340           in: path
13341           description: Value from executing hostname on the compute node.
13342           required: true
13343           type: string
13344           example: __HOSTNAME__
13345         - name: interface-name
13346           in: path
13347           description: Name that identifies the link aggregate interface
13348           required: true
13349           type: string
13350           example: __INTERFACE-NAME__
13351         - name: interface-name
13352           in: path
13353           description: Name given to the interface
13354           required: true
13355           type: string
13356           example: __INTERFACE-NAME__
13357         - name: l3-interface-ipv6-address
13358           in: path
13359           description: IP address
13360           required: true
13361           type: string
13362           example: __L3-INTERFACE-IPV6-ADDRESS__
13363         - name: resource-version
13364           in: query
13365           description: resource-version for concurrency
13366           required: true
13367           type: string
13368   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
13369     get:
13370       tags:
13371         - CloudInfrastructure
13372       summary: returns l-interface
13373       description: returns l-interface
13374       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
13375       produces:
13376         - application/json
13377         - application/xml
13378       responses:
13379         "200":
13380           description: successful operation
13381           schema:
13382               $ref: "#/getDefinitions/l-interface"
13383         "default":
13384           description: Response codes found in [response codes](https://wiki.onap.org/).
13385       parameters:
13386         - name: hostname
13387           in: path
13388           description: Value from executing hostname on the compute node.
13389           required: true
13390           type: string
13391           example: __HOSTNAME__
13392         - name: interface-name
13393           in: path
13394           description: Name that identifies the link aggregate interface
13395           required: true
13396           type: string
13397           example: __INTERFACE-NAME__
13398         - name: interface-name
13399           in: path
13400           description: Name given to the interface
13401           required: true
13402           type: string
13403           example: __INTERFACE-NAME__
13404         - name: inv-status
13405           in: query
13406           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
13407           required: false
13408           type: string
13409         - name: pserver-id
13410           in: query
13411           description: ID of Pserver
13412           required: false
13413           type: string
13414         - name: in-maint
13415           in: query
13416           required: false
13417           type: boolean
13418         - name: pserver-name2
13419           in: query
13420           description: alternative pserver name
13421           required: false
13422           type: string
13423         - name: interface-id
13424           in: query
13425           description: ID of interface
13426           required: false
13427           type: string
13428         - name: interface-role
13429           in: query
13430           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
13431           required: false
13432           type: string
13433         - name: interface-id
13434           in: query
13435           description: ID of interface
13436           required: false
13437           type: string
13438         - name: macaddr
13439           in: query
13440           description: MAC address for the interface
13441           required: false
13442           type: string
13443         - name: network-name
13444           in: query
13445           description: Name of the network
13446           required: false
13447           type: string
13448     put:
13449       tags:
13450         - CloudInfrastructure
13451       summary: create or update an existing l-interface
13452       description: |
13453         Create or update an existing l-interface.
13454         #
13455         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
13456       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
13457       consumes:
13458         - application/json
13459         - application/xml
13460       produces:
13461         - application/json
13462         - application/xml
13463       responses:
13464         "default":
13465           description: Response codes found in [response codes](https://wiki.onap.org/).
13466       parameters:
13467         - name: hostname
13468           in: path
13469           description: Value from executing hostname on the compute node.
13470           required: true
13471           type: string
13472           example: __HOSTNAME__
13473         - name: interface-name
13474           in: path
13475           description: Name that identifies the link aggregate interface
13476           required: true
13477           type: string
13478           example: __INTERFACE-NAME__
13479         - name: interface-name
13480           in: path
13481           description: Name given to the interface
13482           required: true
13483           type: string
13484           example: __INTERFACE-NAME__
13485         - name: body
13486           in: body
13487           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
13488           required: true
13489           schema:
13490             $ref: "#/definitions/l-interface"
13491     patch:
13492       tags:
13493         - CloudInfrastructure
13494       summary: update an existing l-interface
13495       description: |
13496         Update an existing l-interface
13497         #
13498         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13499         The PUT operation will entirely replace an existing object.
13500         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
13501         #
13502         Other differences between PUT and PATCH are:
13503         #
13504         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
13505         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13506         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13507       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
13508       consumes:
13509         - application/json
13510         - application/xml
13511       produces:
13512         - application/json
13513         - application/xml
13514       responses:
13515         "default":
13516           description: Response codes found in [response codes](https://wiki.onap.org/).
13517       parameters:
13518         - name: hostname
13519           in: path
13520           description: Value from executing hostname on the compute node.
13521           required: true
13522           type: string
13523           example: __HOSTNAME__
13524         - name: interface-name
13525           in: path
13526           description: Name that identifies the link aggregate interface
13527           required: true
13528           type: string
13529           example: __INTERFACE-NAME__
13530         - name: interface-name
13531           in: path
13532           description: Name given to the interface
13533           required: true
13534           type: string
13535           example: __INTERFACE-NAME__
13536         - name: body
13537           in: body
13538           description: l-interface object that needs to be created or updated.
13539           required: true
13540           schema:
13541             $ref: "#/patchDefinitions/l-interface"
13542     delete:
13543       tags:
13544         - CloudInfrastructure
13545       summary: delete an existing l-interface
13546       description: delete an existing l-interface
13547       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
13548       consumes:
13549         - application/json
13550         - application/xml
13551       produces:
13552         - application/json
13553         - application/xml
13554       responses:
13555         "default":
13556           description: Response codes found in [response codes](https://wiki.onap.org/).
13557       parameters:
13558         - name: hostname
13559           in: path
13560           description: Value from executing hostname on the compute node.
13561           required: true
13562           type: string
13563           example: __HOSTNAME__
13564         - name: interface-name
13565           in: path
13566           description: Name that identifies the link aggregate interface
13567           required: true
13568           type: string
13569           example: __INTERFACE-NAME__
13570         - name: interface-name
13571           in: path
13572           description: Name given to the interface
13573           required: true
13574           type: string
13575           example: __INTERFACE-NAME__
13576         - name: resource-version
13577           in: query
13578           description: resource-version for concurrency
13579           required: true
13580           type: string
13581   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
13582     get:
13583       tags:
13584         - CloudInfrastructure
13585       summary: returns l-interfaces
13586       description: returns l-interfaces
13587       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfaces
13588       produces:
13589         - application/json
13590         - application/xml
13591       responses:
13592         "200":
13593           description: successful operation
13594           schema:
13595               $ref: "#/getDefinitions/l-interfaces"
13596         "default":
13597           description: Response codes found in [response codes](https://wiki.onap.org/).
13598       parameters:
13599         - name: hostname
13600           in: path
13601           description: Value from executing hostname on the compute node.
13602           required: true
13603           type: string
13604           example: __HOSTNAME__
13605         - name: interface-name
13606           in: path
13607           description: Name that identifies the link aggregate interface
13608           required: true
13609           type: string
13610           example: __INTERFACE-NAME__
13611         - name: inv-status
13612           in: query
13613           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
13614           required: false
13615           type: string
13616         - name: pserver-id
13617           in: query
13618           description: ID of Pserver
13619           required: false
13620           type: string
13621         - name: in-maint
13622           in: query
13623           required: false
13624           type: boolean
13625         - name: pserver-name2
13626           in: query
13627           description: alternative pserver name
13628           required: false
13629           type: string
13630         - name: interface-id
13631           in: query
13632           description: ID of interface
13633           required: false
13634           type: string
13635         - name: interface-role
13636           in: query
13637           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
13638           required: false
13639           type: string
13640   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}:
13641     get:
13642       tags:
13643         - CloudInfrastructure
13644       summary: returns lag-interface
13645       description: returns lag-interface
13646       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterface
13647       produces:
13648         - application/json
13649         - application/xml
13650       responses:
13651         "200":
13652           description: successful operation
13653           schema:
13654               $ref: "#/getDefinitions/lag-interface"
13655         "default":
13656           description: Response codes found in [response codes](https://wiki.onap.org/).
13657       parameters:
13658         - name: hostname
13659           in: path
13660           description: Value from executing hostname on the compute node.
13661           required: true
13662           type: string
13663           example: __HOSTNAME__
13664         - name: interface-name
13665           in: path
13666           description: Name that identifies the link aggregate interface
13667           required: true
13668           type: string
13669           example: __INTERFACE-NAME__
13670         - name: inv-status
13671           in: query
13672           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
13673           required: false
13674           type: string
13675         - name: pserver-id
13676           in: query
13677           description: ID of Pserver
13678           required: false
13679           type: string
13680         - name: in-maint
13681           in: query
13682           required: false
13683           type: boolean
13684         - name: pserver-name2
13685           in: query
13686           description: alternative pserver name
13687           required: false
13688           type: string
13689         - name: interface-id
13690           in: query
13691           description: ID of interface
13692           required: false
13693           type: string
13694         - name: interface-role
13695           in: query
13696           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
13697           required: false
13698           type: string
13699     put:
13700       tags:
13701         - CloudInfrastructure
13702       summary: create or update an existing lag-interface
13703       description: |
13704         Create or update an existing lag-interface.
13705         #
13706         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
13707       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface
13708       consumes:
13709         - application/json
13710         - application/xml
13711       produces:
13712         - application/json
13713         - application/xml
13714       responses:
13715         "default":
13716           description: Response codes found in [response codes](https://wiki.onap.org/).
13717       parameters:
13718         - name: hostname
13719           in: path
13720           description: Value from executing hostname on the compute node.
13721           required: true
13722           type: string
13723           example: __HOSTNAME__
13724         - name: interface-name
13725           in: path
13726           description: Name that identifies the link aggregate interface
13727           required: true
13728           type: string
13729           example: __INTERFACE-NAME__
13730         - name: body
13731           in: body
13732           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
13733           required: true
13734           schema:
13735             $ref: "#/definitions/lag-interface"
13736     patch:
13737       tags:
13738         - CloudInfrastructure
13739       summary: update an existing lag-interface
13740       description: |
13741         Update an existing lag-interface
13742         #
13743         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13744         The PUT operation will entirely replace an existing object.
13745         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
13746         #
13747         Other differences between PUT and PATCH are:
13748         #
13749         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
13750         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13751         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13752       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface
13753       consumes:
13754         - application/json
13755         - application/xml
13756       produces:
13757         - application/json
13758         - application/xml
13759       responses:
13760         "default":
13761           description: Response codes found in [response codes](https://wiki.onap.org/).
13762       parameters:
13763         - name: hostname
13764           in: path
13765           description: Value from executing hostname on the compute node.
13766           required: true
13767           type: string
13768           example: __HOSTNAME__
13769         - name: interface-name
13770           in: path
13771           description: Name that identifies the link aggregate interface
13772           required: true
13773           type: string
13774           example: __INTERFACE-NAME__
13775         - name: body
13776           in: body
13777           description: lag-interface object that needs to be created or updated.
13778           required: true
13779           schema:
13780             $ref: "#/patchDefinitions/lag-interface"
13781     delete:
13782       tags:
13783         - CloudInfrastructure
13784       summary: delete an existing lag-interface
13785       description: delete an existing lag-interface
13786       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterface
13787       consumes:
13788         - application/json
13789         - application/xml
13790       produces:
13791         - application/json
13792         - application/xml
13793       responses:
13794         "default":
13795           description: Response codes found in [response codes](https://wiki.onap.org/).
13796       parameters:
13797         - name: hostname
13798           in: path
13799           description: Value from executing hostname on the compute node.
13800           required: true
13801           type: string
13802           example: __HOSTNAME__
13803         - name: interface-name
13804           in: path
13805           description: Name that identifies the link aggregate interface
13806           required: true
13807           type: string
13808           example: __INTERFACE-NAME__
13809         - name: resource-version
13810           in: query
13811           description: resource-version for concurrency
13812           required: true
13813           type: string
13814   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces:
13815     get:
13816       tags:
13817         - CloudInfrastructure
13818       summary: returns lag-interfaces
13819       description: returns lag-interfaces
13820       operationId: getCloudInfrastructurePserversPserverLagInterfaces
13821       produces:
13822         - application/json
13823         - application/xml
13824       responses:
13825         "200":
13826           description: successful operation
13827           schema:
13828               $ref: "#/getDefinitions/lag-interfaces"
13829         "default":
13830           description: Response codes found in [response codes](https://wiki.onap.org/).
13831       parameters:
13832         - name: hostname
13833           in: path
13834           description: Value from executing hostname on the compute node.
13835           required: true
13836           type: string
13837           example: __HOSTNAME__
13838         - name: inv-status
13839           in: query
13840           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
13841           required: false
13842           type: string
13843         - name: pserver-id
13844           in: query
13845           description: ID of Pserver
13846           required: false
13847           type: string
13848         - name: in-maint
13849           in: query
13850           required: false
13851           type: boolean
13852         - name: pserver-name2
13853           in: query
13854           description: alternative pserver name
13855           required: false
13856           type: string
13857   /cloud-infrastructure/pservers/pserver/{hostname}:
13858     get:
13859       tags:
13860         - CloudInfrastructure
13861       summary: returns pserver
13862       description: returns pserver
13863       operationId: getCloudInfrastructurePserversPserver
13864       produces:
13865         - application/json
13866         - application/xml
13867       responses:
13868         "200":
13869           description: successful operation
13870           schema:
13871               $ref: "#/getDefinitions/pserver"
13872         "default":
13873           description: Response codes found in [response codes](https://wiki.onap.org/).
13874       parameters:
13875         - name: hostname
13876           in: path
13877           description: Value from executing hostname on the compute node.
13878           required: true
13879           type: string
13880           example: __HOSTNAME__
13881         - name: inv-status
13882           in: query
13883           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
13884           required: false
13885           type: string
13886         - name: pserver-id
13887           in: query
13888           description: ID of Pserver
13889           required: false
13890           type: string
13891         - name: in-maint
13892           in: query
13893           required: false
13894           type: boolean
13895         - name: pserver-name2
13896           in: query
13897           description: alternative pserver name
13898           required: false
13899           type: string
13900     put:
13901       tags:
13902         - CloudInfrastructure
13903       summary: create or update an existing pserver
13904       description: |
13905         Create or update an existing pserver.
13906         #
13907         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
13908       operationId: createOrUpdateCloudInfrastructurePserversPserver
13909       consumes:
13910         - application/json
13911         - application/xml
13912       produces:
13913         - application/json
13914         - application/xml
13915       responses:
13916         "default":
13917           description: Response codes found in [response codes](https://wiki.onap.org/).
13918       parameters:
13919         - name: hostname
13920           in: path
13921           description: Value from executing hostname on the compute node.
13922           required: true
13923           type: string
13924           example: __HOSTNAME__
13925         - name: body
13926           in: body
13927           description: pserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserver.json)
13928           required: true
13929           schema:
13930             $ref: "#/definitions/pserver"
13931     patch:
13932       tags:
13933         - CloudInfrastructure
13934       summary: update an existing pserver
13935       description: |
13936         Update an existing pserver
13937         #
13938         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13939         The PUT operation will entirely replace an existing object.
13940         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
13941         #
13942         Other differences between PUT and PATCH are:
13943         #
13944         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
13945         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13946         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13947       operationId: UpdateCloudInfrastructurePserversPserver
13948       consumes:
13949         - application/json
13950         - application/xml
13951       produces:
13952         - application/json
13953         - application/xml
13954       responses:
13955         "default":
13956           description: Response codes found in [response codes](https://wiki.onap.org/).
13957       parameters:
13958         - name: hostname
13959           in: path
13960           description: Value from executing hostname on the compute node.
13961           required: true
13962           type: string
13963           example: __HOSTNAME__
13964         - name: body
13965           in: body
13966           description: pserver object that needs to be created or updated.
13967           required: true
13968           schema:
13969             $ref: "#/patchDefinitions/pserver"
13970     delete:
13971       tags:
13972         - CloudInfrastructure
13973       summary: delete an existing pserver
13974       description: delete an existing pserver
13975       operationId: deleteCloudInfrastructurePserversPserver
13976       consumes:
13977         - application/json
13978         - application/xml
13979       produces:
13980         - application/json
13981         - application/xml
13982       responses:
13983         "default":
13984           description: Response codes found in [response codes](https://wiki.onap.org/).
13985       parameters:
13986         - name: hostname
13987           in: path
13988           description: Value from executing hostname on the compute node.
13989           required: true
13990           type: string
13991           example: __HOSTNAME__
13992         - name: resource-version
13993           in: query
13994           description: resource-version for concurrency
13995           required: true
13996           type: string
13997   /cloud-infrastructure/pservers:
13998     get:
13999       tags:
14000         - CloudInfrastructure
14001       summary: returns pservers
14002       description: returns pservers
14003       operationId: getCloudInfrastructurePservers
14004       produces:
14005         - application/json
14006         - application/xml
14007       responses:
14008         "200":
14009           description: successful operation
14010           schema:
14011               $ref: "#/getDefinitions/pservers"
14012         "default":
14013           description: Response codes found in [response codes](https://wiki.onap.org/).
14014   /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship:
14015     put:
14016       tags:
14017         - CloudInfrastructure
14018       summary: see node definition for valid relationships
14019       operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
14020       consumes:
14021         - application/json
14022         - application/xml
14023       produces:
14024         - application/json
14025         - application/xml
14026       responses:
14027         "default":
14028           description: Response codes found in [response codes](https://wiki.onap.org/).
14029       parameters:
14030         - name: vdc-id
14031           in: path
14032           description: Unique ID of the vdc
14033           required: true
14034           type: string
14035           example: __VDC-ID__
14036         - name: body
14037           in: body
14038           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
14039           required: true
14040           schema:
14041             $ref: "#/definitions/relationship"
14042     delete:
14043       tags:
14044         - CloudInfrastructure
14045       summary: delete an existing relationship
14046       description: delete an existing relationship
14047       operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
14048       consumes:
14049         - application/json
14050         - application/xml
14051       produces:
14052         - application/json
14053         - application/xml
14054       responses:
14055         "default":
14056           description: Response codes found in [response codes](https://wiki.onap.org/).
14057       parameters:
14058         - name: vdc-id
14059           in: path
14060           description: Unique ID of the vdc
14061           required: true
14062           type: string
14063           example: __VDC-ID__
14064   /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}:
14065     get:
14066       tags:
14067         - CloudInfrastructure
14068       summary: returns virtual-data-center
14069       description: returns virtual-data-center
14070       operationId: getCloudInfrastructureVirtualDataCentersVirtualDataCenter
14071       produces:
14072         - application/json
14073         - application/xml
14074       responses:
14075         "200":
14076           description: successful operation
14077           schema:
14078               $ref: "#/getDefinitions/virtual-data-center"
14079         "default":
14080           description: Response codes found in [response codes](https://wiki.onap.org/).
14081       parameters:
14082         - name: vdc-id
14083           in: path
14084           description: Unique ID of the vdc
14085           required: true
14086           type: string
14087           example: __VDC-ID__
14088         - name: vdc-name
14089           in: query
14090           description: Name of the virtual data center
14091           required: false
14092           type: string
14093     put:
14094       tags:
14095         - CloudInfrastructure
14096       summary: create or update an existing virtual-data-center
14097       description: |
14098         Create or update an existing virtual-data-center.
14099         #
14100         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
14101       operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter
14102       consumes:
14103         - application/json
14104         - application/xml
14105       produces:
14106         - application/json
14107         - application/xml
14108       responses:
14109         "default":
14110           description: Response codes found in [response codes](https://wiki.onap.org/).
14111       parameters:
14112         - name: vdc-id
14113           in: path
14114           description: Unique ID of the vdc
14115           required: true
14116           type: string
14117           example: __VDC-ID__
14118         - name: body
14119           in: body
14120           description: virtual-data-center object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
14121           required: true
14122           schema:
14123             $ref: "#/definitions/virtual-data-center"
14124     patch:
14125       tags:
14126         - CloudInfrastructure
14127       summary: update an existing virtual-data-center
14128       description: |
14129         Update an existing virtual-data-center
14130         #
14131         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14132         The PUT operation will entirely replace an existing object.
14133         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
14134         #
14135         Other differences between PUT and PATCH are:
14136         #
14137         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14138         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14139         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14140       operationId: UpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter
14141       consumes:
14142         - application/json
14143         - application/xml
14144       produces:
14145         - application/json
14146         - application/xml
14147       responses:
14148         "default":
14149           description: Response codes found in [response codes](https://wiki.onap.org/).
14150       parameters:
14151         - name: vdc-id
14152           in: path
14153           description: Unique ID of the vdc
14154           required: true
14155           type: string
14156           example: __VDC-ID__
14157         - name: body
14158           in: body
14159           description: virtual-data-center object that needs to be created or updated.
14160           required: true
14161           schema:
14162             $ref: "#/patchDefinitions/virtual-data-center"
14163     delete:
14164       tags:
14165         - CloudInfrastructure
14166       summary: delete an existing virtual-data-center
14167       description: delete an existing virtual-data-center
14168       operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenter
14169       consumes:
14170         - application/json
14171         - application/xml
14172       produces:
14173         - application/json
14174         - application/xml
14175       responses:
14176         "default":
14177           description: Response codes found in [response codes](https://wiki.onap.org/).
14178       parameters:
14179         - name: vdc-id
14180           in: path
14181           description: Unique ID of the vdc
14182           required: true
14183           type: string
14184           example: __VDC-ID__
14185         - name: resource-version
14186           in: query
14187           description: resource-version for concurrency
14188           required: true
14189           type: string
14190   /cloud-infrastructure/virtual-data-centers:
14191     get:
14192       tags:
14193         - CloudInfrastructure
14194       summary: returns virtual-data-centers
14195       description: returns virtual-data-centers
14196       operationId: getCloudInfrastructureVirtualDataCenters
14197       produces:
14198         - application/json
14199         - application/xml
14200       responses:
14201         "200":
14202           description: successful operation
14203           schema:
14204               $ref: "#/getDefinitions/virtual-data-centers"
14205         "default":
14206           description: Response codes found in [response codes](https://wiki.onap.org/).
14207   /business/connectors/connector/{resource-instance-id}/relationship-list/relationship:
14208     put:
14209       tags:
14210         - Business
14211       summary: see node definition for valid relationships
14212       operationId: createOrUpdateBusinessConnectorsConnectorRelationshipListRelationship
14213       consumes:
14214         - application/json
14215         - application/xml
14216       produces:
14217         - application/json
14218         - application/xml
14219       responses:
14220         "default":
14221           description: Response codes found in [response codes](https://wiki.onap.org/).
14222       parameters:
14223         - name: resource-instance-id
14224           in: path
14225           description: Unique id of resource instance.
14226           required: true
14227           type: string
14228           example: __RESOURCE-INSTANCE-ID__
14229         - name: body
14230           in: body
14231           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessConnectorsConnector.json)
14232           required: true
14233           schema:
14234             $ref: "#/definitions/relationship"
14235     delete:
14236       tags:
14237         - Business
14238       summary: delete an existing relationship
14239       description: delete an existing relationship
14240       operationId: deleteBusinessConnectorsConnectorRelationshipListRelationship
14241       consumes:
14242         - application/json
14243         - application/xml
14244       produces:
14245         - application/json
14246         - application/xml
14247       responses:
14248         "default":
14249           description: Response codes found in [response codes](https://wiki.onap.org/).
14250       parameters:
14251         - name: resource-instance-id
14252           in: path
14253           description: Unique id of resource instance.
14254           required: true
14255           type: string
14256           example: __RESOURCE-INSTANCE-ID__
14257   /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}:
14258     get:
14259       tags:
14260         - Business
14261       summary: returns metadatum
14262       description: returns metadatum
14263       operationId: getBusinessConnectorsConnectorMetadataMetadatum
14264       produces:
14265         - application/json
14266         - application/xml
14267       responses:
14268         "200":
14269           description: successful operation
14270           schema:
14271               $ref: "#/getDefinitions/metadatum"
14272         "default":
14273           description: Response codes found in [response codes](https://wiki.onap.org/).
14274       parameters:
14275         - name: resource-instance-id
14276           in: path
14277           description: Unique id of resource instance.
14278           required: true
14279           type: string
14280           example: __RESOURCE-INSTANCE-ID__
14281         - name: metaname
14282           in: path
14283           required: true
14284           type: string
14285           example: __METANAME__
14286         - name: persona-model-id
14287           in: query
14288           description: the ASDC model id for this resource or service model.
14289           required: false
14290           type: string
14291         - name: persona-model-version
14292           in: query
14293           description: the ASDC model version for this resource or service model.
14294           required: false
14295           type: string
14296         - name: widget-model-id
14297           in: query
14298           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
14299           required: false
14300           type: string
14301         - name: widget-model-version
14302           in: query
14303           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
14304           required: false
14305           type: string
14306     put:
14307       tags:
14308         - Business
14309       summary: create or update an existing metadatum
14310       description: |
14311         Create or update an existing metadatum.
14312         #
14313         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
14314       operationId: createOrUpdateBusinessConnectorsConnectorMetadataMetadatum
14315       consumes:
14316         - application/json
14317         - application/xml
14318       produces:
14319         - application/json
14320         - application/xml
14321       responses:
14322         "default":
14323           description: Response codes found in [response codes](https://wiki.onap.org/).
14324       parameters:
14325         - name: resource-instance-id
14326           in: path
14327           description: Unique id of resource instance.
14328           required: true
14329           type: string
14330           example: __RESOURCE-INSTANCE-ID__
14331         - name: metaname
14332           in: path
14333           required: true
14334           type: string
14335           example: __METANAME__
14336         - name: body
14337           in: body
14338           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessConnectorsConnectorMetadataMetadatum.json)
14339           required: true
14340           schema:
14341             $ref: "#/definitions/metadatum"
14342     patch:
14343       tags:
14344         - Business
14345       summary: update an existing metadatum
14346       description: |
14347         Update an existing metadatum
14348         #
14349         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14350         The PUT operation will entirely replace an existing object.
14351         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
14352         #
14353         Other differences between PUT and PATCH are:
14354         #
14355         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14356         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14357         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14358       operationId: UpdateBusinessConnectorsConnectorMetadataMetadatum
14359       consumes:
14360         - application/json
14361         - application/xml
14362       produces:
14363         - application/json
14364         - application/xml
14365       responses:
14366         "default":
14367           description: Response codes found in [response codes](https://wiki.onap.org/).
14368       parameters:
14369         - name: resource-instance-id
14370           in: path
14371           description: Unique id of resource instance.
14372           required: true
14373           type: string
14374           example: __RESOURCE-INSTANCE-ID__
14375         - name: metaname
14376           in: path
14377           required: true
14378           type: string
14379           example: __METANAME__
14380         - name: body
14381           in: body
14382           description: metadatum object that needs to be created or updated.
14383           required: true
14384           schema:
14385             $ref: "#/patchDefinitions/metadatum"
14386     delete:
14387       tags:
14388         - Business
14389       summary: delete an existing metadatum
14390       description: delete an existing metadatum
14391       operationId: deleteBusinessConnectorsConnectorMetadataMetadatum
14392       consumes:
14393         - application/json
14394         - application/xml
14395       produces:
14396         - application/json
14397         - application/xml
14398       responses:
14399         "default":
14400           description: Response codes found in [response codes](https://wiki.onap.org/).
14401       parameters:
14402         - name: resource-instance-id
14403           in: path
14404           description: Unique id of resource instance.
14405           required: true
14406           type: string
14407           example: __RESOURCE-INSTANCE-ID__
14408         - name: metaname
14409           in: path
14410           required: true
14411           type: string
14412           example: __METANAME__
14413         - name: resource-version
14414           in: query
14415           description: resource-version for concurrency
14416           required: true
14417           type: string
14418   /business/connectors/connector/{resource-instance-id}/metadata:
14419     get:
14420       tags:
14421         - Business
14422       summary: returns metadata
14423       description: returns metadata
14424       operationId: getBusinessConnectorsConnectorMetadata
14425       produces:
14426         - application/json
14427         - application/xml
14428       responses:
14429         "200":
14430           description: successful operation
14431           schema:
14432               $ref: "#/getDefinitions/metadata"
14433         "default":
14434           description: Response codes found in [response codes](https://wiki.onap.org/).
14435       parameters:
14436         - name: resource-instance-id
14437           in: path
14438           description: Unique id of resource instance.
14439           required: true
14440           type: string
14441           example: __RESOURCE-INSTANCE-ID__
14442         - name: persona-model-id
14443           in: query
14444           description: the ASDC model id for this resource or service model.
14445           required: false
14446           type: string
14447         - name: persona-model-version
14448           in: query
14449           description: the ASDC model version for this resource or service model.
14450           required: false
14451           type: string
14452         - name: widget-model-id
14453           in: query
14454           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
14455           required: false
14456           type: string
14457         - name: widget-model-version
14458           in: query
14459           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
14460           required: false
14461           type: string
14462   /business/connectors/connector/{resource-instance-id}:
14463     get:
14464       tags:
14465         - Business
14466       summary: returns connector
14467       description: returns connector
14468       operationId: getBusinessConnectorsConnector
14469       produces:
14470         - application/json
14471         - application/xml
14472       responses:
14473         "200":
14474           description: successful operation
14475           schema:
14476               $ref: "#/getDefinitions/connector"
14477         "default":
14478           description: Response codes found in [response codes](https://wiki.onap.org/).
14479       parameters:
14480         - name: resource-instance-id
14481           in: path
14482           description: Unique id of resource instance.
14483           required: true
14484           type: string
14485           example: __RESOURCE-INSTANCE-ID__
14486         - name: persona-model-id
14487           in: query
14488           description: the ASDC model id for this resource or service model.
14489           required: false
14490           type: string
14491         - name: persona-model-version
14492           in: query
14493           description: the ASDC model version for this resource or service model.
14494           required: false
14495           type: string
14496         - name: widget-model-id
14497           in: query
14498           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
14499           required: false
14500           type: string
14501         - name: widget-model-version
14502           in: query
14503           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
14504           required: false
14505           type: string
14506     put:
14507       tags:
14508         - Business
14509       summary: create or update an existing connector
14510       description: |
14511         Create or update an existing connector.
14512         #
14513         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
14514       operationId: createOrUpdateBusinessConnectorsConnector
14515       consumes:
14516         - application/json
14517         - application/xml
14518       produces:
14519         - application/json
14520         - application/xml
14521       responses:
14522         "default":
14523           description: Response codes found in [response codes](https://wiki.onap.org/).
14524       parameters:
14525         - name: resource-instance-id
14526           in: path
14527           description: Unique id of resource instance.
14528           required: true
14529           type: string
14530           example: __RESOURCE-INSTANCE-ID__
14531         - name: body
14532           in: body
14533           description: connector object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessConnectorsConnector.json)
14534           required: true
14535           schema:
14536             $ref: "#/definitions/connector"
14537     patch:
14538       tags:
14539         - Business
14540       summary: update an existing connector
14541       description: |
14542         Update an existing connector
14543         #
14544         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14545         The PUT operation will entirely replace an existing object.
14546         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
14547         #
14548         Other differences between PUT and PATCH are:
14549         #
14550         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14551         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14552         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14553       operationId: UpdateBusinessConnectorsConnector
14554       consumes:
14555         - application/json
14556         - application/xml
14557       produces:
14558         - application/json
14559         - application/xml
14560       responses:
14561         "default":
14562           description: Response codes found in [response codes](https://wiki.onap.org/).
14563       parameters:
14564         - name: resource-instance-id
14565           in: path
14566           description: Unique id of resource instance.
14567           required: true
14568           type: string
14569           example: __RESOURCE-INSTANCE-ID__
14570         - name: body
14571           in: body
14572           description: connector object that needs to be created or updated.
14573           required: true
14574           schema:
14575             $ref: "#/patchDefinitions/connector"
14576     delete:
14577       tags:
14578         - Business
14579       summary: delete an existing connector
14580       description: delete an existing connector
14581       operationId: deleteBusinessConnectorsConnector
14582       consumes:
14583         - application/json
14584         - application/xml
14585       produces:
14586         - application/json
14587         - application/xml
14588       responses:
14589         "default":
14590           description: Response codes found in [response codes](https://wiki.onap.org/).
14591       parameters:
14592         - name: resource-instance-id
14593           in: path
14594           description: Unique id of resource instance.
14595           required: true
14596           type: string
14597           example: __RESOURCE-INSTANCE-ID__
14598         - name: resource-version
14599           in: query
14600           description: resource-version for concurrency
14601           required: true
14602           type: string
14603   /business/connectors:
14604     get:
14605       tags:
14606         - Business
14607       summary: returns connectors
14608       description: returns connectors
14609       operationId: getBusinessConnectors
14610       produces:
14611         - application/json
14612         - application/xml
14613       responses:
14614         "200":
14615           description: successful operation
14616           schema:
14617               $ref: "#/getDefinitions/connectors"
14618         "default":
14619           description: Response codes found in [response codes](https://wiki.onap.org/).
14620   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship:
14621     put:
14622       tags:
14623         - Business
14624       summary: see node definition for valid relationships
14625       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
14626       consumes:
14627         - application/json
14628         - application/xml
14629       produces:
14630         - application/json
14631         - application/xml
14632       responses:
14633         "default":
14634           description: Response codes found in [response codes](https://wiki.onap.org/).
14635       parameters:
14636         - name: global-customer-id
14637           in: path
14638           description: Global customer id used across ECOMP to uniquely identify customer.
14639           required: true
14640           type: string
14641           example: __GLOBAL-CUSTOMER-ID__
14642         - name: service-type
14643           in: path
14644           description: Value defined by orchestration to identify this service across ECOMP.
14645           required: true
14646           type: string
14647           example: __SERVICE-TYPE__
14648         - name: service-instance-id
14649           in: path
14650           description: Uniquely identifies this instance of a service
14651           required: true
14652           type: string
14653           example: __SERVICE-INSTANCE-ID__
14654         - name: body
14655           in: body
14656           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
14657           required: true
14658           schema:
14659             $ref: "#/definitions/relationship"
14660     delete:
14661       tags:
14662         - Business
14663       summary: delete an existing relationship
14664       description: delete an existing relationship
14665       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
14666       consumes:
14667         - application/json
14668         - application/xml
14669       produces:
14670         - application/json
14671         - application/xml
14672       responses:
14673         "default":
14674           description: Response codes found in [response codes](https://wiki.onap.org/).
14675       parameters:
14676         - name: global-customer-id
14677           in: path
14678           description: Global customer id used across ECOMP to uniquely identify customer.
14679           required: true
14680           type: string
14681           example: __GLOBAL-CUSTOMER-ID__
14682         - name: service-type
14683           in: path
14684           description: Value defined by orchestration to identify this service across ECOMP.
14685           required: true
14686           type: string
14687           example: __SERVICE-TYPE__
14688         - name: service-instance-id
14689           in: path
14690           description: Uniquely identifies this instance of a service
14691           required: true
14692           type: string
14693           example: __SERVICE-INSTANCE-ID__
14694   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}:
14695     get:
14696       tags:
14697         - Business
14698       summary: returns metadatum
14699       description: returns metadatum
14700       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
14701       produces:
14702         - application/json
14703         - application/xml
14704       responses:
14705         "200":
14706           description: successful operation
14707           schema:
14708               $ref: "#/getDefinitions/metadatum"
14709         "default":
14710           description: Response codes found in [response codes](https://wiki.onap.org/).
14711       parameters:
14712         - name: global-customer-id
14713           in: path
14714           description: Global customer id used across ECOMP to uniquely identify customer.
14715           required: true
14716           type: string
14717           example: __GLOBAL-CUSTOMER-ID__
14718         - name: service-type
14719           in: path
14720           description: Value defined by orchestration to identify this service across ECOMP.
14721           required: true
14722           type: string
14723           example: __SERVICE-TYPE__
14724         - name: service-instance-id
14725           in: path
14726           description: Uniquely identifies this instance of a service
14727           required: true
14728           type: string
14729           example: __SERVICE-INSTANCE-ID__
14730         - name: metaname
14731           in: path
14732           required: true
14733           type: string
14734           example: __METANAME__
14735         - name: subscriber-name
14736           in: query
14737           description: Subscriber name, an alternate way to retrieve a customer.
14738           required: false
14739           type: string
14740         - name: subscriber-type
14741           in: query
14742           description: Subscriber type, a way to provide VID with only the INFRA customers.
14743           required: false
14744           type: string
14745         - name: service-instance-name
14746           in: query
14747           description: This field will store a name assigned to the service-instance.
14748           required: false
14749           type: string
14750         - name: persona-model-id
14751           in: query
14752           description: the ASDC model id for this resource or service model.
14753           required: false
14754           type: string
14755         - name: persona-model-version
14756           in: query
14757           description: the ASDC model version for this resource or service model.
14758           required: false
14759           type: string
14760         - name: widget-model-id
14761           in: query
14762           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
14763           required: false
14764           type: string
14765         - name: widget-model-version
14766           in: query
14767           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
14768           required: false
14769           type: string
14770         - name: service-instance-location-id
14771           in: query
14772           description: An identifier that customers assign to the location where this service is being used.
14773           required: false
14774           type: string
14775         - name: orchestration-status
14776           in: query
14777           description: Orchestration status of this service.
14778           required: false
14779           type: string
14780     put:
14781       tags:
14782         - Business
14783       summary: create or update an existing metadatum
14784       description: |
14785         Create or update an existing metadatum.
14786         #
14787         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
14788       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
14789       consumes:
14790         - application/json
14791         - application/xml
14792       produces:
14793         - application/json
14794         - application/xml
14795       responses:
14796         "default":
14797           description: Response codes found in [response codes](https://wiki.onap.org/).
14798       parameters:
14799         - name: global-customer-id
14800           in: path
14801           description: Global customer id used across ECOMP to uniquely identify customer.
14802           required: true
14803           type: string
14804           example: __GLOBAL-CUSTOMER-ID__
14805         - name: service-type
14806           in: path
14807           description: Value defined by orchestration to identify this service across ECOMP.
14808           required: true
14809           type: string
14810           example: __SERVICE-TYPE__
14811         - name: service-instance-id
14812           in: path
14813           description: Uniquely identifies this instance of a service
14814           required: true
14815           type: string
14816           example: __SERVICE-INSTANCE-ID__
14817         - name: metaname
14818           in: path
14819           required: true
14820           type: string
14821           example: __METANAME__
14822         - name: body
14823           in: body
14824           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum.json)
14825           required: true
14826           schema:
14827             $ref: "#/definitions/metadatum"
14828     patch:
14829       tags:
14830         - Business
14831       summary: update an existing metadatum
14832       description: |
14833         Update an existing metadatum
14834         #
14835         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14836         The PUT operation will entirely replace an existing object.
14837         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
14838         #
14839         Other differences between PUT and PATCH are:
14840         #
14841         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14842         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14843         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14844       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
14845       consumes:
14846         - application/json
14847         - application/xml
14848       produces:
14849         - application/json
14850         - application/xml
14851       responses:
14852         "default":
14853           description: Response codes found in [response codes](https://wiki.onap.org/).
14854       parameters:
14855         - name: global-customer-id
14856           in: path
14857           description: Global customer id used across ECOMP to uniquely identify customer.
14858           required: true
14859           type: string
14860           example: __GLOBAL-CUSTOMER-ID__
14861         - name: service-type
14862           in: path
14863           description: Value defined by orchestration to identify this service across ECOMP.
14864           required: true
14865           type: string
14866           example: __SERVICE-TYPE__
14867         - name: service-instance-id
14868           in: path
14869           description: Uniquely identifies this instance of a service
14870           required: true
14871           type: string
14872           example: __SERVICE-INSTANCE-ID__
14873         - name: metaname
14874           in: path
14875           required: true
14876           type: string
14877           example: __METANAME__
14878         - name: body
14879           in: body
14880           description: metadatum object that needs to be created or updated.
14881           required: true
14882           schema:
14883             $ref: "#/patchDefinitions/metadatum"
14884     delete:
14885       tags:
14886         - Business
14887       summary: delete an existing metadatum
14888       description: delete an existing metadatum
14889       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
14890       consumes:
14891         - application/json
14892         - application/xml
14893       produces:
14894         - application/json
14895         - application/xml
14896       responses:
14897         "default":
14898           description: Response codes found in [response codes](https://wiki.onap.org/).
14899       parameters:
14900         - name: global-customer-id
14901           in: path
14902           description: Global customer id used across ECOMP to uniquely identify customer.
14903           required: true
14904           type: string
14905           example: __GLOBAL-CUSTOMER-ID__
14906         - name: service-type
14907           in: path
14908           description: Value defined by orchestration to identify this service across ECOMP.
14909           required: true
14910           type: string
14911           example: __SERVICE-TYPE__
14912         - name: service-instance-id
14913           in: path
14914           description: Uniquely identifies this instance of a service
14915           required: true
14916           type: string
14917           example: __SERVICE-INSTANCE-ID__
14918         - name: metaname
14919           in: path
14920           required: true
14921           type: string
14922           example: __METANAME__
14923         - name: resource-version
14924           in: query
14925           description: resource-version for concurrency
14926           required: true
14927           type: string
14928   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata:
14929     get:
14930       tags:
14931         - Business
14932       summary: returns metadata
14933       description: returns metadata
14934       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadata
14935       produces:
14936         - application/json
14937         - application/xml
14938       responses:
14939         "200":
14940           description: successful operation
14941           schema:
14942               $ref: "#/getDefinitions/metadata"
14943         "default":
14944           description: Response codes found in [response codes](https://wiki.onap.org/).
14945       parameters:
14946         - name: global-customer-id
14947           in: path
14948           description: Global customer id used across ECOMP to uniquely identify customer.
14949           required: true
14950           type: string
14951           example: __GLOBAL-CUSTOMER-ID__
14952         - name: service-type
14953           in: path
14954           description: Value defined by orchestration to identify this service across ECOMP.
14955           required: true
14956           type: string
14957           example: __SERVICE-TYPE__
14958         - name: service-instance-id
14959           in: path
14960           description: Uniquely identifies this instance of a service
14961           required: true
14962           type: string
14963           example: __SERVICE-INSTANCE-ID__
14964         - name: subscriber-name
14965           in: query
14966           description: Subscriber name, an alternate way to retrieve a customer.
14967           required: false
14968           type: string
14969         - name: subscriber-type
14970           in: query
14971           description: Subscriber type, a way to provide VID with only the INFRA customers.
14972           required: false
14973           type: string
14974         - name: service-instance-name
14975           in: query
14976           description: This field will store a name assigned to the service-instance.
14977           required: false
14978           type: string
14979         - name: persona-model-id
14980           in: query
14981           description: the ASDC model id for this resource or service model.
14982           required: false
14983           type: string
14984         - name: persona-model-version
14985           in: query
14986           description: the ASDC model version for this resource or service model.
14987           required: false
14988           type: string
14989         - name: widget-model-id
14990           in: query
14991           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
14992           required: false
14993           type: string
14994         - name: widget-model-version
14995           in: query
14996           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
14997           required: false
14998           type: string
14999         - name: service-instance-location-id
15000           in: query
15001           description: An identifier that customers assign to the location where this service is being used.
15002           required: false
15003           type: string
15004         - name: orchestration-status
15005           in: query
15006           description: Orchestration status of this service.
15007           required: false
15008           type: string
15009   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{id}/relationship-list/relationship:
15010     put:
15011       tags:
15012         - Business
15013       summary: see node definition for valid relationships
15014       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship
15015       consumes:
15016         - application/json
15017         - application/xml
15018       produces:
15019         - application/json
15020         - application/xml
15021       responses:
15022         "default":
15023           description: Response codes found in [response codes](https://wiki.onap.org/).
15024       parameters:
15025         - name: global-customer-id
15026           in: path
15027           description: Global customer id used across ECOMP to uniquely identify customer.
15028           required: true
15029           type: string
15030           example: __GLOBAL-CUSTOMER-ID__
15031         - name: service-type
15032           in: path
15033           description: Value defined by orchestration to identify this service across ECOMP.
15034           required: true
15035           type: string
15036           example: __SERVICE-TYPE__
15037         - name: service-instance-id
15038           in: path
15039           description: Uniquely identifies this instance of a service
15040           required: true
15041           type: string
15042           example: __SERVICE-INSTANCE-ID__
15043         - name: id
15044           in: path
15045           description: Allotted Resource id UUID assigned to this instance.
15046           required: true
15047           type: string
15048           example: __ID__
15049         - name: id
15050           in: path
15051           description: Allotted Resource id UUID assigned to this instance.
15052           required: true
15053           type: string
15054           example: __ID__
15055         - name: body
15056           in: body
15057           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)
15058           required: true
15059           schema:
15060             $ref: "#/definitions/relationship"
15061     delete:
15062       tags:
15063         - Business
15064       summary: delete an existing relationship
15065       description: delete an existing relationship
15066       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship
15067       consumes:
15068         - application/json
15069         - application/xml
15070       produces:
15071         - application/json
15072         - application/xml
15073       responses:
15074         "default":
15075           description: Response codes found in [response codes](https://wiki.onap.org/).
15076       parameters:
15077         - name: global-customer-id
15078           in: path
15079           description: Global customer id used across ECOMP to uniquely identify customer.
15080           required: true
15081           type: string
15082           example: __GLOBAL-CUSTOMER-ID__
15083         - name: service-type
15084           in: path
15085           description: Value defined by orchestration to identify this service across ECOMP.
15086           required: true
15087           type: string
15088           example: __SERVICE-TYPE__
15089         - name: service-instance-id
15090           in: path
15091           description: Uniquely identifies this instance of a service
15092           required: true
15093           type: string
15094           example: __SERVICE-INSTANCE-ID__
15095         - name: id
15096           in: path
15097           description: Allotted Resource id UUID assigned to this instance.
15098           required: true
15099           type: string
15100           example: __ID__
15101         - name: id
15102           in: path
15103           description: Allotted Resource id UUID assigned to this instance.
15104           required: true
15105           type: string
15106           example: __ID__
15107   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{id}:
15108     get:
15109       tags:
15110         - Business
15111       summary: returns tunnel-xconnect
15112       description: returns tunnel-xconnect
15113       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
15114       produces:
15115         - application/json
15116         - application/xml
15117       responses:
15118         "200":
15119           description: successful operation
15120           schema:
15121               $ref: "#/getDefinitions/tunnel-xconnect"
15122         "default":
15123           description: Response codes found in [response codes](https://wiki.onap.org/).
15124       parameters:
15125         - name: global-customer-id
15126           in: path
15127           description: Global customer id used across ECOMP to uniquely identify customer.
15128           required: true
15129           type: string
15130           example: __GLOBAL-CUSTOMER-ID__
15131         - name: service-type
15132           in: path
15133           description: Value defined by orchestration to identify this service across ECOMP.
15134           required: true
15135           type: string
15136           example: __SERVICE-TYPE__
15137         - name: service-instance-id
15138           in: path
15139           description: Uniquely identifies this instance of a service
15140           required: true
15141           type: string
15142           example: __SERVICE-INSTANCE-ID__
15143         - name: id
15144           in: path
15145           description: Allotted Resource id UUID assigned to this instance.
15146           required: true
15147           type: string
15148           example: __ID__
15149         - name: id
15150           in: path
15151           description: Allotted Resource id UUID assigned to this instance.
15152           required: true
15153           type: string
15154           example: __ID__
15155         - name: subscriber-name
15156           in: query
15157           description: Subscriber name, an alternate way to retrieve a customer.
15158           required: false
15159           type: string
15160         - name: subscriber-type
15161           in: query
15162           description: Subscriber type, a way to provide VID with only the INFRA customers.
15163           required: false
15164           type: string
15165         - name: service-instance-name
15166           in: query
15167           description: This field will store a name assigned to the service-instance.
15168           required: false
15169           type: string
15170         - name: persona-model-id
15171           in: query
15172           description: the ASDC model id for this resource or service model.
15173           required: false
15174           type: string
15175         - name: persona-model-version
15176           in: query
15177           description: the ASDC model version for this resource or service model.
15178           required: false
15179           type: string
15180         - name: widget-model-id
15181           in: query
15182           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
15183           required: false
15184           type: string
15185         - name: widget-model-version
15186           in: query
15187           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
15188           required: false
15189           type: string
15190         - name: service-instance-location-id
15191           in: query
15192           description: An identifier that customers assign to the location where this service is being used.
15193           required: false
15194           type: string
15195         - name: orchestration-status
15196           in: query
15197           description: Orchestration status of this service.
15198           required: false
15199           type: string
15200         - name: persona-model-id
15201           in: query
15202           description: the ASDC model id for this resource or service model.
15203           required: false
15204           type: string
15205         - name: persona-model-version
15206           in: query
15207           description: the ASDC model version for this resource or service model.
15208           required: false
15209           type: string
15210     put:
15211       tags:
15212         - Business
15213       summary: create or update an existing tunnel-xconnect
15214       description: |
15215         Create or update an existing tunnel-xconnect.
15216         #
15217         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
15218       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
15219       consumes:
15220         - application/json
15221         - application/xml
15222       produces:
15223         - application/json
15224         - application/xml
15225       responses:
15226         "default":
15227           description: Response codes found in [response codes](https://wiki.onap.org/).
15228       parameters:
15229         - name: global-customer-id
15230           in: path
15231           description: Global customer id used across ECOMP to uniquely identify customer.
15232           required: true
15233           type: string
15234           example: __GLOBAL-CUSTOMER-ID__
15235         - name: service-type
15236           in: path
15237           description: Value defined by orchestration to identify this service across ECOMP.
15238           required: true
15239           type: string
15240           example: __SERVICE-TYPE__
15241         - name: service-instance-id
15242           in: path
15243           description: Uniquely identifies this instance of a service
15244           required: true
15245           type: string
15246           example: __SERVICE-INSTANCE-ID__
15247         - name: id
15248           in: path
15249           description: Allotted Resource id UUID assigned to this instance.
15250           required: true
15251           type: string
15252           example: __ID__
15253         - name: id
15254           in: path
15255           description: Allotted Resource id UUID assigned to this instance.
15256           required: true
15257           type: string
15258           example: __ID__
15259         - name: body
15260           in: body
15261           description: tunnel-xconnect object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)
15262           required: true
15263           schema:
15264             $ref: "#/definitions/tunnel-xconnect"
15265     patch:
15266       tags:
15267         - Business
15268       summary: update an existing tunnel-xconnect
15269       description: |
15270         Update an existing tunnel-xconnect
15271         #
15272         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15273         The PUT operation will entirely replace an existing object.
15274         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
15275         #
15276         Other differences between PUT and PATCH are:
15277         #
15278         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
15279         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15280         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15281       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
15282       consumes:
15283         - application/json
15284         - application/xml
15285       produces:
15286         - application/json
15287         - application/xml
15288       responses:
15289         "default":
15290           description: Response codes found in [response codes](https://wiki.onap.org/).
15291       parameters:
15292         - name: global-customer-id
15293           in: path
15294           description: Global customer id used across ECOMP to uniquely identify customer.
15295           required: true
15296           type: string
15297           example: __GLOBAL-CUSTOMER-ID__
15298         - name: service-type
15299           in: path
15300           description: Value defined by orchestration to identify this service across ECOMP.
15301           required: true
15302           type: string
15303           example: __SERVICE-TYPE__
15304         - name: service-instance-id
15305           in: path
15306           description: Uniquely identifies this instance of a service
15307           required: true
15308           type: string
15309           example: __SERVICE-INSTANCE-ID__
15310         - name: id
15311           in: path
15312           description: Allotted Resource id UUID assigned to this instance.
15313           required: true
15314           type: string
15315           example: __ID__
15316         - name: id
15317           in: path
15318           description: Allotted Resource id UUID assigned to this instance.
15319           required: true
15320           type: string
15321           example: __ID__
15322         - name: body
15323           in: body
15324           description: tunnel-xconnect object that needs to be created or updated.
15325           required: true
15326           schema:
15327             $ref: "#/patchDefinitions/tunnel-xconnect"
15328     delete:
15329       tags:
15330         - Business
15331       summary: delete an existing tunnel-xconnect
15332       description: delete an existing tunnel-xconnect
15333       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
15334       consumes:
15335         - application/json
15336         - application/xml
15337       produces:
15338         - application/json
15339         - application/xml
15340       responses:
15341         "default":
15342           description: Response codes found in [response codes](https://wiki.onap.org/).
15343       parameters:
15344         - name: global-customer-id
15345           in: path
15346           description: Global customer id used across ECOMP to uniquely identify customer.
15347           required: true
15348           type: string
15349           example: __GLOBAL-CUSTOMER-ID__
15350         - name: service-type
15351           in: path
15352           description: Value defined by orchestration to identify this service across ECOMP.
15353           required: true
15354           type: string
15355           example: __SERVICE-TYPE__
15356         - name: service-instance-id
15357           in: path
15358           description: Uniquely identifies this instance of a service
15359           required: true
15360           type: string
15361           example: __SERVICE-INSTANCE-ID__
15362         - name: id
15363           in: path
15364           description: Allotted Resource id UUID assigned to this instance.
15365           required: true
15366           type: string
15367           example: __ID__
15368         - name: id
15369           in: path
15370           description: Allotted Resource id UUID assigned to this instance.
15371           required: true
15372           type: string
15373           example: __ID__
15374         - name: resource-version
15375           in: query
15376           description: resource-version for concurrency
15377           required: true
15378           type: string
15379   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects:
15380     get:
15381       tags:
15382         - Business
15383       summary: returns tunnel-xconnects
15384       description: returns tunnel-xconnects
15385       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnects
15386       produces:
15387         - application/json
15388         - application/xml
15389       responses:
15390         "200":
15391           description: successful operation
15392           schema:
15393               $ref: "#/getDefinitions/tunnel-xconnects"
15394         "default":
15395           description: Response codes found in [response codes](https://wiki.onap.org/).
15396       parameters:
15397         - name: global-customer-id
15398           in: path
15399           description: Global customer id used across ECOMP to uniquely identify customer.
15400           required: true
15401           type: string
15402           example: __GLOBAL-CUSTOMER-ID__
15403         - name: service-type
15404           in: path
15405           description: Value defined by orchestration to identify this service across ECOMP.
15406           required: true
15407           type: string
15408           example: __SERVICE-TYPE__
15409         - name: service-instance-id
15410           in: path
15411           description: Uniquely identifies this instance of a service
15412           required: true
15413           type: string
15414           example: __SERVICE-INSTANCE-ID__
15415         - name: id
15416           in: path
15417           description: Allotted Resource id UUID assigned to this instance.
15418           required: true
15419           type: string
15420           example: __ID__
15421         - name: subscriber-name
15422           in: query
15423           description: Subscriber name, an alternate way to retrieve a customer.
15424           required: false
15425           type: string
15426         - name: subscriber-type
15427           in: query
15428           description: Subscriber type, a way to provide VID with only the INFRA customers.
15429           required: false
15430           type: string
15431         - name: service-instance-name
15432           in: query
15433           description: This field will store a name assigned to the service-instance.
15434           required: false
15435           type: string
15436         - name: persona-model-id
15437           in: query
15438           description: the ASDC model id for this resource or service model.
15439           required: false
15440           type: string
15441         - name: persona-model-version
15442           in: query
15443           description: the ASDC model version for this resource or service model.
15444           required: false
15445           type: string
15446         - name: widget-model-id
15447           in: query
15448           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
15449           required: false
15450           type: string
15451         - name: widget-model-version
15452           in: query
15453           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
15454           required: false
15455           type: string
15456         - name: service-instance-location-id
15457           in: query
15458           description: An identifier that customers assign to the location where this service is being used.
15459           required: false
15460           type: string
15461         - name: orchestration-status
15462           in: query
15463           description: Orchestration status of this service.
15464           required: false
15465           type: string
15466         - name: persona-model-id
15467           in: query
15468           description: the ASDC model id for this resource or service model.
15469           required: false
15470           type: string
15471         - name: persona-model-version
15472           in: query
15473           description: the ASDC model version for this resource or service model.
15474           required: false
15475           type: string
15476   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/relationship-list/relationship:
15477     put:
15478       tags:
15479         - Business
15480       summary: see node definition for valid relationships
15481       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
15482       consumes:
15483         - application/json
15484         - application/xml
15485       produces:
15486         - application/json
15487         - application/xml
15488       responses:
15489         "default":
15490           description: Response codes found in [response codes](https://wiki.onap.org/).
15491       parameters:
15492         - name: global-customer-id
15493           in: path
15494           description: Global customer id used across ECOMP to uniquely identify customer.
15495           required: true
15496           type: string
15497           example: __GLOBAL-CUSTOMER-ID__
15498         - name: service-type
15499           in: path
15500           description: Value defined by orchestration to identify this service across ECOMP.
15501           required: true
15502           type: string
15503           example: __SERVICE-TYPE__
15504         - name: service-instance-id
15505           in: path
15506           description: Uniquely identifies this instance of a service
15507           required: true
15508           type: string
15509           example: __SERVICE-INSTANCE-ID__
15510         - name: id
15511           in: path
15512           description: Allotted Resource id UUID assigned to this instance.
15513           required: true
15514           type: string
15515           example: __ID__
15516         - name: body
15517           in: body
15518           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)
15519           required: true
15520           schema:
15521             $ref: "#/definitions/relationship"
15522     delete:
15523       tags:
15524         - Business
15525       summary: delete an existing relationship
15526       description: delete an existing relationship
15527       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
15528       consumes:
15529         - application/json
15530         - application/xml
15531       produces:
15532         - application/json
15533         - application/xml
15534       responses:
15535         "default":
15536           description: Response codes found in [response codes](https://wiki.onap.org/).
15537       parameters:
15538         - name: global-customer-id
15539           in: path
15540           description: Global customer id used across ECOMP to uniquely identify customer.
15541           required: true
15542           type: string
15543           example: __GLOBAL-CUSTOMER-ID__
15544         - name: service-type
15545           in: path
15546           description: Value defined by orchestration to identify this service across ECOMP.
15547           required: true
15548           type: string
15549           example: __SERVICE-TYPE__
15550         - name: service-instance-id
15551           in: path
15552           description: Uniquely identifies this instance of a service
15553           required: true
15554           type: string
15555           example: __SERVICE-INSTANCE-ID__
15556         - name: id
15557           in: path
15558           description: Allotted Resource id UUID assigned to this instance.
15559           required: true
15560           type: string
15561           example: __ID__
15562   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}:
15563     get:
15564       tags:
15565         - Business
15566       summary: returns allotted-resource
15567       description: returns allotted-resource
15568       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
15569       produces:
15570         - application/json
15571         - application/xml
15572       responses:
15573         "200":
15574           description: successful operation
15575           schema:
15576               $ref: "#/getDefinitions/allotted-resource"
15577         "default":
15578           description: Response codes found in [response codes](https://wiki.onap.org/).
15579       parameters:
15580         - name: global-customer-id
15581           in: path
15582           description: Global customer id used across ECOMP to uniquely identify customer.
15583           required: true
15584           type: string
15585           example: __GLOBAL-CUSTOMER-ID__
15586         - name: service-type
15587           in: path
15588           description: Value defined by orchestration to identify this service across ECOMP.
15589           required: true
15590           type: string
15591           example: __SERVICE-TYPE__
15592         - name: service-instance-id
15593           in: path
15594           description: Uniquely identifies this instance of a service
15595           required: true
15596           type: string
15597           example: __SERVICE-INSTANCE-ID__
15598         - name: id
15599           in: path
15600           description: Allotted Resource id UUID assigned to this instance.
15601           required: true
15602           type: string
15603           example: __ID__
15604         - name: subscriber-name
15605           in: query
15606           description: Subscriber name, an alternate way to retrieve a customer.
15607           required: false
15608           type: string
15609         - name: subscriber-type
15610           in: query
15611           description: Subscriber type, a way to provide VID with only the INFRA customers.
15612           required: false
15613           type: string
15614         - name: service-instance-name
15615           in: query
15616           description: This field will store a name assigned to the service-instance.
15617           required: false
15618           type: string
15619         - name: persona-model-id
15620           in: query
15621           description: the ASDC model id for this resource or service model.
15622           required: false
15623           type: string
15624         - name: persona-model-version
15625           in: query
15626           description: the ASDC model version for this resource or service model.
15627           required: false
15628           type: string
15629         - name: widget-model-id
15630           in: query
15631           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
15632           required: false
15633           type: string
15634         - name: widget-model-version
15635           in: query
15636           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
15637           required: false
15638           type: string
15639         - name: service-instance-location-id
15640           in: query
15641           description: An identifier that customers assign to the location where this service is being used.
15642           required: false
15643           type: string
15644         - name: orchestration-status
15645           in: query
15646           description: Orchestration status of this service.
15647           required: false
15648           type: string
15649         - name: persona-model-id
15650           in: query
15651           description: the ASDC model id for this resource or service model.
15652           required: false
15653           type: string
15654         - name: persona-model-version
15655           in: query
15656           description: the ASDC model version for this resource or service model.
15657           required: false
15658           type: string
15659     put:
15660       tags:
15661         - Business
15662       summary: create or update an existing allotted-resource
15663       description: |
15664         Create or update an existing allotted-resource.
15665         #
15666         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
15667       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
15668       consumes:
15669         - application/json
15670         - application/xml
15671       produces:
15672         - application/json
15673         - application/xml
15674       responses:
15675         "default":
15676           description: Response codes found in [response codes](https://wiki.onap.org/).
15677       parameters:
15678         - name: global-customer-id
15679           in: path
15680           description: Global customer id used across ECOMP to uniquely identify customer.
15681           required: true
15682           type: string
15683           example: __GLOBAL-CUSTOMER-ID__
15684         - name: service-type
15685           in: path
15686           description: Value defined by orchestration to identify this service across ECOMP.
15687           required: true
15688           type: string
15689           example: __SERVICE-TYPE__
15690         - name: service-instance-id
15691           in: path
15692           description: Uniquely identifies this instance of a service
15693           required: true
15694           type: string
15695           example: __SERVICE-INSTANCE-ID__
15696         - name: id
15697           in: path
15698           description: Allotted Resource id UUID assigned to this instance.
15699           required: true
15700           type: string
15701           example: __ID__
15702         - name: body
15703           in: body
15704           description: allotted-resource object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)
15705           required: true
15706           schema:
15707             $ref: "#/definitions/allotted-resource"
15708     patch:
15709       tags:
15710         - Business
15711       summary: update an existing allotted-resource
15712       description: |
15713         Update an existing allotted-resource
15714         #
15715         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15716         The PUT operation will entirely replace an existing object.
15717         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
15718         #
15719         Other differences between PUT and PATCH are:
15720         #
15721         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
15722         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15723         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15724       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
15725       consumes:
15726         - application/json
15727         - application/xml
15728       produces:
15729         - application/json
15730         - application/xml
15731       responses:
15732         "default":
15733           description: Response codes found in [response codes](https://wiki.onap.org/).
15734       parameters:
15735         - name: global-customer-id
15736           in: path
15737           description: Global customer id used across ECOMP to uniquely identify customer.
15738           required: true
15739           type: string
15740           example: __GLOBAL-CUSTOMER-ID__
15741         - name: service-type
15742           in: path
15743           description: Value defined by orchestration to identify this service across ECOMP.
15744           required: true
15745           type: string
15746           example: __SERVICE-TYPE__
15747         - name: service-instance-id
15748           in: path
15749           description: Uniquely identifies this instance of a service
15750           required: true
15751           type: string
15752           example: __SERVICE-INSTANCE-ID__
15753         - name: id
15754           in: path
15755           description: Allotted Resource id UUID assigned to this instance.
15756           required: true
15757           type: string
15758           example: __ID__
15759         - name: body
15760           in: body
15761           description: allotted-resource object that needs to be created or updated.
15762           required: true
15763           schema:
15764             $ref: "#/patchDefinitions/allotted-resource"
15765     delete:
15766       tags:
15767         - Business
15768       summary: delete an existing allotted-resource
15769       description: delete an existing allotted-resource
15770       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
15771       consumes:
15772         - application/json
15773         - application/xml
15774       produces:
15775         - application/json
15776         - application/xml
15777       responses:
15778         "default":
15779           description: Response codes found in [response codes](https://wiki.onap.org/).
15780       parameters:
15781         - name: global-customer-id
15782           in: path
15783           description: Global customer id used across ECOMP to uniquely identify customer.
15784           required: true
15785           type: string
15786           example: __GLOBAL-CUSTOMER-ID__
15787         - name: service-type
15788           in: path
15789           description: Value defined by orchestration to identify this service across ECOMP.
15790           required: true
15791           type: string
15792           example: __SERVICE-TYPE__
15793         - name: service-instance-id
15794           in: path
15795           description: Uniquely identifies this instance of a service
15796           required: true
15797           type: string
15798           example: __SERVICE-INSTANCE-ID__
15799         - name: id
15800           in: path
15801           description: Allotted Resource id UUID assigned to this instance.
15802           required: true
15803           type: string
15804           example: __ID__
15805         - name: resource-version
15806           in: query
15807           description: resource-version for concurrency
15808           required: true
15809           type: string
15810   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources:
15811     get:
15812       tags:
15813         - Business
15814       summary: returns allotted-resources
15815       description: returns allotted-resources
15816       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResources
15817       produces:
15818         - application/json
15819         - application/xml
15820       responses:
15821         "200":
15822           description: successful operation
15823           schema:
15824               $ref: "#/getDefinitions/allotted-resources"
15825         "default":
15826           description: Response codes found in [response codes](https://wiki.onap.org/).
15827       parameters:
15828         - name: global-customer-id
15829           in: path
15830           description: Global customer id used across ECOMP to uniquely identify customer.
15831           required: true
15832           type: string
15833           example: __GLOBAL-CUSTOMER-ID__
15834         - name: service-type
15835           in: path
15836           description: Value defined by orchestration to identify this service across ECOMP.
15837           required: true
15838           type: string
15839           example: __SERVICE-TYPE__
15840         - name: service-instance-id
15841           in: path
15842           description: Uniquely identifies this instance of a service
15843           required: true
15844           type: string
15845           example: __SERVICE-INSTANCE-ID__
15846         - name: subscriber-name
15847           in: query
15848           description: Subscriber name, an alternate way to retrieve a customer.
15849           required: false
15850           type: string
15851         - name: subscriber-type
15852           in: query
15853           description: Subscriber type, a way to provide VID with only the INFRA customers.
15854           required: false
15855           type: string
15856         - name: service-instance-name
15857           in: query
15858           description: This field will store a name assigned to the service-instance.
15859           required: false
15860           type: string
15861         - name: persona-model-id
15862           in: query
15863           description: the ASDC model id for this resource or service model.
15864           required: false
15865           type: string
15866         - name: persona-model-version
15867           in: query
15868           description: the ASDC model version for this resource or service model.
15869           required: false
15870           type: string
15871         - name: widget-model-id
15872           in: query
15873           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
15874           required: false
15875           type: string
15876         - name: widget-model-version
15877           in: query
15878           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
15879           required: false
15880           type: string
15881         - name: service-instance-location-id
15882           in: query
15883           description: An identifier that customers assign to the location where this service is being used.
15884           required: false
15885           type: string
15886         - name: orchestration-status
15887           in: query
15888           description: Orchestration status of this service.
15889           required: false
15890           type: string
15891   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}:
15892     get:
15893       tags:
15894         - Business
15895       summary: returns service-instance
15896       description: returns service-instance
15897       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
15898       produces:
15899         - application/json
15900         - application/xml
15901       responses:
15902         "200":
15903           description: successful operation
15904           schema:
15905               $ref: "#/getDefinitions/service-instance"
15906         "default":
15907           description: Response codes found in [response codes](https://wiki.onap.org/).
15908       parameters:
15909         - name: global-customer-id
15910           in: path
15911           description: Global customer id used across ECOMP to uniquely identify customer.
15912           required: true
15913           type: string
15914           example: __GLOBAL-CUSTOMER-ID__
15915         - name: service-type
15916           in: path
15917           description: Value defined by orchestration to identify this service across ECOMP.
15918           required: true
15919           type: string
15920           example: __SERVICE-TYPE__
15921         - name: service-instance-id
15922           in: path
15923           description: Uniquely identifies this instance of a service
15924           required: true
15925           type: string
15926           example: __SERVICE-INSTANCE-ID__
15927         - name: subscriber-name
15928           in: query
15929           description: Subscriber name, an alternate way to retrieve a customer.
15930           required: false
15931           type: string
15932         - name: subscriber-type
15933           in: query
15934           description: Subscriber type, a way to provide VID with only the INFRA customers.
15935           required: false
15936           type: string
15937         - name: service-instance-name
15938           in: query
15939           description: This field will store a name assigned to the service-instance.
15940           required: false
15941           type: string
15942         - name: persona-model-id
15943           in: query
15944           description: the ASDC model id for this resource or service model.
15945           required: false
15946           type: string
15947         - name: persona-model-version
15948           in: query
15949           description: the ASDC model version for this resource or service model.
15950           required: false
15951           type: string
15952         - name: widget-model-id
15953           in: query
15954           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
15955           required: false
15956           type: string
15957         - name: widget-model-version
15958           in: query
15959           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
15960           required: false
15961           type: string
15962         - name: service-instance-location-id
15963           in: query
15964           description: An identifier that customers assign to the location where this service is being used.
15965           required: false
15966           type: string
15967         - name: orchestration-status
15968           in: query
15969           description: Orchestration status of this service.
15970           required: false
15971           type: string
15972     put:
15973       tags:
15974         - Business
15975       summary: create or update an existing service-instance
15976       description: |
15977         Create or update an existing service-instance.
15978         #
15979         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
15980       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
15981       consumes:
15982         - application/json
15983         - application/xml
15984       produces:
15985         - application/json
15986         - application/xml
15987       responses:
15988         "default":
15989           description: Response codes found in [response codes](https://wiki.onap.org/).
15990       parameters:
15991         - name: global-customer-id
15992           in: path
15993           description: Global customer id used across ECOMP to uniquely identify customer.
15994           required: true
15995           type: string
15996           example: __GLOBAL-CUSTOMER-ID__
15997         - name: service-type
15998           in: path
15999           description: Value defined by orchestration to identify this service across ECOMP.
16000           required: true
16001           type: string
16002           example: __SERVICE-TYPE__
16003         - name: service-instance-id
16004           in: path
16005           description: Uniquely identifies this instance of a service
16006           required: true
16007           type: string
16008           example: __SERVICE-INSTANCE-ID__
16009         - name: body
16010           in: body
16011           description: service-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
16012           required: true
16013           schema:
16014             $ref: "#/definitions/service-instance"
16015     patch:
16016       tags:
16017         - Business
16018       summary: update an existing service-instance
16019       description: |
16020         Update an existing service-instance
16021         #
16022         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16023         The PUT operation will entirely replace an existing object.
16024         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
16025         #
16026         Other differences between PUT and PATCH are:
16027         #
16028         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16029         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16030         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16031       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
16032       consumes:
16033         - application/json
16034         - application/xml
16035       produces:
16036         - application/json
16037         - application/xml
16038       responses:
16039         "default":
16040           description: Response codes found in [response codes](https://wiki.onap.org/).
16041       parameters:
16042         - name: global-customer-id
16043           in: path
16044           description: Global customer id used across ECOMP to uniquely identify customer.
16045           required: true
16046           type: string
16047           example: __GLOBAL-CUSTOMER-ID__
16048         - name: service-type
16049           in: path
16050           description: Value defined by orchestration to identify this service across ECOMP.
16051           required: true
16052           type: string
16053           example: __SERVICE-TYPE__
16054         - name: service-instance-id
16055           in: path
16056           description: Uniquely identifies this instance of a service
16057           required: true
16058           type: string
16059           example: __SERVICE-INSTANCE-ID__
16060         - name: body
16061           in: body
16062           description: service-instance object that needs to be created or updated.
16063           required: true
16064           schema:
16065             $ref: "#/patchDefinitions/service-instance"
16066     delete:
16067       tags:
16068         - Business
16069       summary: delete an existing service-instance
16070       description: delete an existing service-instance
16071       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
16072       consumes:
16073         - application/json
16074         - application/xml
16075       produces:
16076         - application/json
16077         - application/xml
16078       responses:
16079         "default":
16080           description: Response codes found in [response codes](https://wiki.onap.org/).
16081       parameters:
16082         - name: global-customer-id
16083           in: path
16084           description: Global customer id used across ECOMP to uniquely identify customer.
16085           required: true
16086           type: string
16087           example: __GLOBAL-CUSTOMER-ID__
16088         - name: service-type
16089           in: path
16090           description: Value defined by orchestration to identify this service across ECOMP.
16091           required: true
16092           type: string
16093           example: __SERVICE-TYPE__
16094         - name: service-instance-id
16095           in: path
16096           description: Uniquely identifies this instance of a service
16097           required: true
16098           type: string
16099           example: __SERVICE-INSTANCE-ID__
16100         - name: resource-version
16101           in: query
16102           description: resource-version for concurrency
16103           required: true
16104           type: string
16105   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances:
16106     get:
16107       tags:
16108         - Business
16109       summary: returns service-instances
16110       description: returns service-instances
16111       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstances
16112       produces:
16113         - application/json
16114         - application/xml
16115       responses:
16116         "200":
16117           description: successful operation
16118           schema:
16119               $ref: "#/getDefinitions/service-instances"
16120         "default":
16121           description: Response codes found in [response codes](https://wiki.onap.org/).
16122       parameters:
16123         - name: global-customer-id
16124           in: path
16125           description: Global customer id used across ECOMP to uniquely identify customer.
16126           required: true
16127           type: string
16128           example: __GLOBAL-CUSTOMER-ID__
16129         - name: service-type
16130           in: path
16131           description: Value defined by orchestration to identify this service across ECOMP.
16132           required: true
16133           type: string
16134           example: __SERVICE-TYPE__
16135         - name: subscriber-name
16136           in: query
16137           description: Subscriber name, an alternate way to retrieve a customer.
16138           required: false
16139           type: string
16140         - name: subscriber-type
16141           in: query
16142           description: Subscriber type, a way to provide VID with only the INFRA customers.
16143           required: false
16144           type: string
16145   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship:
16146     put:
16147       tags:
16148         - Business
16149       summary: see node definition for valid relationships
16150       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
16151       consumes:
16152         - application/json
16153         - application/xml
16154       produces:
16155         - application/json
16156         - application/xml
16157       responses:
16158         "default":
16159           description: Response codes found in [response codes](https://wiki.onap.org/).
16160       parameters:
16161         - name: global-customer-id
16162           in: path
16163           description: Global customer id used across ECOMP to uniquely identify customer.
16164           required: true
16165           type: string
16166           example: __GLOBAL-CUSTOMER-ID__
16167         - name: service-type
16168           in: path
16169           description: Value defined by orchestration to identify this service across ECOMP.
16170           required: true
16171           type: string
16172           example: __SERVICE-TYPE__
16173         - name: body
16174           in: body
16175           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
16176           required: true
16177           schema:
16178             $ref: "#/definitions/relationship"
16179     delete:
16180       tags:
16181         - Business
16182       summary: delete an existing relationship
16183       description: delete an existing relationship
16184       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
16185       consumes:
16186         - application/json
16187         - application/xml
16188       produces:
16189         - application/json
16190         - application/xml
16191       responses:
16192         "default":
16193           description: Response codes found in [response codes](https://wiki.onap.org/).
16194       parameters:
16195         - name: global-customer-id
16196           in: path
16197           description: Global customer id used across ECOMP to uniquely identify customer.
16198           required: true
16199           type: string
16200           example: __GLOBAL-CUSTOMER-ID__
16201         - name: service-type
16202           in: path
16203           description: Value defined by orchestration to identify this service across ECOMP.
16204           required: true
16205           type: string
16206           example: __SERVICE-TYPE__
16207   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}:
16208     get:
16209       tags:
16210         - Business
16211       summary: returns service-subscription
16212       description: returns service-subscription
16213       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
16214       produces:
16215         - application/json
16216         - application/xml
16217       responses:
16218         "200":
16219           description: successful operation
16220           schema:
16221               $ref: "#/getDefinitions/service-subscription"
16222         "default":
16223           description: Response codes found in [response codes](https://wiki.onap.org/).
16224       parameters:
16225         - name: global-customer-id
16226           in: path
16227           description: Global customer id used across ECOMP to uniquely identify customer.
16228           required: true
16229           type: string
16230           example: __GLOBAL-CUSTOMER-ID__
16231         - name: service-type
16232           in: path
16233           description: Value defined by orchestration to identify this service across ECOMP.
16234           required: true
16235           type: string
16236           example: __SERVICE-TYPE__
16237         - name: subscriber-name
16238           in: query
16239           description: Subscriber name, an alternate way to retrieve a customer.
16240           required: false
16241           type: string
16242         - name: subscriber-type
16243           in: query
16244           description: Subscriber type, a way to provide VID with only the INFRA customers.
16245           required: false
16246           type: string
16247     put:
16248       tags:
16249         - Business
16250       summary: create or update an existing service-subscription
16251       description: |
16252         Create or update an existing service-subscription.
16253         #
16254         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
16255       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
16256       consumes:
16257         - application/json
16258         - application/xml
16259       produces:
16260         - application/json
16261         - application/xml
16262       responses:
16263         "default":
16264           description: Response codes found in [response codes](https://wiki.onap.org/).
16265       parameters:
16266         - name: global-customer-id
16267           in: path
16268           description: Global customer id used across ECOMP to uniquely identify customer.
16269           required: true
16270           type: string
16271           example: __GLOBAL-CUSTOMER-ID__
16272         - name: service-type
16273           in: path
16274           description: Value defined by orchestration to identify this service across ECOMP.
16275           required: true
16276           type: string
16277           example: __SERVICE-TYPE__
16278         - name: body
16279           in: body
16280           description: service-subscription object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
16281           required: true
16282           schema:
16283             $ref: "#/definitions/service-subscription"
16284     patch:
16285       tags:
16286         - Business
16287       summary: update an existing service-subscription
16288       description: |
16289         Update an existing service-subscription
16290         #
16291         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16292         The PUT operation will entirely replace an existing object.
16293         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
16294         #
16295         Other differences between PUT and PATCH are:
16296         #
16297         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16298         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16299         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16300       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
16301       consumes:
16302         - application/json
16303         - application/xml
16304       produces:
16305         - application/json
16306         - application/xml
16307       responses:
16308         "default":
16309           description: Response codes found in [response codes](https://wiki.onap.org/).
16310       parameters:
16311         - name: global-customer-id
16312           in: path
16313           description: Global customer id used across ECOMP to uniquely identify customer.
16314           required: true
16315           type: string
16316           example: __GLOBAL-CUSTOMER-ID__
16317         - name: service-type
16318           in: path
16319           description: Value defined by orchestration to identify this service across ECOMP.
16320           required: true
16321           type: string
16322           example: __SERVICE-TYPE__
16323         - name: body
16324           in: body
16325           description: service-subscription object that needs to be created or updated.
16326           required: true
16327           schema:
16328             $ref: "#/patchDefinitions/service-subscription"
16329     delete:
16330       tags:
16331         - Business
16332       summary: delete an existing service-subscription
16333       description: delete an existing service-subscription
16334       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
16335       consumes:
16336         - application/json
16337         - application/xml
16338       produces:
16339         - application/json
16340         - application/xml
16341       responses:
16342         "default":
16343           description: Response codes found in [response codes](https://wiki.onap.org/).
16344       parameters:
16345         - name: global-customer-id
16346           in: path
16347           description: Global customer id used across ECOMP to uniquely identify customer.
16348           required: true
16349           type: string
16350           example: __GLOBAL-CUSTOMER-ID__
16351         - name: service-type
16352           in: path
16353           description: Value defined by orchestration to identify this service across ECOMP.
16354           required: true
16355           type: string
16356           example: __SERVICE-TYPE__
16357         - name: resource-version
16358           in: query
16359           description: resource-version for concurrency
16360           required: true
16361           type: string
16362   /business/customers/customer/{global-customer-id}/service-subscriptions:
16363     get:
16364       tags:
16365         - Business
16366       summary: returns service-subscriptions
16367       description: returns service-subscriptions
16368       operationId: getBusinessCustomersCustomerServiceSubscriptions
16369       produces:
16370         - application/json
16371         - application/xml
16372       responses:
16373         "200":
16374           description: successful operation
16375           schema:
16376               $ref: "#/getDefinitions/service-subscriptions"
16377         "default":
16378           description: Response codes found in [response codes](https://wiki.onap.org/).
16379       parameters:
16380         - name: global-customer-id
16381           in: path
16382           description: Global customer id used across ECOMP to uniquely identify customer.
16383           required: true
16384           type: string
16385           example: __GLOBAL-CUSTOMER-ID__
16386         - name: subscriber-name
16387           in: query
16388           description: Subscriber name, an alternate way to retrieve a customer.
16389           required: false
16390           type: string
16391         - name: subscriber-type
16392           in: query
16393           description: Subscriber type, a way to provide VID with only the INFRA customers.
16394           required: false
16395           type: string
16396   /business/customers/customer/{global-customer-id}/relationship-list/relationship:
16397     put:
16398       tags:
16399         - Business
16400       summary: see node definition for valid relationships
16401       operationId: createOrUpdateBusinessCustomersCustomerRelationshipListRelationship
16402       consumes:
16403         - application/json
16404         - application/xml
16405       produces:
16406         - application/json
16407         - application/xml
16408       responses:
16409         "default":
16410           description: Response codes found in [response codes](https://wiki.onap.org/).
16411       parameters:
16412         - name: global-customer-id
16413           in: path
16414           description: Global customer id used across ECOMP to uniquely identify customer.
16415           required: true
16416           type: string
16417           example: __GLOBAL-CUSTOMER-ID__
16418         - name: body
16419           in: body
16420           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomer.json)
16421           required: true
16422           schema:
16423             $ref: "#/definitions/relationship"
16424     delete:
16425       tags:
16426         - Business
16427       summary: delete an existing relationship
16428       description: delete an existing relationship
16429       operationId: deleteBusinessCustomersCustomerRelationshipListRelationship
16430       consumes:
16431         - application/json
16432         - application/xml
16433       produces:
16434         - application/json
16435         - application/xml
16436       responses:
16437         "default":
16438           description: Response codes found in [response codes](https://wiki.onap.org/).
16439       parameters:
16440         - name: global-customer-id
16441           in: path
16442           description: Global customer id used across ECOMP to uniquely identify customer.
16443           required: true
16444           type: string
16445           example: __GLOBAL-CUSTOMER-ID__
16446   /business/customers/customer/{global-customer-id}:
16447     get:
16448       tags:
16449         - Business
16450       summary: returns customer
16451       description: returns customer
16452       operationId: getBusinessCustomersCustomer
16453       produces:
16454         - application/json
16455         - application/xml
16456       responses:
16457         "200":
16458           description: successful operation
16459           schema:
16460               $ref: "#/getDefinitions/customer"
16461         "default":
16462           description: Response codes found in [response codes](https://wiki.onap.org/).
16463       parameters:
16464         - name: global-customer-id
16465           in: path
16466           description: Global customer id used across ECOMP to uniquely identify customer.
16467           required: true
16468           type: string
16469           example: __GLOBAL-CUSTOMER-ID__
16470         - name: subscriber-name
16471           in: query
16472           description: Subscriber name, an alternate way to retrieve a customer.
16473           required: false
16474           type: string
16475         - name: subscriber-type
16476           in: query
16477           description: Subscriber type, a way to provide VID with only the INFRA customers.
16478           required: false
16479           type: string
16480     put:
16481       tags:
16482         - Business
16483       summary: create or update an existing customer
16484       description: |
16485         Create or update an existing customer.
16486         #
16487         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
16488       operationId: createOrUpdateBusinessCustomersCustomer
16489       consumes:
16490         - application/json
16491         - application/xml
16492       produces:
16493         - application/json
16494         - application/xml
16495       responses:
16496         "default":
16497           description: Response codes found in [response codes](https://wiki.onap.org/).
16498       parameters:
16499         - name: global-customer-id
16500           in: path
16501           description: Global customer id used across ECOMP to uniquely identify customer.
16502           required: true
16503           type: string
16504           example: __GLOBAL-CUSTOMER-ID__
16505         - name: body
16506           in: body
16507           description: customer object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomer.json)
16508           required: true
16509           schema:
16510             $ref: "#/definitions/customer"
16511     patch:
16512       tags:
16513         - Business
16514       summary: update an existing customer
16515       description: |
16516         Update an existing customer
16517         #
16518         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16519         The PUT operation will entirely replace an existing object.
16520         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
16521         #
16522         Other differences between PUT and PATCH are:
16523         #
16524         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16525         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16526         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16527       operationId: UpdateBusinessCustomersCustomer
16528       consumes:
16529         - application/json
16530         - application/xml
16531       produces:
16532         - application/json
16533         - application/xml
16534       responses:
16535         "default":
16536           description: Response codes found in [response codes](https://wiki.onap.org/).
16537       parameters:
16538         - name: global-customer-id
16539           in: path
16540           description: Global customer id used across ECOMP to uniquely identify customer.
16541           required: true
16542           type: string
16543           example: __GLOBAL-CUSTOMER-ID__
16544         - name: body
16545           in: body
16546           description: customer object that needs to be created or updated.
16547           required: true
16548           schema:
16549             $ref: "#/patchDefinitions/customer"
16550     delete:
16551       tags:
16552         - Business
16553       summary: delete an existing customer
16554       description: delete an existing customer
16555       operationId: deleteBusinessCustomersCustomer
16556       consumes:
16557         - application/json
16558         - application/xml
16559       produces:
16560         - application/json
16561         - application/xml
16562       responses:
16563         "default":
16564           description: Response codes found in [response codes](https://wiki.onap.org/).
16565       parameters:
16566         - name: global-customer-id
16567           in: path
16568           description: Global customer id used across ECOMP to uniquely identify customer.
16569           required: true
16570           type: string
16571           example: __GLOBAL-CUSTOMER-ID__
16572         - name: resource-version
16573           in: query
16574           description: resource-version for concurrency
16575           required: true
16576           type: string
16577   /business/customers:
16578     get:
16579       tags:
16580         - Business
16581       summary: returns customers
16582       description: returns customers
16583       operationId: getBusinessCustomers
16584       produces:
16585         - application/json
16586         - application/xml
16587       responses:
16588         "200":
16589           description: successful operation
16590           schema:
16591               $ref: "#/getDefinitions/customers"
16592         "default":
16593           description: Response codes found in [response codes](https://wiki.onap.org/).
16594   /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship:
16595     put:
16596       tags:
16597         - ServiceDesignAndCreation
16598       summary: see node definition for valid relationships
16599       operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
16600       consumes:
16601         - application/json
16602         - application/xml
16603       produces:
16604         - application/json
16605         - application/xml
16606       responses:
16607         "default":
16608           description: Response codes found in [response codes](https://wiki.onap.org/).
16609       parameters:
16610         - name: vnf-image-uuid
16611           in: path
16612           description: Unique ID of this asset
16613           required: true
16614           type: string
16615           example: __VNF-IMAGE-UUID__
16616         - name: body
16617           in: body
16618           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationVnfImagesVnfImage.json)
16619           required: true
16620           schema:
16621             $ref: "#/definitions/relationship"
16622     delete:
16623       tags:
16624         - ServiceDesignAndCreation
16625       summary: delete an existing relationship
16626       description: delete an existing relationship
16627       operationId: deleteServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
16628       consumes:
16629         - application/json
16630         - application/xml
16631       produces:
16632         - application/json
16633         - application/xml
16634       responses:
16635         "default":
16636           description: Response codes found in [response codes](https://wiki.onap.org/).
16637       parameters:
16638         - name: vnf-image-uuid
16639           in: path
16640           description: Unique ID of this asset
16641           required: true
16642           type: string
16643           example: __VNF-IMAGE-UUID__
16644   /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}:
16645     get:
16646       tags:
16647         - ServiceDesignAndCreation
16648       summary: returns vnf-image
16649       description: returns vnf-image
16650       operationId: getServiceDesignAndCreationVnfImagesVnfImage
16651       produces:
16652         - application/json
16653         - application/xml
16654       responses:
16655         "200":
16656           description: successful operation
16657           schema:
16658               $ref: "#/getDefinitions/vnf-image"
16659         "default":
16660           description: Response codes found in [response codes](https://wiki.onap.org/).
16661       parameters:
16662         - name: vnf-image-uuid
16663           in: path
16664           description: Unique ID of this asset
16665           required: true
16666           type: string
16667           example: __VNF-IMAGE-UUID__
16668         - name: application
16669           in: query
16670           description: The application that the image instantiates.
16671           required: false
16672           type: string
16673         - name: application-vendor
16674           in: query
16675           description: The vendor of the application.
16676           required: false
16677           type: string
16678         - name: application-version
16679           in: query
16680           description: The version of the application.
16681           required: false
16682           type: string
16683     put:
16684       tags:
16685         - ServiceDesignAndCreation
16686       summary: create or update an existing vnf-image
16687       description: |
16688         Create or update an existing vnf-image.
16689         #
16690         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
16691       operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImage
16692       consumes:
16693         - application/json
16694         - application/xml
16695       produces:
16696         - application/json
16697         - application/xml
16698       responses:
16699         "default":
16700           description: Response codes found in [response codes](https://wiki.onap.org/).
16701       parameters:
16702         - name: vnf-image-uuid
16703           in: path
16704           description: Unique ID of this asset
16705           required: true
16706           type: string
16707           example: __VNF-IMAGE-UUID__
16708         - name: body
16709           in: body
16710           description: vnf-image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationVnfImagesVnfImage.json)
16711           required: true
16712           schema:
16713             $ref: "#/definitions/vnf-image"
16714     patch:
16715       tags:
16716         - ServiceDesignAndCreation
16717       summary: update an existing vnf-image
16718       description: |
16719         Update an existing vnf-image
16720         #
16721         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16722         The PUT operation will entirely replace an existing object.
16723         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
16724         #
16725         Other differences between PUT and PATCH are:
16726         #
16727         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16728         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16729         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16730       operationId: UpdateServiceDesignAndCreationVnfImagesVnfImage
16731       consumes:
16732         - application/json
16733         - application/xml
16734       produces:
16735         - application/json
16736         - application/xml
16737       responses:
16738         "default":
16739           description: Response codes found in [response codes](https://wiki.onap.org/).
16740       parameters:
16741         - name: vnf-image-uuid
16742           in: path
16743           description: Unique ID of this asset
16744           required: true
16745           type: string
16746           example: __VNF-IMAGE-UUID__
16747         - name: body
16748           in: body
16749           description: vnf-image object that needs to be created or updated.
16750           required: true
16751           schema:
16752             $ref: "#/patchDefinitions/vnf-image"
16753     delete:
16754       tags:
16755         - ServiceDesignAndCreation
16756       summary: delete an existing vnf-image
16757       description: delete an existing vnf-image
16758       operationId: deleteServiceDesignAndCreationVnfImagesVnfImage
16759       consumes:
16760         - application/json
16761         - application/xml
16762       produces:
16763         - application/json
16764         - application/xml
16765       responses:
16766         "default":
16767           description: Response codes found in [response codes](https://wiki.onap.org/).
16768       parameters:
16769         - name: vnf-image-uuid
16770           in: path
16771           description: Unique ID of this asset
16772           required: true
16773           type: string
16774           example: __VNF-IMAGE-UUID__
16775         - name: resource-version
16776           in: query
16777           description: resource-version for concurrency
16778           required: true
16779           type: string
16780   /service-design-and-creation/vnf-images:
16781     get:
16782       tags:
16783         - ServiceDesignAndCreation
16784       summary: returns vnf-images
16785       description: returns vnf-images
16786       operationId: getServiceDesignAndCreationVnfImages
16787       produces:
16788         - application/json
16789         - application/xml
16790       responses:
16791         "200":
16792           description: successful operation
16793           schema:
16794               $ref: "#/getDefinitions/vnf-images"
16795         "default":
16796           description: Response codes found in [response codes](https://wiki.onap.org/).
16797   /service-design-and-creation/services/service/{service-id}/relationship-list/relationship:
16798     put:
16799       tags:
16800         - ServiceDesignAndCreation
16801       summary: see node definition for valid relationships
16802       operationId: createOrUpdateServiceDesignAndCreationServicesServiceRelationshipListRelationship
16803       consumes:
16804         - application/json
16805         - application/xml
16806       produces:
16807         - application/json
16808         - application/xml
16809       responses:
16810         "default":
16811           description: Response codes found in [response codes](https://wiki.onap.org/).
16812       parameters:
16813         - name: service-id
16814           in: path
16815           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
16816           required: true
16817           type: string
16818           example: __SERVICE-ID__
16819         - name: body
16820           in: body
16821           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationServicesService.json)
16822           required: true
16823           schema:
16824             $ref: "#/definitions/relationship"
16825     delete:
16826       tags:
16827         - ServiceDesignAndCreation
16828       summary: delete an existing relationship
16829       description: delete an existing relationship
16830       operationId: deleteServiceDesignAndCreationServicesServiceRelationshipListRelationship
16831       consumes:
16832         - application/json
16833         - application/xml
16834       produces:
16835         - application/json
16836         - application/xml
16837       responses:
16838         "default":
16839           description: Response codes found in [response codes](https://wiki.onap.org/).
16840       parameters:
16841         - name: service-id
16842           in: path
16843           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
16844           required: true
16845           type: string
16846           example: __SERVICE-ID__
16847   /service-design-and-creation/services/service/{service-id}:
16848     get:
16849       tags:
16850         - ServiceDesignAndCreation
16851       summary: returns service
16852       description: returns service
16853       operationId: getServiceDesignAndCreationServicesService
16854       produces:
16855         - application/json
16856         - application/xml
16857       responses:
16858         "200":
16859           description: successful operation
16860           schema:
16861               $ref: "#/getDefinitions/service"
16862         "default":
16863           description: Response codes found in [response codes](https://wiki.onap.org/).
16864       parameters:
16865         - name: service-id
16866           in: path
16867           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
16868           required: true
16869           type: string
16870           example: __SERVICE-ID__
16871         - name: service-description
16872           in: query
16873           description: Description of the service
16874           required: false
16875           type: string
16876     put:
16877       tags:
16878         - ServiceDesignAndCreation
16879       summary: create or update an existing service
16880       description: |
16881         Create or update an existing service.
16882         #
16883         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
16884       operationId: createOrUpdateServiceDesignAndCreationServicesService
16885       consumes:
16886         - application/json
16887         - application/xml
16888       produces:
16889         - application/json
16890         - application/xml
16891       responses:
16892         "default":
16893           description: Response codes found in [response codes](https://wiki.onap.org/).
16894       parameters:
16895         - name: service-id
16896           in: path
16897           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
16898           required: true
16899           type: string
16900           example: __SERVICE-ID__
16901         - name: body
16902           in: body
16903           description: service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationServicesService.json)
16904           required: true
16905           schema:
16906             $ref: "#/definitions/service"
16907     patch:
16908       tags:
16909         - ServiceDesignAndCreation
16910       summary: update an existing service
16911       description: |
16912         Update an existing service
16913         #
16914         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16915         The PUT operation will entirely replace an existing object.
16916         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
16917         #
16918         Other differences between PUT and PATCH are:
16919         #
16920         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16921         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16922         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16923       operationId: UpdateServiceDesignAndCreationServicesService
16924       consumes:
16925         - application/json
16926         - application/xml
16927       produces:
16928         - application/json
16929         - application/xml
16930       responses:
16931         "default":
16932           description: Response codes found in [response codes](https://wiki.onap.org/).
16933       parameters:
16934         - name: service-id
16935           in: path
16936           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
16937           required: true
16938           type: string
16939           example: __SERVICE-ID__
16940         - name: body
16941           in: body
16942           description: service object that needs to be created or updated.
16943           required: true
16944           schema:
16945             $ref: "#/patchDefinitions/service"
16946     delete:
16947       tags:
16948         - ServiceDesignAndCreation
16949       summary: delete an existing service
16950       description: delete an existing service
16951       operationId: deleteServiceDesignAndCreationServicesService
16952       consumes:
16953         - application/json
16954         - application/xml
16955       produces:
16956         - application/json
16957         - application/xml
16958       responses:
16959         "default":
16960           description: Response codes found in [response codes](https://wiki.onap.org/).
16961       parameters:
16962         - name: service-id
16963           in: path
16964           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
16965           required: true
16966           type: string
16967           example: __SERVICE-ID__
16968         - name: resource-version
16969           in: query
16970           description: resource-version for concurrency
16971           required: true
16972           type: string
16973   /service-design-and-creation/services:
16974     get:
16975       tags:
16976         - ServiceDesignAndCreation
16977       summary: returns services
16978       description: returns services
16979       operationId: getServiceDesignAndCreationServices
16980       produces:
16981         - application/json
16982         - application/xml
16983       responses:
16984         "200":
16985           description: successful operation
16986           schema:
16987               $ref: "#/getDefinitions/services"
16988         "default":
16989           description: Response codes found in [response codes](https://wiki.onap.org/).
16990   /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship:
16991     put:
16992       tags:
16993         - ServiceDesignAndCreation
16994       summary: see node definition for valid relationships
16995       operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
16996       consumes:
16997         - application/json
16998         - application/xml
16999       produces:
17000         - application/json
17001         - application/xml
17002       responses:
17003         "default":
17004           description: Response codes found in [response codes](https://wiki.onap.org/).
17005       parameters:
17006         - name: service-type
17007           in: path
17008           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17009           required: true
17010           type: string
17011           example: __SERVICE-TYPE__
17012         - name: vnf-type
17013           in: path
17014           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
17015           required: true
17016           type: string
17017           example: __VNF-TYPE__
17018         - name: body
17019           in: body
17020           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
17021           required: true
17022           schema:
17023             $ref: "#/definitions/relationship"
17024     delete:
17025       tags:
17026         - ServiceDesignAndCreation
17027       summary: delete an existing relationship
17028       description: delete an existing relationship
17029       operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
17030       consumes:
17031         - application/json
17032         - application/xml
17033       produces:
17034         - application/json
17035         - application/xml
17036       responses:
17037         "default":
17038           description: Response codes found in [response codes](https://wiki.onap.org/).
17039       parameters:
17040         - name: service-type
17041           in: path
17042           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17043           required: true
17044           type: string
17045           example: __SERVICE-TYPE__
17046         - name: vnf-type
17047           in: path
17048           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
17049           required: true
17050           type: string
17051           example: __VNF-TYPE__
17052   /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}:
17053     get:
17054       tags:
17055         - ServiceDesignAndCreation
17056       summary: returns service-capability
17057       description: returns service-capability
17058       operationId: getServiceDesignAndCreationServiceCapabilitiesServiceCapability
17059       produces:
17060         - application/json
17061         - application/xml
17062       responses:
17063         "200":
17064           description: successful operation
17065           schema:
17066               $ref: "#/getDefinitions/service-capability"
17067         "default":
17068           description: Response codes found in [response codes](https://wiki.onap.org/).
17069       parameters:
17070         - name: service-type
17071           in: path
17072           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17073           required: true
17074           type: string
17075           example: __SERVICE-TYPE__
17076         - name: vnf-type
17077           in: path
17078           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
17079           required: true
17080           type: string
17081           example: __VNF-TYPE__
17082     put:
17083       tags:
17084         - ServiceDesignAndCreation
17085       summary: create or update an existing service-capability
17086       description: |
17087         Create or update an existing service-capability.
17088         #
17089         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
17090       operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
17091       consumes:
17092         - application/json
17093         - application/xml
17094       produces:
17095         - application/json
17096         - application/xml
17097       responses:
17098         "default":
17099           description: Response codes found in [response codes](https://wiki.onap.org/).
17100       parameters:
17101         - name: service-type
17102           in: path
17103           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17104           required: true
17105           type: string
17106           example: __SERVICE-TYPE__
17107         - name: vnf-type
17108           in: path
17109           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
17110           required: true
17111           type: string
17112           example: __VNF-TYPE__
17113         - name: body
17114           in: body
17115           description: service-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
17116           required: true
17117           schema:
17118             $ref: "#/definitions/service-capability"
17119     patch:
17120       tags:
17121         - ServiceDesignAndCreation
17122       summary: update an existing service-capability
17123       description: |
17124         Update an existing service-capability
17125         #
17126         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17127         The PUT operation will entirely replace an existing object.
17128         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
17129         #
17130         Other differences between PUT and PATCH are:
17131         #
17132         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17133         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17134         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17135       operationId: UpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
17136       consumes:
17137         - application/json
17138         - application/xml
17139       produces:
17140         - application/json
17141         - application/xml
17142       responses:
17143         "default":
17144           description: Response codes found in [response codes](https://wiki.onap.org/).
17145       parameters:
17146         - name: service-type
17147           in: path
17148           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17149           required: true
17150           type: string
17151           example: __SERVICE-TYPE__
17152         - name: vnf-type
17153           in: path
17154           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
17155           required: true
17156           type: string
17157           example: __VNF-TYPE__
17158         - name: body
17159           in: body
17160           description: service-capability object that needs to be created or updated.
17161           required: true
17162           schema:
17163             $ref: "#/patchDefinitions/service-capability"
17164     delete:
17165       tags:
17166         - ServiceDesignAndCreation
17167       summary: delete an existing service-capability
17168       description: delete an existing service-capability
17169       operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapability
17170       consumes:
17171         - application/json
17172         - application/xml
17173       produces:
17174         - application/json
17175         - application/xml
17176       responses:
17177         "default":
17178           description: Response codes found in [response codes](https://wiki.onap.org/).
17179       parameters:
17180         - name: service-type
17181           in: path
17182           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17183           required: true
17184           type: string
17185           example: __SERVICE-TYPE__
17186         - name: vnf-type
17187           in: path
17188           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
17189           required: true
17190           type: string
17191           example: __VNF-TYPE__
17192         - name: resource-version
17193           in: query
17194           description: resource-version for concurrency
17195           required: true
17196           type: string
17197   /service-design-and-creation/service-capabilities:
17198     get:
17199       tags:
17200         - ServiceDesignAndCreation
17201       summary: returns service-capabilities
17202       description: returns service-capabilities
17203       operationId: getServiceDesignAndCreationServiceCapabilities
17204       produces:
17205         - application/json
17206         - application/xml
17207       responses:
17208         "200":
17209           description: successful operation
17210           schema:
17211               $ref: "#/getDefinitions/service-capabilities"
17212         "default":
17213           description: Response codes found in [response codes](https://wiki.onap.org/).
17214   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}/relationship-list/relationship:
17215     put:
17216       tags:
17217         - ServiceDesignAndCreation
17218       summary: see node definition for valid relationships
17219       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
17220       consumes:
17221         - application/json
17222         - application/xml
17223       produces:
17224         - application/json
17225         - application/xml
17226       responses:
17227         "default":
17228           description: Response codes found in [response codes](https://wiki.onap.org/).
17229       parameters:
17230         - name: model-invariant-id
17231           in: path
17232           description: Unique identifier corresponding to the main definition of a model in ASDC
17233           required: true
17234           type: string
17235           example: __MODEL-INVARIANT-ID__
17236         - name: model-version-id
17237           in: path
17238           description: Unique identifier corresponding to one version of a model in ASDC
17239           required: true
17240           type: string
17241           example: __MODEL-VERSION-ID__
17242         - name: model-element-uuid
17243           in: path
17244           required: true
17245           type: string
17246           example: __MODEL-ELEMENT-UUID__
17247         - name: model-constraint-uuid
17248           in: path
17249           required: true
17250           type: string
17251           example: __MODEL-CONSTRAINT-UUID__
17252         - name: constrained-element-set-uuid
17253           in: path
17254           required: true
17255           type: string
17256           example: __CONSTRAINED-ELEMENT-SET-UUID__
17257         - name: element-choice-set-uuid
17258           in: path
17259           required: true
17260           type: string
17261           example: __ELEMENT-CHOICE-SET-UUID__
17262         - name: body
17263           in: body
17264           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
17265           required: true
17266           schema:
17267             $ref: "#/definitions/relationship"
17268     delete:
17269       tags:
17270         - ServiceDesignAndCreation
17271       summary: delete an existing relationship
17272       description: delete an existing relationship
17273       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
17274       consumes:
17275         - application/json
17276         - application/xml
17277       produces:
17278         - application/json
17279         - application/xml
17280       responses:
17281         "default":
17282           description: Response codes found in [response codes](https://wiki.onap.org/).
17283       parameters:
17284         - name: model-invariant-id
17285           in: path
17286           description: Unique identifier corresponding to the main definition of a model in ASDC
17287           required: true
17288           type: string
17289           example: __MODEL-INVARIANT-ID__
17290         - name: model-version-id
17291           in: path
17292           description: Unique identifier corresponding to one version of a model in ASDC
17293           required: true
17294           type: string
17295           example: __MODEL-VERSION-ID__
17296         - name: model-element-uuid
17297           in: path
17298           required: true
17299           type: string
17300           example: __MODEL-ELEMENT-UUID__
17301         - name: model-constraint-uuid
17302           in: path
17303           required: true
17304           type: string
17305           example: __MODEL-CONSTRAINT-UUID__
17306         - name: constrained-element-set-uuid
17307           in: path
17308           required: true
17309           type: string
17310           example: __CONSTRAINED-ELEMENT-SET-UUID__
17311         - name: element-choice-set-uuid
17312           in: path
17313           required: true
17314           type: string
17315           example: __ELEMENT-CHOICE-SET-UUID__
17316   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}:
17317     get:
17318       tags:
17319         - ServiceDesignAndCreation
17320       summary: returns element-choice-set
17321       description: returns element-choice-set
17322       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
17323       produces:
17324         - application/json
17325         - application/xml
17326       responses:
17327         "200":
17328           description: successful operation
17329           schema:
17330               $ref: "#/getDefinitions/element-choice-set"
17331         "default":
17332           description: Response codes found in [response codes](https://wiki.onap.org/).
17333       parameters:
17334         - name: model-invariant-id
17335           in: path
17336           description: Unique identifier corresponding to the main definition of a model in ASDC
17337           required: true
17338           type: string
17339           example: __MODEL-INVARIANT-ID__
17340         - name: model-version-id
17341           in: path
17342           description: Unique identifier corresponding to one version of a model in ASDC
17343           required: true
17344           type: string
17345           example: __MODEL-VERSION-ID__
17346         - name: model-element-uuid
17347           in: path
17348           required: true
17349           type: string
17350           example: __MODEL-ELEMENT-UUID__
17351         - name: model-constraint-uuid
17352           in: path
17353           required: true
17354           type: string
17355           example: __MODEL-CONSTRAINT-UUID__
17356         - name: constrained-element-set-uuid
17357           in: path
17358           required: true
17359           type: string
17360           example: __CONSTRAINED-ELEMENT-SET-UUID__
17361         - name: element-choice-set-uuid
17362           in: path
17363           required: true
17364           type: string
17365           example: __ELEMENT-CHOICE-SET-UUID__
17366         - name: model-type
17367           in: query
17368           description: Type of the model, e.g., service, resource, widget, etc.
17369           required: false
17370           type: string
17371         - name: model-name
17372           in: query
17373           description: Name of the model, which can change from version to version.
17374           required: false
17375           type: string
17376         - name: model-version
17377           in: query
17378           description: Version
17379           required: false
17380           type: string
17381     put:
17382       tags:
17383         - ServiceDesignAndCreation
17384       summary: create or update an existing element-choice-set
17385       description: |
17386         Create or update an existing element-choice-set.
17387         #
17388         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
17389       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
17390       consumes:
17391         - application/json
17392         - application/xml
17393       produces:
17394         - application/json
17395         - application/xml
17396       responses:
17397         "default":
17398           description: Response codes found in [response codes](https://wiki.onap.org/).
17399       parameters:
17400         - name: model-invariant-id
17401           in: path
17402           description: Unique identifier corresponding to the main definition of a model in ASDC
17403           required: true
17404           type: string
17405           example: __MODEL-INVARIANT-ID__
17406         - name: model-version-id
17407           in: path
17408           description: Unique identifier corresponding to one version of a model in ASDC
17409           required: true
17410           type: string
17411           example: __MODEL-VERSION-ID__
17412         - name: model-element-uuid
17413           in: path
17414           required: true
17415           type: string
17416           example: __MODEL-ELEMENT-UUID__
17417         - name: model-constraint-uuid
17418           in: path
17419           required: true
17420           type: string
17421           example: __MODEL-CONSTRAINT-UUID__
17422         - name: constrained-element-set-uuid
17423           in: path
17424           required: true
17425           type: string
17426           example: __CONSTRAINED-ELEMENT-SET-UUID__
17427         - name: element-choice-set-uuid
17428           in: path
17429           required: true
17430           type: string
17431           example: __ELEMENT-CHOICE-SET-UUID__
17432         - name: body
17433           in: body
17434           description: element-choice-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
17435           required: true
17436           schema:
17437             $ref: "#/definitions/element-choice-set"
17438     patch:
17439       tags:
17440         - ServiceDesignAndCreation
17441       summary: update an existing element-choice-set
17442       description: |
17443         Update an existing element-choice-set
17444         #
17445         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17446         The PUT operation will entirely replace an existing object.
17447         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
17448         #
17449         Other differences between PUT and PATCH are:
17450         #
17451         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17452         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17453         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17454       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
17455       consumes:
17456         - application/json
17457         - application/xml
17458       produces:
17459         - application/json
17460         - application/xml
17461       responses:
17462         "default":
17463           description: Response codes found in [response codes](https://wiki.onap.org/).
17464       parameters:
17465         - name: model-invariant-id
17466           in: path
17467           description: Unique identifier corresponding to the main definition of a model in ASDC
17468           required: true
17469           type: string
17470           example: __MODEL-INVARIANT-ID__
17471         - name: model-version-id
17472           in: path
17473           description: Unique identifier corresponding to one version of a model in ASDC
17474           required: true
17475           type: string
17476           example: __MODEL-VERSION-ID__
17477         - name: model-element-uuid
17478           in: path
17479           required: true
17480           type: string
17481           example: __MODEL-ELEMENT-UUID__
17482         - name: model-constraint-uuid
17483           in: path
17484           required: true
17485           type: string
17486           example: __MODEL-CONSTRAINT-UUID__
17487         - name: constrained-element-set-uuid
17488           in: path
17489           required: true
17490           type: string
17491           example: __CONSTRAINED-ELEMENT-SET-UUID__
17492         - name: element-choice-set-uuid
17493           in: path
17494           required: true
17495           type: string
17496           example: __ELEMENT-CHOICE-SET-UUID__
17497         - name: body
17498           in: body
17499           description: element-choice-set object that needs to be created or updated.
17500           required: true
17501           schema:
17502             $ref: "#/patchDefinitions/element-choice-set"
17503     delete:
17504       tags:
17505         - ServiceDesignAndCreation
17506       summary: delete an existing element-choice-set
17507       description: delete an existing element-choice-set
17508       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
17509       consumes:
17510         - application/json
17511         - application/xml
17512       produces:
17513         - application/json
17514         - application/xml
17515       responses:
17516         "default":
17517           description: Response codes found in [response codes](https://wiki.onap.org/).
17518       parameters:
17519         - name: model-invariant-id
17520           in: path
17521           description: Unique identifier corresponding to the main definition of a model in ASDC
17522           required: true
17523           type: string
17524           example: __MODEL-INVARIANT-ID__
17525         - name: model-version-id
17526           in: path
17527           description: Unique identifier corresponding to one version of a model in ASDC
17528           required: true
17529           type: string
17530           example: __MODEL-VERSION-ID__
17531         - name: model-element-uuid
17532           in: path
17533           required: true
17534           type: string
17535           example: __MODEL-ELEMENT-UUID__
17536         - name: model-constraint-uuid
17537           in: path
17538           required: true
17539           type: string
17540           example: __MODEL-CONSTRAINT-UUID__
17541         - name: constrained-element-set-uuid
17542           in: path
17543           required: true
17544           type: string
17545           example: __CONSTRAINED-ELEMENT-SET-UUID__
17546         - name: element-choice-set-uuid
17547           in: path
17548           required: true
17549           type: string
17550           example: __ELEMENT-CHOICE-SET-UUID__
17551         - name: resource-version
17552           in: query
17553           description: resource-version for concurrency
17554           required: true
17555           type: string
17556   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets:
17557     get:
17558       tags:
17559         - ServiceDesignAndCreation
17560       summary: returns element-choice-sets
17561       description: returns element-choice-sets
17562       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSets
17563       produces:
17564         - application/json
17565         - application/xml
17566       responses:
17567         "200":
17568           description: successful operation
17569           schema:
17570               $ref: "#/getDefinitions/element-choice-sets"
17571         "default":
17572           description: Response codes found in [response codes](https://wiki.onap.org/).
17573       parameters:
17574         - name: model-invariant-id
17575           in: path
17576           description: Unique identifier corresponding to the main definition of a model in ASDC
17577           required: true
17578           type: string
17579           example: __MODEL-INVARIANT-ID__
17580         - name: model-version-id
17581           in: path
17582           description: Unique identifier corresponding to one version of a model in ASDC
17583           required: true
17584           type: string
17585           example: __MODEL-VERSION-ID__
17586         - name: model-element-uuid
17587           in: path
17588           required: true
17589           type: string
17590           example: __MODEL-ELEMENT-UUID__
17591         - name: model-constraint-uuid
17592           in: path
17593           required: true
17594           type: string
17595           example: __MODEL-CONSTRAINT-UUID__
17596         - name: constrained-element-set-uuid
17597           in: path
17598           required: true
17599           type: string
17600           example: __CONSTRAINED-ELEMENT-SET-UUID__
17601         - name: model-type
17602           in: query
17603           description: Type of the model, e.g., service, resource, widget, etc.
17604           required: false
17605           type: string
17606         - name: model-name
17607           in: query
17608           description: Name of the model, which can change from version to version.
17609           required: false
17610           type: string
17611         - name: model-version
17612           in: query
17613           description: Version
17614           required: false
17615           type: string
17616   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/relationship-list/relationship:
17617     put:
17618       tags:
17619         - ServiceDesignAndCreation
17620       summary: see node definition for valid relationships
17621       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
17622       consumes:
17623         - application/json
17624         - application/xml
17625       produces:
17626         - application/json
17627         - application/xml
17628       responses:
17629         "default":
17630           description: Response codes found in [response codes](https://wiki.onap.org/).
17631       parameters:
17632         - name: model-invariant-id
17633           in: path
17634           description: Unique identifier corresponding to the main definition of a model in ASDC
17635           required: true
17636           type: string
17637           example: __MODEL-INVARIANT-ID__
17638         - name: model-version-id
17639           in: path
17640           description: Unique identifier corresponding to one version of a model in ASDC
17641           required: true
17642           type: string
17643           example: __MODEL-VERSION-ID__
17644         - name: model-element-uuid
17645           in: path
17646           required: true
17647           type: string
17648           example: __MODEL-ELEMENT-UUID__
17649         - name: model-constraint-uuid
17650           in: path
17651           required: true
17652           type: string
17653           example: __MODEL-CONSTRAINT-UUID__
17654         - name: constrained-element-set-uuid
17655           in: path
17656           required: true
17657           type: string
17658           example: __CONSTRAINED-ELEMENT-SET-UUID__
17659         - name: body
17660           in: body
17661           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
17662           required: true
17663           schema:
17664             $ref: "#/definitions/relationship"
17665     delete:
17666       tags:
17667         - ServiceDesignAndCreation
17668       summary: delete an existing relationship
17669       description: delete an existing relationship
17670       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
17671       consumes:
17672         - application/json
17673         - application/xml
17674       produces:
17675         - application/json
17676         - application/xml
17677       responses:
17678         "default":
17679           description: Response codes found in [response codes](https://wiki.onap.org/).
17680       parameters:
17681         - name: model-invariant-id
17682           in: path
17683           description: Unique identifier corresponding to the main definition of a model in ASDC
17684           required: true
17685           type: string
17686           example: __MODEL-INVARIANT-ID__
17687         - name: model-version-id
17688           in: path
17689           description: Unique identifier corresponding to one version of a model in ASDC
17690           required: true
17691           type: string
17692           example: __MODEL-VERSION-ID__
17693         - name: model-element-uuid
17694           in: path
17695           required: true
17696           type: string
17697           example: __MODEL-ELEMENT-UUID__
17698         - name: model-constraint-uuid
17699           in: path
17700           required: true
17701           type: string
17702           example: __MODEL-CONSTRAINT-UUID__
17703         - name: constrained-element-set-uuid
17704           in: path
17705           required: true
17706           type: string
17707           example: __CONSTRAINED-ELEMENT-SET-UUID__
17708   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}:
17709     get:
17710       tags:
17711         - ServiceDesignAndCreation
17712       summary: returns constrained-element-set
17713       description: returns constrained-element-set
17714       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
17715       produces:
17716         - application/json
17717         - application/xml
17718       responses:
17719         "200":
17720           description: successful operation
17721           schema:
17722               $ref: "#/getDefinitions/constrained-element-set"
17723         "default":
17724           description: Response codes found in [response codes](https://wiki.onap.org/).
17725       parameters:
17726         - name: model-invariant-id
17727           in: path
17728           description: Unique identifier corresponding to the main definition of a model in ASDC
17729           required: true
17730           type: string
17731           example: __MODEL-INVARIANT-ID__
17732         - name: model-version-id
17733           in: path
17734           description: Unique identifier corresponding to one version of a model in ASDC
17735           required: true
17736           type: string
17737           example: __MODEL-VERSION-ID__
17738         - name: model-element-uuid
17739           in: path
17740           required: true
17741           type: string
17742           example: __MODEL-ELEMENT-UUID__
17743         - name: model-constraint-uuid
17744           in: path
17745           required: true
17746           type: string
17747           example: __MODEL-CONSTRAINT-UUID__
17748         - name: constrained-element-set-uuid
17749           in: path
17750           required: true
17751           type: string
17752           example: __CONSTRAINED-ELEMENT-SET-UUID__
17753         - name: model-type
17754           in: query
17755           description: Type of the model, e.g., service, resource, widget, etc.
17756           required: false
17757           type: string
17758         - name: model-name
17759           in: query
17760           description: Name of the model, which can change from version to version.
17761           required: false
17762           type: string
17763         - name: model-version
17764           in: query
17765           description: Version
17766           required: false
17767           type: string
17768     put:
17769       tags:
17770         - ServiceDesignAndCreation
17771       summary: create or update an existing constrained-element-set
17772       description: |
17773         Create or update an existing constrained-element-set.
17774         #
17775         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
17776       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
17777       consumes:
17778         - application/json
17779         - application/xml
17780       produces:
17781         - application/json
17782         - application/xml
17783       responses:
17784         "default":
17785           description: Response codes found in [response codes](https://wiki.onap.org/).
17786       parameters:
17787         - name: model-invariant-id
17788           in: path
17789           description: Unique identifier corresponding to the main definition of a model in ASDC
17790           required: true
17791           type: string
17792           example: __MODEL-INVARIANT-ID__
17793         - name: model-version-id
17794           in: path
17795           description: Unique identifier corresponding to one version of a model in ASDC
17796           required: true
17797           type: string
17798           example: __MODEL-VERSION-ID__
17799         - name: model-element-uuid
17800           in: path
17801           required: true
17802           type: string
17803           example: __MODEL-ELEMENT-UUID__
17804         - name: model-constraint-uuid
17805           in: path
17806           required: true
17807           type: string
17808           example: __MODEL-CONSTRAINT-UUID__
17809         - name: constrained-element-set-uuid
17810           in: path
17811           required: true
17812           type: string
17813           example: __CONSTRAINED-ELEMENT-SET-UUID__
17814         - name: body
17815           in: body
17816           description: constrained-element-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
17817           required: true
17818           schema:
17819             $ref: "#/definitions/constrained-element-set"
17820     patch:
17821       tags:
17822         - ServiceDesignAndCreation
17823       summary: update an existing constrained-element-set
17824       description: |
17825         Update an existing constrained-element-set
17826         #
17827         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17828         The PUT operation will entirely replace an existing object.
17829         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
17830         #
17831         Other differences between PUT and PATCH are:
17832         #
17833         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17834         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17835         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17836       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
17837       consumes:
17838         - application/json
17839         - application/xml
17840       produces:
17841         - application/json
17842         - application/xml
17843       responses:
17844         "default":
17845           description: Response codes found in [response codes](https://wiki.onap.org/).
17846       parameters:
17847         - name: model-invariant-id
17848           in: path
17849           description: Unique identifier corresponding to the main definition of a model in ASDC
17850           required: true
17851           type: string
17852           example: __MODEL-INVARIANT-ID__
17853         - name: model-version-id
17854           in: path
17855           description: Unique identifier corresponding to one version of a model in ASDC
17856           required: true
17857           type: string
17858           example: __MODEL-VERSION-ID__
17859         - name: model-element-uuid
17860           in: path
17861           required: true
17862           type: string
17863           example: __MODEL-ELEMENT-UUID__
17864         - name: model-constraint-uuid
17865           in: path
17866           required: true
17867           type: string
17868           example: __MODEL-CONSTRAINT-UUID__
17869         - name: constrained-element-set-uuid
17870           in: path
17871           required: true
17872           type: string
17873           example: __CONSTRAINED-ELEMENT-SET-UUID__
17874         - name: body
17875           in: body
17876           description: constrained-element-set object that needs to be created or updated.
17877           required: true
17878           schema:
17879             $ref: "#/patchDefinitions/constrained-element-set"
17880     delete:
17881       tags:
17882         - ServiceDesignAndCreation
17883       summary: delete an existing constrained-element-set
17884       description: delete an existing constrained-element-set
17885       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
17886       consumes:
17887         - application/json
17888         - application/xml
17889       produces:
17890         - application/json
17891         - application/xml
17892       responses:
17893         "default":
17894           description: Response codes found in [response codes](https://wiki.onap.org/).
17895       parameters:
17896         - name: model-invariant-id
17897           in: path
17898           description: Unique identifier corresponding to the main definition of a model in ASDC
17899           required: true
17900           type: string
17901           example: __MODEL-INVARIANT-ID__
17902         - name: model-version-id
17903           in: path
17904           description: Unique identifier corresponding to one version of a model in ASDC
17905           required: true
17906           type: string
17907           example: __MODEL-VERSION-ID__
17908         - name: model-element-uuid
17909           in: path
17910           required: true
17911           type: string
17912           example: __MODEL-ELEMENT-UUID__
17913         - name: model-constraint-uuid
17914           in: path
17915           required: true
17916           type: string
17917           example: __MODEL-CONSTRAINT-UUID__
17918         - name: constrained-element-set-uuid
17919           in: path
17920           required: true
17921           type: string
17922           example: __CONSTRAINED-ELEMENT-SET-UUID__
17923         - name: resource-version
17924           in: query
17925           description: resource-version for concurrency
17926           required: true
17927           type: string
17928   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets:
17929     get:
17930       tags:
17931         - ServiceDesignAndCreation
17932       summary: returns constrained-element-sets
17933       description: returns constrained-element-sets
17934       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSets
17935       produces:
17936         - application/json
17937         - application/xml
17938       responses:
17939         "200":
17940           description: successful operation
17941           schema:
17942               $ref: "#/getDefinitions/constrained-element-sets"
17943         "default":
17944           description: Response codes found in [response codes](https://wiki.onap.org/).
17945       parameters:
17946         - name: model-invariant-id
17947           in: path
17948           description: Unique identifier corresponding to the main definition of a model in ASDC
17949           required: true
17950           type: string
17951           example: __MODEL-INVARIANT-ID__
17952         - name: model-version-id
17953           in: path
17954           description: Unique identifier corresponding to one version of a model in ASDC
17955           required: true
17956           type: string
17957           example: __MODEL-VERSION-ID__
17958         - name: model-element-uuid
17959           in: path
17960           required: true
17961           type: string
17962           example: __MODEL-ELEMENT-UUID__
17963         - name: model-constraint-uuid
17964           in: path
17965           required: true
17966           type: string
17967           example: __MODEL-CONSTRAINT-UUID__
17968         - name: model-type
17969           in: query
17970           description: Type of the model, e.g., service, resource, widget, etc.
17971           required: false
17972           type: string
17973         - name: model-name
17974           in: query
17975           description: Name of the model, which can change from version to version.
17976           required: false
17977           type: string
17978         - name: model-version
17979           in: query
17980           description: Version
17981           required: false
17982           type: string
17983   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}:
17984     get:
17985       tags:
17986         - ServiceDesignAndCreation
17987       summary: returns model-constraint
17988       description: returns model-constraint
17989       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
17990       produces:
17991         - application/json
17992         - application/xml
17993       responses:
17994         "200":
17995           description: successful operation
17996           schema:
17997               $ref: "#/getDefinitions/model-constraint"
17998         "default":
17999           description: Response codes found in [response codes](https://wiki.onap.org/).
18000       parameters:
18001         - name: model-invariant-id
18002           in: path
18003           description: Unique identifier corresponding to the main definition of a model in ASDC
18004           required: true
18005           type: string
18006           example: __MODEL-INVARIANT-ID__
18007         - name: model-version-id
18008           in: path
18009           description: Unique identifier corresponding to one version of a model in ASDC
18010           required: true
18011           type: string
18012           example: __MODEL-VERSION-ID__
18013         - name: model-element-uuid
18014           in: path
18015           required: true
18016           type: string
18017           example: __MODEL-ELEMENT-UUID__
18018         - name: model-constraint-uuid
18019           in: path
18020           required: true
18021           type: string
18022           example: __MODEL-CONSTRAINT-UUID__
18023         - name: model-type
18024           in: query
18025           description: Type of the model, e.g., service, resource, widget, etc.
18026           required: false
18027           type: string
18028         - name: model-name
18029           in: query
18030           description: Name of the model, which can change from version to version.
18031           required: false
18032           type: string
18033         - name: model-version
18034           in: query
18035           description: Version
18036           required: false
18037           type: string
18038     put:
18039       tags:
18040         - ServiceDesignAndCreation
18041       summary: create or update an existing model-constraint
18042       description: |
18043         Create or update an existing model-constraint.
18044         #
18045         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
18046       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
18047       consumes:
18048         - application/json
18049         - application/xml
18050       produces:
18051         - application/json
18052         - application/xml
18053       responses:
18054         "default":
18055           description: Response codes found in [response codes](https://wiki.onap.org/).
18056       parameters:
18057         - name: model-invariant-id
18058           in: path
18059           description: Unique identifier corresponding to the main definition of a model in ASDC
18060           required: true
18061           type: string
18062           example: __MODEL-INVARIANT-ID__
18063         - name: model-version-id
18064           in: path
18065           description: Unique identifier corresponding to one version of a model in ASDC
18066           required: true
18067           type: string
18068           example: __MODEL-VERSION-ID__
18069         - name: model-element-uuid
18070           in: path
18071           required: true
18072           type: string
18073           example: __MODEL-ELEMENT-UUID__
18074         - name: model-constraint-uuid
18075           in: path
18076           required: true
18077           type: string
18078           example: __MODEL-CONSTRAINT-UUID__
18079         - name: body
18080           in: body
18081           description: model-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint.json)
18082           required: true
18083           schema:
18084             $ref: "#/definitions/model-constraint"
18085     patch:
18086       tags:
18087         - ServiceDesignAndCreation
18088       summary: update an existing model-constraint
18089       description: |
18090         Update an existing model-constraint
18091         #
18092         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18093         The PUT operation will entirely replace an existing object.
18094         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
18095         #
18096         Other differences between PUT and PATCH are:
18097         #
18098         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18099         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18100         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18101       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
18102       consumes:
18103         - application/json
18104         - application/xml
18105       produces:
18106         - application/json
18107         - application/xml
18108       responses:
18109         "default":
18110           description: Response codes found in [response codes](https://wiki.onap.org/).
18111       parameters:
18112         - name: model-invariant-id
18113           in: path
18114           description: Unique identifier corresponding to the main definition of a model in ASDC
18115           required: true
18116           type: string
18117           example: __MODEL-INVARIANT-ID__
18118         - name: model-version-id
18119           in: path
18120           description: Unique identifier corresponding to one version of a model in ASDC
18121           required: true
18122           type: string
18123           example: __MODEL-VERSION-ID__
18124         - name: model-element-uuid
18125           in: path
18126           required: true
18127           type: string
18128           example: __MODEL-ELEMENT-UUID__
18129         - name: model-constraint-uuid
18130           in: path
18131           required: true
18132           type: string
18133           example: __MODEL-CONSTRAINT-UUID__
18134         - name: body
18135           in: body
18136           description: model-constraint object that needs to be created or updated.
18137           required: true
18138           schema:
18139             $ref: "#/patchDefinitions/model-constraint"
18140     delete:
18141       tags:
18142         - ServiceDesignAndCreation
18143       summary: delete an existing model-constraint
18144       description: delete an existing model-constraint
18145       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
18146       consumes:
18147         - application/json
18148         - application/xml
18149       produces:
18150         - application/json
18151         - application/xml
18152       responses:
18153         "default":
18154           description: Response codes found in [response codes](https://wiki.onap.org/).
18155       parameters:
18156         - name: model-invariant-id
18157           in: path
18158           description: Unique identifier corresponding to the main definition of a model in ASDC
18159           required: true
18160           type: string
18161           example: __MODEL-INVARIANT-ID__
18162         - name: model-version-id
18163           in: path
18164           description: Unique identifier corresponding to one version of a model in ASDC
18165           required: true
18166           type: string
18167           example: __MODEL-VERSION-ID__
18168         - name: model-element-uuid
18169           in: path
18170           required: true
18171           type: string
18172           example: __MODEL-ELEMENT-UUID__
18173         - name: model-constraint-uuid
18174           in: path
18175           required: true
18176           type: string
18177           example: __MODEL-CONSTRAINT-UUID__
18178         - name: resource-version
18179           in: query
18180           description: resource-version for concurrency
18181           required: true
18182           type: string
18183   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints:
18184     get:
18185       tags:
18186         - ServiceDesignAndCreation
18187       summary: returns model-constraints
18188       description: returns model-constraints
18189       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraints
18190       produces:
18191         - application/json
18192         - application/xml
18193       responses:
18194         "200":
18195           description: successful operation
18196           schema:
18197               $ref: "#/getDefinitions/model-constraints"
18198         "default":
18199           description: Response codes found in [response codes](https://wiki.onap.org/).
18200       parameters:
18201         - name: model-invariant-id
18202           in: path
18203           description: Unique identifier corresponding to the main definition of a model in ASDC
18204           required: true
18205           type: string
18206           example: __MODEL-INVARIANT-ID__
18207         - name: model-version-id
18208           in: path
18209           description: Unique identifier corresponding to one version of a model in ASDC
18210           required: true
18211           type: string
18212           example: __MODEL-VERSION-ID__
18213         - name: model-element-uuid
18214           in: path
18215           required: true
18216           type: string
18217           example: __MODEL-ELEMENT-UUID__
18218         - name: model-type
18219           in: query
18220           description: Type of the model, e.g., service, resource, widget, etc.
18221           required: false
18222           type: string
18223         - name: model-name
18224           in: query
18225           description: Name of the model, which can change from version to version.
18226           required: false
18227           type: string
18228         - name: model-version
18229           in: query
18230           description: Version
18231           required: false
18232           type: string
18233   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/relationship-list/relationship:
18234     put:
18235       tags:
18236         - ServiceDesignAndCreation
18237       summary: see node definition for valid relationships
18238       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship
18239       consumes:
18240         - application/json
18241         - application/xml
18242       produces:
18243         - application/json
18244         - application/xml
18245       responses:
18246         "default":
18247           description: Response codes found in [response codes](https://wiki.onap.org/).
18248       parameters:
18249         - name: model-invariant-id
18250           in: path
18251           description: Unique identifier corresponding to the main definition of a model in ASDC
18252           required: true
18253           type: string
18254           example: __MODEL-INVARIANT-ID__
18255         - name: model-version-id
18256           in: path
18257           description: Unique identifier corresponding to one version of a model in ASDC
18258           required: true
18259           type: string
18260           example: __MODEL-VERSION-ID__
18261         - name: model-element-uuid
18262           in: path
18263           required: true
18264           type: string
18265           example: __MODEL-ELEMENT-UUID__
18266         - name: body
18267           in: body
18268           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)
18269           required: true
18270           schema:
18271             $ref: "#/definitions/relationship"
18272     delete:
18273       tags:
18274         - ServiceDesignAndCreation
18275       summary: delete an existing relationship
18276       description: delete an existing relationship
18277       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship
18278       consumes:
18279         - application/json
18280         - application/xml
18281       produces:
18282         - application/json
18283         - application/xml
18284       responses:
18285         "default":
18286           description: Response codes found in [response codes](https://wiki.onap.org/).
18287       parameters:
18288         - name: model-invariant-id
18289           in: path
18290           description: Unique identifier corresponding to the main definition of a model in ASDC
18291           required: true
18292           type: string
18293           example: __MODEL-INVARIANT-ID__
18294         - name: model-version-id
18295           in: path
18296           description: Unique identifier corresponding to one version of a model in ASDC
18297           required: true
18298           type: string
18299           example: __MODEL-VERSION-ID__
18300         - name: model-element-uuid
18301           in: path
18302           required: true
18303           type: string
18304           example: __MODEL-ELEMENT-UUID__
18305   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}:
18306     get:
18307       tags:
18308         - ServiceDesignAndCreation
18309       summary: returns model-element
18310       description: returns model-element
18311       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
18312       produces:
18313         - application/json
18314         - application/xml
18315       responses:
18316         "200":
18317           description: successful operation
18318           schema:
18319               $ref: "#/getDefinitions/model-element"
18320         "default":
18321           description: Response codes found in [response codes](https://wiki.onap.org/).
18322       parameters:
18323         - name: model-invariant-id
18324           in: path
18325           description: Unique identifier corresponding to the main definition of a model in ASDC
18326           required: true
18327           type: string
18328           example: __MODEL-INVARIANT-ID__
18329         - name: model-version-id
18330           in: path
18331           description: Unique identifier corresponding to one version of a model in ASDC
18332           required: true
18333           type: string
18334           example: __MODEL-VERSION-ID__
18335         - name: model-element-uuid
18336           in: path
18337           required: true
18338           type: string
18339           example: __MODEL-ELEMENT-UUID__
18340         - name: model-type
18341           in: query
18342           description: Type of the model, e.g., service, resource, widget, etc.
18343           required: false
18344           type: string
18345         - name: model-name
18346           in: query
18347           description: Name of the model, which can change from version to version.
18348           required: false
18349           type: string
18350         - name: model-version
18351           in: query
18352           description: Version
18353           required: false
18354           type: string
18355     put:
18356       tags:
18357         - ServiceDesignAndCreation
18358       summary: create or update an existing model-element
18359       description: |
18360         Create or update an existing model-element.
18361         #
18362         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
18363       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
18364       consumes:
18365         - application/json
18366         - application/xml
18367       produces:
18368         - application/json
18369         - application/xml
18370       responses:
18371         "default":
18372           description: Response codes found in [response codes](https://wiki.onap.org/).
18373       parameters:
18374         - name: model-invariant-id
18375           in: path
18376           description: Unique identifier corresponding to the main definition of a model in ASDC
18377           required: true
18378           type: string
18379           example: __MODEL-INVARIANT-ID__
18380         - name: model-version-id
18381           in: path
18382           description: Unique identifier corresponding to one version of a model in ASDC
18383           required: true
18384           type: string
18385           example: __MODEL-VERSION-ID__
18386         - name: model-element-uuid
18387           in: path
18388           required: true
18389           type: string
18390           example: __MODEL-ELEMENT-UUID__
18391         - name: body
18392           in: body
18393           description: model-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)
18394           required: true
18395           schema:
18396             $ref: "#/definitions/model-element"
18397     patch:
18398       tags:
18399         - ServiceDesignAndCreation
18400       summary: update an existing model-element
18401       description: |
18402         Update an existing model-element
18403         #
18404         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18405         The PUT operation will entirely replace an existing object.
18406         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
18407         #
18408         Other differences between PUT and PATCH are:
18409         #
18410         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18411         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18412         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18413       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
18414       consumes:
18415         - application/json
18416         - application/xml
18417       produces:
18418         - application/json
18419         - application/xml
18420       responses:
18421         "default":
18422           description: Response codes found in [response codes](https://wiki.onap.org/).
18423       parameters:
18424         - name: model-invariant-id
18425           in: path
18426           description: Unique identifier corresponding to the main definition of a model in ASDC
18427           required: true
18428           type: string
18429           example: __MODEL-INVARIANT-ID__
18430         - name: model-version-id
18431           in: path
18432           description: Unique identifier corresponding to one version of a model in ASDC
18433           required: true
18434           type: string
18435           example: __MODEL-VERSION-ID__
18436         - name: model-element-uuid
18437           in: path
18438           required: true
18439           type: string
18440           example: __MODEL-ELEMENT-UUID__
18441         - name: body
18442           in: body
18443           description: model-element object that needs to be created or updated.
18444           required: true
18445           schema:
18446             $ref: "#/patchDefinitions/model-element"
18447     delete:
18448       tags:
18449         - ServiceDesignAndCreation
18450       summary: delete an existing model-element
18451       description: delete an existing model-element
18452       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
18453       consumes:
18454         - application/json
18455         - application/xml
18456       produces:
18457         - application/json
18458         - application/xml
18459       responses:
18460         "default":
18461           description: Response codes found in [response codes](https://wiki.onap.org/).
18462       parameters:
18463         - name: model-invariant-id
18464           in: path
18465           description: Unique identifier corresponding to the main definition of a model in ASDC
18466           required: true
18467           type: string
18468           example: __MODEL-INVARIANT-ID__
18469         - name: model-version-id
18470           in: path
18471           description: Unique identifier corresponding to one version of a model in ASDC
18472           required: true
18473           type: string
18474           example: __MODEL-VERSION-ID__
18475         - name: model-element-uuid
18476           in: path
18477           required: true
18478           type: string
18479           example: __MODEL-ELEMENT-UUID__
18480         - name: resource-version
18481           in: query
18482           description: resource-version for concurrency
18483           required: true
18484           type: string
18485   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements:
18486     get:
18487       tags:
18488         - ServiceDesignAndCreation
18489       summary: returns model-elements
18490       description: returns model-elements
18491       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElements
18492       produces:
18493         - application/json
18494         - application/xml
18495       responses:
18496         "200":
18497           description: successful operation
18498           schema:
18499               $ref: "#/getDefinitions/model-elements"
18500         "default":
18501           description: Response codes found in [response codes](https://wiki.onap.org/).
18502       parameters:
18503         - name: model-invariant-id
18504           in: path
18505           description: Unique identifier corresponding to the main definition of a model in ASDC
18506           required: true
18507           type: string
18508           example: __MODEL-INVARIANT-ID__
18509         - name: model-version-id
18510           in: path
18511           description: Unique identifier corresponding to one version of a model in ASDC
18512           required: true
18513           type: string
18514           example: __MODEL-VERSION-ID__
18515         - name: model-type
18516           in: query
18517           description: Type of the model, e.g., service, resource, widget, etc.
18518           required: false
18519           type: string
18520         - name: model-name
18521           in: query
18522           description: Name of the model, which can change from version to version.
18523           required: false
18524           type: string
18525         - name: model-version
18526           in: query
18527           description: Version
18528           required: false
18529           type: string
18530   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}:
18531     get:
18532       tags:
18533         - ServiceDesignAndCreation
18534       summary: returns metadatum
18535       description: returns metadatum
18536       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
18537       produces:
18538         - application/json
18539         - application/xml
18540       responses:
18541         "200":
18542           description: successful operation
18543           schema:
18544               $ref: "#/getDefinitions/metadatum"
18545         "default":
18546           description: Response codes found in [response codes](https://wiki.onap.org/).
18547       parameters:
18548         - name: model-invariant-id
18549           in: path
18550           description: Unique identifier corresponding to the main definition of a model in ASDC
18551           required: true
18552           type: string
18553           example: __MODEL-INVARIANT-ID__
18554         - name: model-version-id
18555           in: path
18556           description: Unique identifier corresponding to one version of a model in ASDC
18557           required: true
18558           type: string
18559           example: __MODEL-VERSION-ID__
18560         - name: metaname
18561           in: path
18562           required: true
18563           type: string
18564           example: __METANAME__
18565         - name: model-type
18566           in: query
18567           description: Type of the model, e.g., service, resource, widget, etc.
18568           required: false
18569           type: string
18570         - name: model-name
18571           in: query
18572           description: Name of the model, which can change from version to version.
18573           required: false
18574           type: string
18575         - name: model-version
18576           in: query
18577           description: Version
18578           required: false
18579           type: string
18580     put:
18581       tags:
18582         - ServiceDesignAndCreation
18583       summary: create or update an existing metadatum
18584       description: |
18585         Create or update an existing metadatum.
18586         #
18587         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
18588       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
18589       consumes:
18590         - application/json
18591         - application/xml
18592       produces:
18593         - application/json
18594         - application/xml
18595       responses:
18596         "default":
18597           description: Response codes found in [response codes](https://wiki.onap.org/).
18598       parameters:
18599         - name: model-invariant-id
18600           in: path
18601           description: Unique identifier corresponding to the main definition of a model in ASDC
18602           required: true
18603           type: string
18604           example: __MODEL-INVARIANT-ID__
18605         - name: model-version-id
18606           in: path
18607           description: Unique identifier corresponding to one version of a model in ASDC
18608           required: true
18609           type: string
18610           example: __MODEL-VERSION-ID__
18611         - name: metaname
18612           in: path
18613           required: true
18614           type: string
18615           example: __METANAME__
18616         - name: body
18617           in: body
18618           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum.json)
18619           required: true
18620           schema:
18621             $ref: "#/definitions/metadatum"
18622     patch:
18623       tags:
18624         - ServiceDesignAndCreation
18625       summary: update an existing metadatum
18626       description: |
18627         Update an existing metadatum
18628         #
18629         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18630         The PUT operation will entirely replace an existing object.
18631         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
18632         #
18633         Other differences between PUT and PATCH are:
18634         #
18635         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18636         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18637         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18638       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
18639       consumes:
18640         - application/json
18641         - application/xml
18642       produces:
18643         - application/json
18644         - application/xml
18645       responses:
18646         "default":
18647           description: Response codes found in [response codes](https://wiki.onap.org/).
18648       parameters:
18649         - name: model-invariant-id
18650           in: path
18651           description: Unique identifier corresponding to the main definition of a model in ASDC
18652           required: true
18653           type: string
18654           example: __MODEL-INVARIANT-ID__
18655         - name: model-version-id
18656           in: path
18657           description: Unique identifier corresponding to one version of a model in ASDC
18658           required: true
18659           type: string
18660           example: __MODEL-VERSION-ID__
18661         - name: metaname
18662           in: path
18663           required: true
18664           type: string
18665           example: __METANAME__
18666         - name: body
18667           in: body
18668           description: metadatum object that needs to be created or updated.
18669           required: true
18670           schema:
18671             $ref: "#/patchDefinitions/metadatum"
18672     delete:
18673       tags:
18674         - ServiceDesignAndCreation
18675       summary: delete an existing metadatum
18676       description: delete an existing metadatum
18677       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
18678       consumes:
18679         - application/json
18680         - application/xml
18681       produces:
18682         - application/json
18683         - application/xml
18684       responses:
18685         "default":
18686           description: Response codes found in [response codes](https://wiki.onap.org/).
18687       parameters:
18688         - name: model-invariant-id
18689           in: path
18690           description: Unique identifier corresponding to the main definition of a model in ASDC
18691           required: true
18692           type: string
18693           example: __MODEL-INVARIANT-ID__
18694         - name: model-version-id
18695           in: path
18696           description: Unique identifier corresponding to one version of a model in ASDC
18697           required: true
18698           type: string
18699           example: __MODEL-VERSION-ID__
18700         - name: metaname
18701           in: path
18702           required: true
18703           type: string
18704           example: __METANAME__
18705         - name: resource-version
18706           in: query
18707           description: resource-version for concurrency
18708           required: true
18709           type: string
18710   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata:
18711     get:
18712       tags:
18713         - ServiceDesignAndCreation
18714       summary: returns metadata
18715       description: returns metadata
18716       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadata
18717       produces:
18718         - application/json
18719         - application/xml
18720       responses:
18721         "200":
18722           description: successful operation
18723           schema:
18724               $ref: "#/getDefinitions/metadata"
18725         "default":
18726           description: Response codes found in [response codes](https://wiki.onap.org/).
18727       parameters:
18728         - name: model-invariant-id
18729           in: path
18730           description: Unique identifier corresponding to the main definition of a model in ASDC
18731           required: true
18732           type: string
18733           example: __MODEL-INVARIANT-ID__
18734         - name: model-version-id
18735           in: path
18736           description: Unique identifier corresponding to one version of a model in ASDC
18737           required: true
18738           type: string
18739           example: __MODEL-VERSION-ID__
18740         - name: model-type
18741           in: query
18742           description: Type of the model, e.g., service, resource, widget, etc.
18743           required: false
18744           type: string
18745         - name: model-name
18746           in: query
18747           description: Name of the model, which can change from version to version.
18748           required: false
18749           type: string
18750         - name: model-version
18751           in: query
18752           description: Version
18753           required: false
18754           type: string
18755   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship:
18756     put:
18757       tags:
18758         - ServiceDesignAndCreation
18759       summary: see node definition for valid relationships
18760       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship
18761       consumes:
18762         - application/json
18763         - application/xml
18764       produces:
18765         - application/json
18766         - application/xml
18767       responses:
18768         "default":
18769           description: Response codes found in [response codes](https://wiki.onap.org/).
18770       parameters:
18771         - name: model-invariant-id
18772           in: path
18773           description: Unique identifier corresponding to the main definition of a model in ASDC
18774           required: true
18775           type: string
18776           example: __MODEL-INVARIANT-ID__
18777         - name: model-version-id
18778           in: path
18779           description: Unique identifier corresponding to one version of a model in ASDC
18780           required: true
18781           type: string
18782           example: __MODEL-VERSION-ID__
18783         - name: body
18784           in: body
18785           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModelModelVersModelVer.json)
18786           required: true
18787           schema:
18788             $ref: "#/definitions/relationship"
18789     delete:
18790       tags:
18791         - ServiceDesignAndCreation
18792       summary: delete an existing relationship
18793       description: delete an existing relationship
18794       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship
18795       consumes:
18796         - application/json
18797         - application/xml
18798       produces:
18799         - application/json
18800         - application/xml
18801       responses:
18802         "default":
18803           description: Response codes found in [response codes](https://wiki.onap.org/).
18804       parameters:
18805         - name: model-invariant-id
18806           in: path
18807           description: Unique identifier corresponding to the main definition of a model in ASDC
18808           required: true
18809           type: string
18810           example: __MODEL-INVARIANT-ID__
18811         - name: model-version-id
18812           in: path
18813           description: Unique identifier corresponding to one version of a model in ASDC
18814           required: true
18815           type: string
18816           example: __MODEL-VERSION-ID__
18817   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}:
18818     get:
18819       tags:
18820         - ServiceDesignAndCreation
18821       summary: returns model-ver
18822       description: returns model-ver
18823       operationId: getServiceDesignAndCreationModelsModelModelVersModelVer
18824       produces:
18825         - application/json
18826         - application/xml
18827       responses:
18828         "200":
18829           description: successful operation
18830           schema:
18831               $ref: "#/getDefinitions/model-ver"
18832         "default":
18833           description: Response codes found in [response codes](https://wiki.onap.org/).
18834       parameters:
18835         - name: model-invariant-id
18836           in: path
18837           description: Unique identifier corresponding to the main definition of a model in ASDC
18838           required: true
18839           type: string
18840           example: __MODEL-INVARIANT-ID__
18841         - name: model-version-id
18842           in: path
18843           description: Unique identifier corresponding to one version of a model in ASDC
18844           required: true
18845           type: string
18846           example: __MODEL-VERSION-ID__
18847         - name: model-type
18848           in: query
18849           description: Type of the model, e.g., service, resource, widget, etc.
18850           required: false
18851           type: string
18852         - name: model-name
18853           in: query
18854           description: Name of the model, which can change from version to version.
18855           required: false
18856           type: string
18857         - name: model-version
18858           in: query
18859           description: Version
18860           required: false
18861           type: string
18862     put:
18863       tags:
18864         - ServiceDesignAndCreation
18865       summary: create or update an existing model-ver
18866       description: |
18867         Create or update an existing model-ver.
18868         #
18869         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
18870       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVer
18871       consumes:
18872         - application/json
18873         - application/xml
18874       produces:
18875         - application/json
18876         - application/xml
18877       responses:
18878         "default":
18879           description: Response codes found in [response codes](https://wiki.onap.org/).
18880       parameters:
18881         - name: model-invariant-id
18882           in: path
18883           description: Unique identifier corresponding to the main definition of a model in ASDC
18884           required: true
18885           type: string
18886           example: __MODEL-INVARIANT-ID__
18887         - name: model-version-id
18888           in: path
18889           description: Unique identifier corresponding to one version of a model in ASDC
18890           required: true
18891           type: string
18892           example: __MODEL-VERSION-ID__
18893         - name: body
18894           in: body
18895           description: model-ver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModelModelVersModelVer.json)
18896           required: true
18897           schema:
18898             $ref: "#/definitions/model-ver"
18899     patch:
18900       tags:
18901         - ServiceDesignAndCreation
18902       summary: update an existing model-ver
18903       description: |
18904         Update an existing model-ver
18905         #
18906         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18907         The PUT operation will entirely replace an existing object.
18908         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
18909         #
18910         Other differences between PUT and PATCH are:
18911         #
18912         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18913         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18914         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18915       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVer
18916       consumes:
18917         - application/json
18918         - application/xml
18919       produces:
18920         - application/json
18921         - application/xml
18922       responses:
18923         "default":
18924           description: Response codes found in [response codes](https://wiki.onap.org/).
18925       parameters:
18926         - name: model-invariant-id
18927           in: path
18928           description: Unique identifier corresponding to the main definition of a model in ASDC
18929           required: true
18930           type: string
18931           example: __MODEL-INVARIANT-ID__
18932         - name: model-version-id
18933           in: path
18934           description: Unique identifier corresponding to one version of a model in ASDC
18935           required: true
18936           type: string
18937           example: __MODEL-VERSION-ID__
18938         - name: body
18939           in: body
18940           description: model-ver object that needs to be created or updated.
18941           required: true
18942           schema:
18943             $ref: "#/patchDefinitions/model-ver"
18944     delete:
18945       tags:
18946         - ServiceDesignAndCreation
18947       summary: delete an existing model-ver
18948       description: delete an existing model-ver
18949       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVer
18950       consumes:
18951         - application/json
18952         - application/xml
18953       produces:
18954         - application/json
18955         - application/xml
18956       responses:
18957         "default":
18958           description: Response codes found in [response codes](https://wiki.onap.org/).
18959       parameters:
18960         - name: model-invariant-id
18961           in: path
18962           description: Unique identifier corresponding to the main definition of a model in ASDC
18963           required: true
18964           type: string
18965           example: __MODEL-INVARIANT-ID__
18966         - name: model-version-id
18967           in: path
18968           description: Unique identifier corresponding to one version of a model in ASDC
18969           required: true
18970           type: string
18971           example: __MODEL-VERSION-ID__
18972         - name: resource-version
18973           in: query
18974           description: resource-version for concurrency
18975           required: true
18976           type: string
18977   /service-design-and-creation/models/model/{model-invariant-id}/model-vers:
18978     get:
18979       tags:
18980         - ServiceDesignAndCreation
18981       summary: returns model-vers
18982       description: returns model-vers
18983       operationId: getServiceDesignAndCreationModelsModelModelVers
18984       produces:
18985         - application/json
18986         - application/xml
18987       responses:
18988         "200":
18989           description: successful operation
18990           schema:
18991               $ref: "#/getDefinitions/model-vers"
18992         "default":
18993           description: Response codes found in [response codes](https://wiki.onap.org/).
18994       parameters:
18995         - name: model-invariant-id
18996           in: path
18997           description: Unique identifier corresponding to the main definition of a model in ASDC
18998           required: true
18999           type: string
19000           example: __MODEL-INVARIANT-ID__
19001         - name: model-type
19002           in: query
19003           description: Type of the model, e.g., service, resource, widget, etc.
19004           required: false
19005           type: string
19006   /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship:
19007     put:
19008       tags:
19009         - ServiceDesignAndCreation
19010       summary: see node definition for valid relationships
19011       operationId: createOrUpdateServiceDesignAndCreationModelsModelRelationshipListRelationship
19012       consumes:
19013         - application/json
19014         - application/xml
19015       produces:
19016         - application/json
19017         - application/xml
19018       responses:
19019         "default":
19020           description: Response codes found in [response codes](https://wiki.onap.org/).
19021       parameters:
19022         - name: model-invariant-id
19023           in: path
19024           description: Unique identifier corresponding to the main definition of a model in ASDC
19025           required: true
19026           type: string
19027           example: __MODEL-INVARIANT-ID__
19028         - name: body
19029           in: body
19030           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModel.json)
19031           required: true
19032           schema:
19033             $ref: "#/definitions/relationship"
19034     delete:
19035       tags:
19036         - ServiceDesignAndCreation
19037       summary: delete an existing relationship
19038       description: delete an existing relationship
19039       operationId: deleteServiceDesignAndCreationModelsModelRelationshipListRelationship
19040       consumes:
19041         - application/json
19042         - application/xml
19043       produces:
19044         - application/json
19045         - application/xml
19046       responses:
19047         "default":
19048           description: Response codes found in [response codes](https://wiki.onap.org/).
19049       parameters:
19050         - name: model-invariant-id
19051           in: path
19052           description: Unique identifier corresponding to the main definition of a model in ASDC
19053           required: true
19054           type: string
19055           example: __MODEL-INVARIANT-ID__
19056   /service-design-and-creation/models/model/{model-invariant-id}:
19057     get:
19058       tags:
19059         - ServiceDesignAndCreation
19060       summary: returns model
19061       description: returns model
19062       operationId: getServiceDesignAndCreationModelsModel
19063       produces:
19064         - application/json
19065         - application/xml
19066       responses:
19067         "200":
19068           description: successful operation
19069           schema:
19070               $ref: "#/getDefinitions/model"
19071         "default":
19072           description: Response codes found in [response codes](https://wiki.onap.org/).
19073       parameters:
19074         - name: model-invariant-id
19075           in: path
19076           description: Unique identifier corresponding to the main definition of a model in ASDC
19077           required: true
19078           type: string
19079           example: __MODEL-INVARIANT-ID__
19080         - name: model-type
19081           in: query
19082           description: Type of the model, e.g., service, resource, widget, etc.
19083           required: false
19084           type: string
19085     put:
19086       tags:
19087         - ServiceDesignAndCreation
19088       summary: create or update an existing model
19089       description: |
19090         Create or update an existing model.
19091         #
19092         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
19093       operationId: createOrUpdateServiceDesignAndCreationModelsModel
19094       consumes:
19095         - application/json
19096         - application/xml
19097       produces:
19098         - application/json
19099         - application/xml
19100       responses:
19101         "default":
19102           description: Response codes found in [response codes](https://wiki.onap.org/).
19103       parameters:
19104         - name: model-invariant-id
19105           in: path
19106           description: Unique identifier corresponding to the main definition of a model in ASDC
19107           required: true
19108           type: string
19109           example: __MODEL-INVARIANT-ID__
19110         - name: body
19111           in: body
19112           description: model object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModel.json)
19113           required: true
19114           schema:
19115             $ref: "#/definitions/model"
19116     patch:
19117       tags:
19118         - ServiceDesignAndCreation
19119       summary: update an existing model
19120       description: |
19121         Update an existing model
19122         #
19123         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19124         The PUT operation will entirely replace an existing object.
19125         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
19126         #
19127         Other differences between PUT and PATCH are:
19128         #
19129         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19130         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19131         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19132       operationId: UpdateServiceDesignAndCreationModelsModel
19133       consumes:
19134         - application/json
19135         - application/xml
19136       produces:
19137         - application/json
19138         - application/xml
19139       responses:
19140         "default":
19141           description: Response codes found in [response codes](https://wiki.onap.org/).
19142       parameters:
19143         - name: model-invariant-id
19144           in: path
19145           description: Unique identifier corresponding to the main definition of a model in ASDC
19146           required: true
19147           type: string
19148           example: __MODEL-INVARIANT-ID__
19149         - name: body
19150           in: body
19151           description: model object that needs to be created or updated.
19152           required: true
19153           schema:
19154             $ref: "#/patchDefinitions/model"
19155     delete:
19156       tags:
19157         - ServiceDesignAndCreation
19158       summary: delete an existing model
19159       description: delete an existing model
19160       operationId: deleteServiceDesignAndCreationModelsModel
19161       consumes:
19162         - application/json
19163         - application/xml
19164       produces:
19165         - application/json
19166         - application/xml
19167       responses:
19168         "default":
19169           description: Response codes found in [response codes](https://wiki.onap.org/).
19170       parameters:
19171         - name: model-invariant-id
19172           in: path
19173           description: Unique identifier corresponding to the main definition of a model in ASDC
19174           required: true
19175           type: string
19176           example: __MODEL-INVARIANT-ID__
19177         - name: resource-version
19178           in: query
19179           description: resource-version for concurrency
19180           required: true
19181           type: string
19182   /service-design-and-creation/models:
19183     get:
19184       tags:
19185         - ServiceDesignAndCreation
19186       summary: returns models
19187       description: returns models
19188       operationId: getServiceDesignAndCreationModels
19189       produces:
19190         - application/json
19191         - application/xml
19192       responses:
19193         "200":
19194           description: successful operation
19195           schema:
19196               $ref: "#/getDefinitions/models"
19197         "default":
19198           description: Response codes found in [response codes](https://wiki.onap.org/).
19199   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}/relationship-list/relationship:
19200     put:
19201       tags:
19202         - ServiceDesignAndCreation
19203       summary: see node definition for valid relationships
19204       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
19205       consumes:
19206         - application/json
19207         - application/xml
19208       produces:
19209         - application/json
19210         - application/xml
19211       responses:
19212         "default":
19213           description: Response codes found in [response codes](https://wiki.onap.org/).
19214       parameters:
19215         - name: named-query-uuid
19216           in: path
19217           required: true
19218           type: string
19219           example: __NAMED-QUERY-UUID__
19220         - name: named-query-element-uuid
19221           in: path
19222           required: true
19223           type: string
19224           example: __NAMED-QUERY-ELEMENT-UUID__
19225         - name: related-lookup-uuid
19226           in: path
19227           required: true
19228           type: string
19229           example: __RELATED-LOOKUP-UUID__
19230         - name: body
19231           in: body
19232           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
19233           required: true
19234           schema:
19235             $ref: "#/definitions/relationship"
19236     delete:
19237       tags:
19238         - ServiceDesignAndCreation
19239       summary: delete an existing relationship
19240       description: delete an existing relationship
19241       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
19242       consumes:
19243         - application/json
19244         - application/xml
19245       produces:
19246         - application/json
19247         - application/xml
19248       responses:
19249         "default":
19250           description: Response codes found in [response codes](https://wiki.onap.org/).
19251       parameters:
19252         - name: named-query-uuid
19253           in: path
19254           required: true
19255           type: string
19256           example: __NAMED-QUERY-UUID__
19257         - name: named-query-element-uuid
19258           in: path
19259           required: true
19260           type: string
19261           example: __NAMED-QUERY-ELEMENT-UUID__
19262         - name: related-lookup-uuid
19263           in: path
19264           required: true
19265           type: string
19266           example: __RELATED-LOOKUP-UUID__
19267   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}:
19268     get:
19269       tags:
19270         - ServiceDesignAndCreation
19271       summary: returns related-lookup
19272       description: returns related-lookup
19273       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
19274       produces:
19275         - application/json
19276         - application/xml
19277       responses:
19278         "200":
19279           description: successful operation
19280           schema:
19281               $ref: "#/getDefinitions/related-lookup"
19282         "default":
19283           description: Response codes found in [response codes](https://wiki.onap.org/).
19284       parameters:
19285         - name: named-query-uuid
19286           in: path
19287           required: true
19288           type: string
19289           example: __NAMED-QUERY-UUID__
19290         - name: named-query-element-uuid
19291           in: path
19292           required: true
19293           type: string
19294           example: __NAMED-QUERY-ELEMENT-UUID__
19295         - name: related-lookup-uuid
19296           in: path
19297           required: true
19298           type: string
19299           example: __RELATED-LOOKUP-UUID__
19300         - name: named-query-name
19301           in: query
19302           required: false
19303           type: string
19304     put:
19305       tags:
19306         - ServiceDesignAndCreation
19307       summary: create or update an existing related-lookup
19308       description: |
19309         Create or update an existing related-lookup.
19310         #
19311         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
19312       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
19313       consumes:
19314         - application/json
19315         - application/xml
19316       produces:
19317         - application/json
19318         - application/xml
19319       responses:
19320         "default":
19321           description: Response codes found in [response codes](https://wiki.onap.org/).
19322       parameters:
19323         - name: named-query-uuid
19324           in: path
19325           required: true
19326           type: string
19327           example: __NAMED-QUERY-UUID__
19328         - name: named-query-element-uuid
19329           in: path
19330           required: true
19331           type: string
19332           example: __NAMED-QUERY-ELEMENT-UUID__
19333         - name: related-lookup-uuid
19334           in: path
19335           required: true
19336           type: string
19337           example: __RELATED-LOOKUP-UUID__
19338         - name: body
19339           in: body
19340           description: related-lookup object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
19341           required: true
19342           schema:
19343             $ref: "#/definitions/related-lookup"
19344     patch:
19345       tags:
19346         - ServiceDesignAndCreation
19347       summary: update an existing related-lookup
19348       description: |
19349         Update an existing related-lookup
19350         #
19351         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19352         The PUT operation will entirely replace an existing object.
19353         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
19354         #
19355         Other differences between PUT and PATCH are:
19356         #
19357         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19358         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19359         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19360       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
19361       consumes:
19362         - application/json
19363         - application/xml
19364       produces:
19365         - application/json
19366         - application/xml
19367       responses:
19368         "default":
19369           description: Response codes found in [response codes](https://wiki.onap.org/).
19370       parameters:
19371         - name: named-query-uuid
19372           in: path
19373           required: true
19374           type: string
19375           example: __NAMED-QUERY-UUID__
19376         - name: named-query-element-uuid
19377           in: path
19378           required: true
19379           type: string
19380           example: __NAMED-QUERY-ELEMENT-UUID__
19381         - name: related-lookup-uuid
19382           in: path
19383           required: true
19384           type: string
19385           example: __RELATED-LOOKUP-UUID__
19386         - name: body
19387           in: body
19388           description: related-lookup object that needs to be created or updated.
19389           required: true
19390           schema:
19391             $ref: "#/patchDefinitions/related-lookup"
19392     delete:
19393       tags:
19394         - ServiceDesignAndCreation
19395       summary: delete an existing related-lookup
19396       description: delete an existing related-lookup
19397       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
19398       consumes:
19399         - application/json
19400         - application/xml
19401       produces:
19402         - application/json
19403         - application/xml
19404       responses:
19405         "default":
19406           description: Response codes found in [response codes](https://wiki.onap.org/).
19407       parameters:
19408         - name: named-query-uuid
19409           in: path
19410           required: true
19411           type: string
19412           example: __NAMED-QUERY-UUID__
19413         - name: named-query-element-uuid
19414           in: path
19415           required: true
19416           type: string
19417           example: __NAMED-QUERY-ELEMENT-UUID__
19418         - name: related-lookup-uuid
19419           in: path
19420           required: true
19421           type: string
19422           example: __RELATED-LOOKUP-UUID__
19423         - name: resource-version
19424           in: query
19425           description: resource-version for concurrency
19426           required: true
19427           type: string
19428   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups:
19429     get:
19430       tags:
19431         - ServiceDesignAndCreation
19432       summary: returns related-lookups
19433       description: returns related-lookups
19434       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookups
19435       produces:
19436         - application/json
19437         - application/xml
19438       responses:
19439         "200":
19440           description: successful operation
19441           schema:
19442               $ref: "#/getDefinitions/related-lookups"
19443         "default":
19444           description: Response codes found in [response codes](https://wiki.onap.org/).
19445       parameters:
19446         - name: named-query-uuid
19447           in: path
19448           required: true
19449           type: string
19450           example: __NAMED-QUERY-UUID__
19451         - name: named-query-element-uuid
19452           in: path
19453           required: true
19454           type: string
19455           example: __NAMED-QUERY-ELEMENT-UUID__
19456         - name: named-query-name
19457           in: query
19458           required: false
19459           type: string
19460   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints/property-constraint/{property-constraint-uuid}:
19461     get:
19462       tags:
19463         - ServiceDesignAndCreation
19464       summary: returns property-constraint
19465       description: returns property-constraint
19466       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
19467       produces:
19468         - application/json
19469         - application/xml
19470       responses:
19471         "200":
19472           description: successful operation
19473           schema:
19474               $ref: "#/getDefinitions/property-constraint"
19475         "default":
19476           description: Response codes found in [response codes](https://wiki.onap.org/).
19477       parameters:
19478         - name: named-query-uuid
19479           in: path
19480           required: true
19481           type: string
19482           example: __NAMED-QUERY-UUID__
19483         - name: named-query-element-uuid
19484           in: path
19485           required: true
19486           type: string
19487           example: __NAMED-QUERY-ELEMENT-UUID__
19488         - name: property-constraint-uuid
19489           in: path
19490           required: true
19491           type: string
19492           example: __PROPERTY-CONSTRAINT-UUID__
19493         - name: named-query-name
19494           in: query
19495           required: false
19496           type: string
19497     put:
19498       tags:
19499         - ServiceDesignAndCreation
19500       summary: create or update an existing property-constraint
19501       description: |
19502         Create or update an existing property-constraint.
19503         #
19504         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
19505       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
19506       consumes:
19507         - application/json
19508         - application/xml
19509       produces:
19510         - application/json
19511         - application/xml
19512       responses:
19513         "default":
19514           description: Response codes found in [response codes](https://wiki.onap.org/).
19515       parameters:
19516         - name: named-query-uuid
19517           in: path
19518           required: true
19519           type: string
19520           example: __NAMED-QUERY-UUID__
19521         - name: named-query-element-uuid
19522           in: path
19523           required: true
19524           type: string
19525           example: __NAMED-QUERY-ELEMENT-UUID__
19526         - name: property-constraint-uuid
19527           in: path
19528           required: true
19529           type: string
19530           example: __PROPERTY-CONSTRAINT-UUID__
19531         - name: body
19532           in: body
19533           description: property-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint.json)
19534           required: true
19535           schema:
19536             $ref: "#/definitions/property-constraint"
19537     patch:
19538       tags:
19539         - ServiceDesignAndCreation
19540       summary: update an existing property-constraint
19541       description: |
19542         Update an existing property-constraint
19543         #
19544         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19545         The PUT operation will entirely replace an existing object.
19546         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
19547         #
19548         Other differences between PUT and PATCH are:
19549         #
19550         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19551         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19552         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19553       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
19554       consumes:
19555         - application/json
19556         - application/xml
19557       produces:
19558         - application/json
19559         - application/xml
19560       responses:
19561         "default":
19562           description: Response codes found in [response codes](https://wiki.onap.org/).
19563       parameters:
19564         - name: named-query-uuid
19565           in: path
19566           required: true
19567           type: string
19568           example: __NAMED-QUERY-UUID__
19569         - name: named-query-element-uuid
19570           in: path
19571           required: true
19572           type: string
19573           example: __NAMED-QUERY-ELEMENT-UUID__
19574         - name: property-constraint-uuid
19575           in: path
19576           required: true
19577           type: string
19578           example: __PROPERTY-CONSTRAINT-UUID__
19579         - name: body
19580           in: body
19581           description: property-constraint object that needs to be created or updated.
19582           required: true
19583           schema:
19584             $ref: "#/patchDefinitions/property-constraint"
19585     delete:
19586       tags:
19587         - ServiceDesignAndCreation
19588       summary: delete an existing property-constraint
19589       description: delete an existing property-constraint
19590       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
19591       consumes:
19592         - application/json
19593         - application/xml
19594       produces:
19595         - application/json
19596         - application/xml
19597       responses:
19598         "default":
19599           description: Response codes found in [response codes](https://wiki.onap.org/).
19600       parameters:
19601         - name: named-query-uuid
19602           in: path
19603           required: true
19604           type: string
19605           example: __NAMED-QUERY-UUID__
19606         - name: named-query-element-uuid
19607           in: path
19608           required: true
19609           type: string
19610           example: __NAMED-QUERY-ELEMENT-UUID__
19611         - name: property-constraint-uuid
19612           in: path
19613           required: true
19614           type: string
19615           example: __PROPERTY-CONSTRAINT-UUID__
19616         - name: resource-version
19617           in: query
19618           description: resource-version for concurrency
19619           required: true
19620           type: string
19621   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints:
19622     get:
19623       tags:
19624         - ServiceDesignAndCreation
19625       summary: returns property-constraints
19626       description: returns property-constraints
19627       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraints
19628       produces:
19629         - application/json
19630         - application/xml
19631       responses:
19632         "200":
19633           description: successful operation
19634           schema:
19635               $ref: "#/getDefinitions/property-constraints"
19636         "default":
19637           description: Response codes found in [response codes](https://wiki.onap.org/).
19638       parameters:
19639         - name: named-query-uuid
19640           in: path
19641           required: true
19642           type: string
19643           example: __NAMED-QUERY-UUID__
19644         - name: named-query-element-uuid
19645           in: path
19646           required: true
19647           type: string
19648           example: __NAMED-QUERY-ELEMENT-UUID__
19649         - name: named-query-name
19650           in: query
19651           required: false
19652           type: string
19653   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship:
19654     put:
19655       tags:
19656         - ServiceDesignAndCreation
19657       summary: see node definition for valid relationships
19658       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
19659       consumes:
19660         - application/json
19661         - application/xml
19662       produces:
19663         - application/json
19664         - application/xml
19665       responses:
19666         "default":
19667           description: Response codes found in [response codes](https://wiki.onap.org/).
19668       parameters:
19669         - name: named-query-uuid
19670           in: path
19671           required: true
19672           type: string
19673           example: __NAMED-QUERY-UUID__
19674         - name: named-query-element-uuid
19675           in: path
19676           required: true
19677           type: string
19678           example: __NAMED-QUERY-ELEMENT-UUID__
19679         - name: body
19680           in: body
19681           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
19682           required: true
19683           schema:
19684             $ref: "#/definitions/relationship"
19685     delete:
19686       tags:
19687         - ServiceDesignAndCreation
19688       summary: delete an existing relationship
19689       description: delete an existing relationship
19690       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
19691       consumes:
19692         - application/json
19693         - application/xml
19694       produces:
19695         - application/json
19696         - application/xml
19697       responses:
19698         "default":
19699           description: Response codes found in [response codes](https://wiki.onap.org/).
19700       parameters:
19701         - name: named-query-uuid
19702           in: path
19703           required: true
19704           type: string
19705           example: __NAMED-QUERY-UUID__
19706         - name: named-query-element-uuid
19707           in: path
19708           required: true
19709           type: string
19710           example: __NAMED-QUERY-ELEMENT-UUID__
19711   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}:
19712     get:
19713       tags:
19714         - ServiceDesignAndCreation
19715       summary: returns named-query-element
19716       description: returns named-query-element
19717       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
19718       produces:
19719         - application/json
19720         - application/xml
19721       responses:
19722         "200":
19723           description: successful operation
19724           schema:
19725               $ref: "#/getDefinitions/named-query-element"
19726         "default":
19727           description: Response codes found in [response codes](https://wiki.onap.org/).
19728       parameters:
19729         - name: named-query-uuid
19730           in: path
19731           required: true
19732           type: string
19733           example: __NAMED-QUERY-UUID__
19734         - name: named-query-element-uuid
19735           in: path
19736           required: true
19737           type: string
19738           example: __NAMED-QUERY-ELEMENT-UUID__
19739         - name: named-query-name
19740           in: query
19741           required: false
19742           type: string
19743     put:
19744       tags:
19745         - ServiceDesignAndCreation
19746       summary: create or update an existing named-query-element
19747       description: |
19748         Create or update an existing named-query-element.
19749         #
19750         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
19751       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
19752       consumes:
19753         - application/json
19754         - application/xml
19755       produces:
19756         - application/json
19757         - application/xml
19758       responses:
19759         "default":
19760           description: Response codes found in [response codes](https://wiki.onap.org/).
19761       parameters:
19762         - name: named-query-uuid
19763           in: path
19764           required: true
19765           type: string
19766           example: __NAMED-QUERY-UUID__
19767         - name: named-query-element-uuid
19768           in: path
19769           required: true
19770           type: string
19771           example: __NAMED-QUERY-ELEMENT-UUID__
19772         - name: body
19773           in: body
19774           description: named-query-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
19775           required: true
19776           schema:
19777             $ref: "#/definitions/named-query-element"
19778     patch:
19779       tags:
19780         - ServiceDesignAndCreation
19781       summary: update an existing named-query-element
19782       description: |
19783         Update an existing named-query-element
19784         #
19785         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19786         The PUT operation will entirely replace an existing object.
19787         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
19788         #
19789         Other differences between PUT and PATCH are:
19790         #
19791         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19792         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19793         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19794       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
19795       consumes:
19796         - application/json
19797         - application/xml
19798       produces:
19799         - application/json
19800         - application/xml
19801       responses:
19802         "default":
19803           description: Response codes found in [response codes](https://wiki.onap.org/).
19804       parameters:
19805         - name: named-query-uuid
19806           in: path
19807           required: true
19808           type: string
19809           example: __NAMED-QUERY-UUID__
19810         - name: named-query-element-uuid
19811           in: path
19812           required: true
19813           type: string
19814           example: __NAMED-QUERY-ELEMENT-UUID__
19815         - name: body
19816           in: body
19817           description: named-query-element object that needs to be created or updated.
19818           required: true
19819           schema:
19820             $ref: "#/patchDefinitions/named-query-element"
19821     delete:
19822       tags:
19823         - ServiceDesignAndCreation
19824       summary: delete an existing named-query-element
19825       description: delete an existing named-query-element
19826       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
19827       consumes:
19828         - application/json
19829         - application/xml
19830       produces:
19831         - application/json
19832         - application/xml
19833       responses:
19834         "default":
19835           description: Response codes found in [response codes](https://wiki.onap.org/).
19836       parameters:
19837         - name: named-query-uuid
19838           in: path
19839           required: true
19840           type: string
19841           example: __NAMED-QUERY-UUID__
19842         - name: named-query-element-uuid
19843           in: path
19844           required: true
19845           type: string
19846           example: __NAMED-QUERY-ELEMENT-UUID__
19847         - name: resource-version
19848           in: query
19849           description: resource-version for concurrency
19850           required: true
19851           type: string
19852   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements:
19853     get:
19854       tags:
19855         - ServiceDesignAndCreation
19856       summary: returns named-query-elements
19857       description: returns named-query-elements
19858       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElements
19859       produces:
19860         - application/json
19861         - application/xml
19862       responses:
19863         "200":
19864           description: successful operation
19865           schema:
19866               $ref: "#/getDefinitions/named-query-elements"
19867         "default":
19868           description: Response codes found in [response codes](https://wiki.onap.org/).
19869       parameters:
19870         - name: named-query-uuid
19871           in: path
19872           required: true
19873           type: string
19874           example: __NAMED-QUERY-UUID__
19875         - name: named-query-name
19876           in: query
19877           required: false
19878           type: string
19879   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship:
19880     put:
19881       tags:
19882         - ServiceDesignAndCreation
19883       summary: see node definition for valid relationships
19884       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
19885       consumes:
19886         - application/json
19887         - application/xml
19888       produces:
19889         - application/json
19890         - application/xml
19891       responses:
19892         "default":
19893           description: Response codes found in [response codes](https://wiki.onap.org/).
19894       parameters:
19895         - name: named-query-uuid
19896           in: path
19897           required: true
19898           type: string
19899           example: __NAMED-QUERY-UUID__
19900         - name: body
19901           in: body
19902           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
19903           required: true
19904           schema:
19905             $ref: "#/definitions/relationship"
19906     delete:
19907       tags:
19908         - ServiceDesignAndCreation
19909       summary: delete an existing relationship
19910       description: delete an existing relationship
19911       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
19912       consumes:
19913         - application/json
19914         - application/xml
19915       produces:
19916         - application/json
19917         - application/xml
19918       responses:
19919         "default":
19920           description: Response codes found in [response codes](https://wiki.onap.org/).
19921       parameters:
19922         - name: named-query-uuid
19923           in: path
19924           required: true
19925           type: string
19926           example: __NAMED-QUERY-UUID__
19927   /service-design-and-creation/named-queries/named-query/{named-query-uuid}:
19928     get:
19929       tags:
19930         - ServiceDesignAndCreation
19931       summary: returns named-query
19932       description: returns named-query
19933       operationId: getServiceDesignAndCreationNamedQueriesNamedQuery
19934       produces:
19935         - application/json
19936         - application/xml
19937       responses:
19938         "200":
19939           description: successful operation
19940           schema:
19941               $ref: "#/getDefinitions/named-query"
19942         "default":
19943           description: Response codes found in [response codes](https://wiki.onap.org/).
19944       parameters:
19945         - name: named-query-uuid
19946           in: path
19947           required: true
19948           type: string
19949           example: __NAMED-QUERY-UUID__
19950         - name: named-query-name
19951           in: query
19952           required: false
19953           type: string
19954     put:
19955       tags:
19956         - ServiceDesignAndCreation
19957       summary: create or update an existing named-query
19958       description: |
19959         Create or update an existing named-query.
19960         #
19961         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
19962       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQuery
19963       consumes:
19964         - application/json
19965         - application/xml
19966       produces:
19967         - application/json
19968         - application/xml
19969       responses:
19970         "default":
19971           description: Response codes found in [response codes](https://wiki.onap.org/).
19972       parameters:
19973         - name: named-query-uuid
19974           in: path
19975           required: true
19976           type: string
19977           example: __NAMED-QUERY-UUID__
19978         - name: body
19979           in: body
19980           description: named-query object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
19981           required: true
19982           schema:
19983             $ref: "#/definitions/named-query"
19984     patch:
19985       tags:
19986         - ServiceDesignAndCreation
19987       summary: update an existing named-query
19988       description: |
19989         Update an existing named-query
19990         #
19991         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19992         The PUT operation will entirely replace an existing object.
19993         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
19994         #
19995         Other differences between PUT and PATCH are:
19996         #
19997         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19998         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19999         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20000       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQuery
20001       consumes:
20002         - application/json
20003         - application/xml
20004       produces:
20005         - application/json
20006         - application/xml
20007       responses:
20008         "default":
20009           description: Response codes found in [response codes](https://wiki.onap.org/).
20010       parameters:
20011         - name: named-query-uuid
20012           in: path
20013           required: true
20014           type: string
20015           example: __NAMED-QUERY-UUID__
20016         - name: body
20017           in: body
20018           description: named-query object that needs to be created or updated.
20019           required: true
20020           schema:
20021             $ref: "#/patchDefinitions/named-query"
20022     delete:
20023       tags:
20024         - ServiceDesignAndCreation
20025       summary: delete an existing named-query
20026       description: delete an existing named-query
20027       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQuery
20028       consumes:
20029         - application/json
20030         - application/xml
20031       produces:
20032         - application/json
20033         - application/xml
20034       responses:
20035         "default":
20036           description: Response codes found in [response codes](https://wiki.onap.org/).
20037       parameters:
20038         - name: named-query-uuid
20039           in: path
20040           required: true
20041           type: string
20042           example: __NAMED-QUERY-UUID__
20043         - name: resource-version
20044           in: query
20045           description: resource-version for concurrency
20046           required: true
20047           type: string
20048   /service-design-and-creation/named-queries:
20049     get:
20050       tags:
20051         - ServiceDesignAndCreation
20052       summary: returns named-queries
20053       description: returns named-queries
20054       operationId: getServiceDesignAndCreationNamedQueries
20055       produces:
20056         - application/json
20057         - application/xml
20058       responses:
20059         "200":
20060           description: successful operation
20061           schema:
20062               $ref: "#/getDefinitions/named-queries"
20063         "default":
20064           description: Response codes found in [response codes](https://wiki.onap.org/).
20065   /network/logical-links/logical-link/{link-name}/relationship-list/relationship:
20066     put:
20067       tags:
20068         - Network
20069       summary: see node definition for valid relationships
20070       operationId: createOrUpdateNetworkLogicalLinksLogicalLinkRelationshipListRelationship
20071       consumes:
20072         - application/json
20073         - application/xml
20074       produces:
20075         - application/json
20076         - application/xml
20077       responses:
20078         "default":
20079           description: Response codes found in [response codes](https://wiki.onap.org/).
20080       parameters:
20081         - name: link-name
20082           in: path
20083           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
20084           required: true
20085           type: string
20086           example: __LINK-NAME__
20087         - name: body
20088           in: body
20089           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkLogicalLinksLogicalLink.json)
20090           required: true
20091           schema:
20092             $ref: "#/definitions/relationship"
20093     delete:
20094       tags:
20095         - Network
20096       summary: delete an existing relationship
20097       description: delete an existing relationship
20098       operationId: deleteNetworkLogicalLinksLogicalLinkRelationshipListRelationship
20099       consumes:
20100         - application/json
20101         - application/xml
20102       produces:
20103         - application/json
20104         - application/xml
20105       responses:
20106         "default":
20107           description: Response codes found in [response codes](https://wiki.onap.org/).
20108       parameters:
20109         - name: link-name
20110           in: path
20111           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
20112           required: true
20113           type: string
20114           example: __LINK-NAME__
20115   /network/logical-links/logical-link/{link-name}:
20116     get:
20117       tags:
20118         - Network
20119       summary: returns logical-link
20120       description: returns logical-link
20121       operationId: getNetworkLogicalLinksLogicalLink
20122       produces:
20123         - application/json
20124         - application/xml
20125       responses:
20126         "200":
20127           description: successful operation
20128           schema:
20129               $ref: "#/getDefinitions/logical-link"
20130         "default":
20131           description: Response codes found in [response codes](https://wiki.onap.org/).
20132       parameters:
20133         - name: link-name
20134           in: path
20135           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
20136           required: true
20137           type: string
20138           example: __LINK-NAME__
20139         - name: persona-model-id
20140           in: query
20141           description: the ASDC model id for this resource or service model.
20142           required: false
20143           type: string
20144         - name: persona-model-version
20145           in: query
20146           description: the ASDC model version for this resource or service model.
20147           required: false
20148           type: string
20149         - name: widget-model-id
20150           in: query
20151           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
20152           required: false
20153           type: string
20154         - name: widget-model-version
20155           in: query
20156           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
20157           required: false
20158           type: string
20159         - name: prov-status
20160           in: query
20161           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
20162           required: false
20163           type: string
20164         - name: link-id
20165           in: query
20166           description: UUID of the logical-link, SDNC generates this.
20167           required: false
20168           type: string
20169         - name: circuit-id
20170           in: query
20171           description: Circuit id
20172           required: false
20173           type: string
20174         - name: purpose
20175           in: query
20176           description: Reason for this entity, role it is playing
20177           required: false
20178           type: string
20179     put:
20180       tags:
20181         - Network
20182       summary: create or update an existing logical-link
20183       description: |
20184         Create or update an existing logical-link.
20185         #
20186         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
20187       operationId: createOrUpdateNetworkLogicalLinksLogicalLink
20188       consumes:
20189         - application/json
20190         - application/xml
20191       produces:
20192         - application/json
20193         - application/xml
20194       responses:
20195         "default":
20196           description: Response codes found in [response codes](https://wiki.onap.org/).
20197       parameters:
20198         - name: link-name
20199           in: path
20200           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
20201           required: true
20202           type: string
20203           example: __LINK-NAME__
20204         - name: body
20205           in: body
20206           description: logical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkLogicalLinksLogicalLink.json)
20207           required: true
20208           schema:
20209             $ref: "#/definitions/logical-link"
20210     patch:
20211       tags:
20212         - Network
20213       summary: update an existing logical-link
20214       description: |
20215         Update an existing logical-link
20216         #
20217         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20218         The PUT operation will entirely replace an existing object.
20219         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
20220         #
20221         Other differences between PUT and PATCH are:
20222         #
20223         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
20224         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20225         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20226       operationId: UpdateNetworkLogicalLinksLogicalLink
20227       consumes:
20228         - application/json
20229         - application/xml
20230       produces:
20231         - application/json
20232         - application/xml
20233       responses:
20234         "default":
20235           description: Response codes found in [response codes](https://wiki.onap.org/).
20236       parameters:
20237         - name: link-name
20238           in: path
20239           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
20240           required: true
20241           type: string
20242           example: __LINK-NAME__
20243         - name: body
20244           in: body
20245           description: logical-link object that needs to be created or updated.
20246           required: true
20247           schema:
20248             $ref: "#/patchDefinitions/logical-link"
20249     delete:
20250       tags:
20251         - Network
20252       summary: delete an existing logical-link
20253       description: delete an existing logical-link
20254       operationId: deleteNetworkLogicalLinksLogicalLink
20255       consumes:
20256         - application/json
20257         - application/xml
20258       produces:
20259         - application/json
20260         - application/xml
20261       responses:
20262         "default":
20263           description: Response codes found in [response codes](https://wiki.onap.org/).
20264       parameters:
20265         - name: link-name
20266           in: path
20267           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
20268           required: true
20269           type: string
20270           example: __LINK-NAME__
20271         - name: resource-version
20272           in: query
20273           description: resource-version for concurrency
20274           required: true
20275           type: string
20276   /network/logical-links:
20277     get:
20278       tags:
20279         - Network
20280       summary: returns logical-links
20281       description: returns logical-links
20282       operationId: getNetworkLogicalLinks
20283       produces:
20284         - application/json
20285         - application/xml
20286       responses:
20287         "200":
20288           description: successful operation
20289           schema:
20290               $ref: "#/getDefinitions/logical-links"
20291         "default":
20292           description: Response codes found in [response codes](https://wiki.onap.org/).
20293   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}/relationship-list/relationship:
20294     put:
20295       tags:
20296         - Network
20297       summary: see node definition for valid relationships
20298       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
20299       consumes:
20300         - application/json
20301         - application/xml
20302       produces:
20303         - application/json
20304         - application/xml
20305       responses:
20306         "default":
20307           description: Response codes found in [response codes](https://wiki.onap.org/).
20308       parameters:
20309         - name: site-pair-set-id
20310           in: path
20311           description: Unique id of site pair set.
20312           required: true
20313           type: string
20314           example: __SITE-PAIR-SET-ID__
20315         - name: routing-instance-id
20316           in: path
20317           description: Unique id of routing instance
20318           required: true
20319           type: string
20320           example: __ROUTING-INSTANCE-ID__
20321         - name: site-pair-id
20322           in: path
20323           description: unique identifier of probe
20324           required: true
20325           type: string
20326           example: __SITE-PAIR-ID__
20327         - name: cos
20328           in: path
20329           description: unique identifier of probe
20330           required: true
20331           type: string
20332           example: __COS__
20333         - name: body
20334           in: body
20335           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
20336           required: true
20337           schema:
20338             $ref: "#/definitions/relationship"
20339     delete:
20340       tags:
20341         - Network
20342       summary: delete an existing relationship
20343       description: delete an existing relationship
20344       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
20345       consumes:
20346         - application/json
20347         - application/xml
20348       produces:
20349         - application/json
20350         - application/xml
20351       responses:
20352         "default":
20353           description: Response codes found in [response codes](https://wiki.onap.org/).
20354       parameters:
20355         - name: site-pair-set-id
20356           in: path
20357           description: Unique id of site pair set.
20358           required: true
20359           type: string
20360           example: __SITE-PAIR-SET-ID__
20361         - name: routing-instance-id
20362           in: path
20363           description: Unique id of routing instance
20364           required: true
20365           type: string
20366           example: __ROUTING-INSTANCE-ID__
20367         - name: site-pair-id
20368           in: path
20369           description: unique identifier of probe
20370           required: true
20371           type: string
20372           example: __SITE-PAIR-ID__
20373         - name: cos
20374           in: path
20375           description: unique identifier of probe
20376           required: true
20377           type: string
20378           example: __COS__
20379   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}:
20380     get:
20381       tags:
20382         - Network
20383       summary: returns class-of-service
20384       description: returns class-of-service
20385       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
20386       produces:
20387         - application/json
20388         - application/xml
20389       responses:
20390         "200":
20391           description: successful operation
20392           schema:
20393               $ref: "#/getDefinitions/class-of-service"
20394         "default":
20395           description: Response codes found in [response codes](https://wiki.onap.org/).
20396       parameters:
20397         - name: site-pair-set-id
20398           in: path
20399           description: Unique id of site pair set.
20400           required: true
20401           type: string
20402           example: __SITE-PAIR-SET-ID__
20403         - name: routing-instance-id
20404           in: path
20405           description: Unique id of routing instance
20406           required: true
20407           type: string
20408           example: __ROUTING-INSTANCE-ID__
20409         - name: site-pair-id
20410           in: path
20411           description: unique identifier of probe
20412           required: true
20413           type: string
20414           example: __SITE-PAIR-ID__
20415         - name: cos
20416           in: path
20417           description: unique identifier of probe
20418           required: true
20419           type: string
20420           example: __COS__
20421     put:
20422       tags:
20423         - Network
20424       summary: create or update an existing class-of-service
20425       description: |
20426         Create or update an existing class-of-service.
20427         #
20428         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
20429       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
20430       consumes:
20431         - application/json
20432         - application/xml
20433       produces:
20434         - application/json
20435         - application/xml
20436       responses:
20437         "default":
20438           description: Response codes found in [response codes](https://wiki.onap.org/).
20439       parameters:
20440         - name: site-pair-set-id
20441           in: path
20442           description: Unique id of site pair set.
20443           required: true
20444           type: string
20445           example: __SITE-PAIR-SET-ID__
20446         - name: routing-instance-id
20447           in: path
20448           description: Unique id of routing instance
20449           required: true
20450           type: string
20451           example: __ROUTING-INSTANCE-ID__
20452         - name: site-pair-id
20453           in: path
20454           description: unique identifier of probe
20455           required: true
20456           type: string
20457           example: __SITE-PAIR-ID__
20458         - name: cos
20459           in: path
20460           description: unique identifier of probe
20461           required: true
20462           type: string
20463           example: __COS__
20464         - name: body
20465           in: body
20466           description: class-of-service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
20467           required: true
20468           schema:
20469             $ref: "#/definitions/class-of-service"
20470     patch:
20471       tags:
20472         - Network
20473       summary: update an existing class-of-service
20474       description: |
20475         Update an existing class-of-service
20476         #
20477         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20478         The PUT operation will entirely replace an existing object.
20479         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
20480         #
20481         Other differences between PUT and PATCH are:
20482         #
20483         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
20484         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20485         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20486       operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
20487       consumes:
20488         - application/json
20489         - application/xml
20490       produces:
20491         - application/json
20492         - application/xml
20493       responses:
20494         "default":
20495           description: Response codes found in [response codes](https://wiki.onap.org/).
20496       parameters:
20497         - name: site-pair-set-id
20498           in: path
20499           description: Unique id of site pair set.
20500           required: true
20501           type: string
20502           example: __SITE-PAIR-SET-ID__
20503         - name: routing-instance-id
20504           in: path
20505           description: Unique id of routing instance
20506           required: true
20507           type: string
20508           example: __ROUTING-INSTANCE-ID__
20509         - name: site-pair-id
20510           in: path
20511           description: unique identifier of probe
20512           required: true
20513           type: string
20514           example: __SITE-PAIR-ID__
20515         - name: cos
20516           in: path
20517           description: unique identifier of probe
20518           required: true
20519           type: string
20520           example: __COS__
20521         - name: body
20522           in: body
20523           description: class-of-service object that needs to be created or updated.
20524           required: true
20525           schema:
20526             $ref: "#/patchDefinitions/class-of-service"
20527     delete:
20528       tags:
20529         - Network
20530       summary: delete an existing class-of-service
20531       description: delete an existing class-of-service
20532       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
20533       consumes:
20534         - application/json
20535         - application/xml
20536       produces:
20537         - application/json
20538         - application/xml
20539       responses:
20540         "default":
20541           description: Response codes found in [response codes](https://wiki.onap.org/).
20542       parameters:
20543         - name: site-pair-set-id
20544           in: path
20545           description: Unique id of site pair set.
20546           required: true
20547           type: string
20548           example: __SITE-PAIR-SET-ID__
20549         - name: routing-instance-id
20550           in: path
20551           description: Unique id of routing instance
20552           required: true
20553           type: string
20554           example: __ROUTING-INSTANCE-ID__
20555         - name: site-pair-id
20556           in: path
20557           description: unique identifier of probe
20558           required: true
20559           type: string
20560           example: __SITE-PAIR-ID__
20561         - name: cos
20562           in: path
20563           description: unique identifier of probe
20564           required: true
20565           type: string
20566           example: __COS__
20567         - name: resource-version
20568           in: query
20569           description: resource-version for concurrency
20570           required: true
20571           type: string
20572   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service:
20573     get:
20574       tags:
20575         - Network
20576       summary: returns classes-of-service
20577       description: returns classes-of-service
20578       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfService
20579       produces:
20580         - application/json
20581         - application/xml
20582       responses:
20583         "200":
20584           description: successful operation
20585           schema:
20586               $ref: "#/getDefinitions/classes-of-service"
20587         "default":
20588           description: Response codes found in [response codes](https://wiki.onap.org/).
20589       parameters:
20590         - name: site-pair-set-id
20591           in: path
20592           description: Unique id of site pair set.
20593           required: true
20594           type: string
20595           example: __SITE-PAIR-SET-ID__
20596         - name: routing-instance-id
20597           in: path
20598           description: Unique id of routing instance
20599           required: true
20600           type: string
20601           example: __ROUTING-INSTANCE-ID__
20602         - name: site-pair-id
20603           in: path
20604           description: unique identifier of probe
20605           required: true
20606           type: string
20607           example: __SITE-PAIR-ID__
20608   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/relationship-list/relationship:
20609     put:
20610       tags:
20611         - Network
20612       summary: see node definition for valid relationships
20613       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
20614       consumes:
20615         - application/json
20616         - application/xml
20617       produces:
20618         - application/json
20619         - application/xml
20620       responses:
20621         "default":
20622           description: Response codes found in [response codes](https://wiki.onap.org/).
20623       parameters:
20624         - name: site-pair-set-id
20625           in: path
20626           description: Unique id of site pair set.
20627           required: true
20628           type: string
20629           example: __SITE-PAIR-SET-ID__
20630         - name: routing-instance-id
20631           in: path
20632           description: Unique id of routing instance
20633           required: true
20634           type: string
20635           example: __ROUTING-INSTANCE-ID__
20636         - name: site-pair-id
20637           in: path
20638           description: unique identifier of probe
20639           required: true
20640           type: string
20641           example: __SITE-PAIR-ID__
20642         - name: body
20643           in: body
20644           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
20645           required: true
20646           schema:
20647             $ref: "#/definitions/relationship"
20648     delete:
20649       tags:
20650         - Network
20651       summary: delete an existing relationship
20652       description: delete an existing relationship
20653       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
20654       consumes:
20655         - application/json
20656         - application/xml
20657       produces:
20658         - application/json
20659         - application/xml
20660       responses:
20661         "default":
20662           description: Response codes found in [response codes](https://wiki.onap.org/).
20663       parameters:
20664         - name: site-pair-set-id
20665           in: path
20666           description: Unique id of site pair set.
20667           required: true
20668           type: string
20669           example: __SITE-PAIR-SET-ID__
20670         - name: routing-instance-id
20671           in: path
20672           description: Unique id of routing instance
20673           required: true
20674           type: string
20675           example: __ROUTING-INSTANCE-ID__
20676         - name: site-pair-id
20677           in: path
20678           description: unique identifier of probe
20679           required: true
20680           type: string
20681           example: __SITE-PAIR-ID__
20682   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}:
20683     get:
20684       tags:
20685         - Network
20686       summary: returns site-pair
20687       description: returns site-pair
20688       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
20689       produces:
20690         - application/json
20691         - application/xml
20692       responses:
20693         "200":
20694           description: successful operation
20695           schema:
20696               $ref: "#/getDefinitions/site-pair"
20697         "default":
20698           description: Response codes found in [response codes](https://wiki.onap.org/).
20699       parameters:
20700         - name: site-pair-set-id
20701           in: path
20702           description: Unique id of site pair set.
20703           required: true
20704           type: string
20705           example: __SITE-PAIR-SET-ID__
20706         - name: routing-instance-id
20707           in: path
20708           description: Unique id of routing instance
20709           required: true
20710           type: string
20711           example: __ROUTING-INSTANCE-ID__
20712         - name: site-pair-id
20713           in: path
20714           description: unique identifier of probe
20715           required: true
20716           type: string
20717           example: __SITE-PAIR-ID__
20718     put:
20719       tags:
20720         - Network
20721       summary: create or update an existing site-pair
20722       description: |
20723         Create or update an existing site-pair.
20724         #
20725         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
20726       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
20727       consumes:
20728         - application/json
20729         - application/xml
20730       produces:
20731         - application/json
20732         - application/xml
20733       responses:
20734         "default":
20735           description: Response codes found in [response codes](https://wiki.onap.org/).
20736       parameters:
20737         - name: site-pair-set-id
20738           in: path
20739           description: Unique id of site pair set.
20740           required: true
20741           type: string
20742           example: __SITE-PAIR-SET-ID__
20743         - name: routing-instance-id
20744           in: path
20745           description: Unique id of routing instance
20746           required: true
20747           type: string
20748           example: __ROUTING-INSTANCE-ID__
20749         - name: site-pair-id
20750           in: path
20751           description: unique identifier of probe
20752           required: true
20753           type: string
20754           example: __SITE-PAIR-ID__
20755         - name: body
20756           in: body
20757           description: site-pair object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
20758           required: true
20759           schema:
20760             $ref: "#/definitions/site-pair"
20761     patch:
20762       tags:
20763         - Network
20764       summary: update an existing site-pair
20765       description: |
20766         Update an existing site-pair
20767         #
20768         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20769         The PUT operation will entirely replace an existing object.
20770         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
20771         #
20772         Other differences between PUT and PATCH are:
20773         #
20774         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
20775         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20776         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20777       operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
20778       consumes:
20779         - application/json
20780         - application/xml
20781       produces:
20782         - application/json
20783         - application/xml
20784       responses:
20785         "default":
20786           description: Response codes found in [response codes](https://wiki.onap.org/).
20787       parameters:
20788         - name: site-pair-set-id
20789           in: path
20790           description: Unique id of site pair set.
20791           required: true
20792           type: string
20793           example: __SITE-PAIR-SET-ID__
20794         - name: routing-instance-id
20795           in: path
20796           description: Unique id of routing instance
20797           required: true
20798           type: string
20799           example: __ROUTING-INSTANCE-ID__
20800         - name: site-pair-id
20801           in: path
20802           description: unique identifier of probe
20803           required: true
20804           type: string
20805           example: __SITE-PAIR-ID__
20806         - name: body
20807           in: body
20808           description: site-pair object that needs to be created or updated.
20809           required: true
20810           schema:
20811             $ref: "#/patchDefinitions/site-pair"
20812     delete:
20813       tags:
20814         - Network
20815       summary: delete an existing site-pair
20816       description: delete an existing site-pair
20817       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
20818       consumes:
20819         - application/json
20820         - application/xml
20821       produces:
20822         - application/json
20823         - application/xml
20824       responses:
20825         "default":
20826           description: Response codes found in [response codes](https://wiki.onap.org/).
20827       parameters:
20828         - name: site-pair-set-id
20829           in: path
20830           description: Unique id of site pair set.
20831           required: true
20832           type: string
20833           example: __SITE-PAIR-SET-ID__
20834         - name: routing-instance-id
20835           in: path
20836           description: Unique id of routing instance
20837           required: true
20838           type: string
20839           example: __ROUTING-INSTANCE-ID__
20840         - name: site-pair-id
20841           in: path
20842           description: unique identifier of probe
20843           required: true
20844           type: string
20845           example: __SITE-PAIR-ID__
20846         - name: resource-version
20847           in: query
20848           description: resource-version for concurrency
20849           required: true
20850           type: string
20851   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs:
20852     get:
20853       tags:
20854         - Network
20855       summary: returns site-pairs
20856       description: returns site-pairs
20857       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairs
20858       produces:
20859         - application/json
20860         - application/xml
20861       responses:
20862         "200":
20863           description: successful operation
20864           schema:
20865               $ref: "#/getDefinitions/site-pairs"
20866         "default":
20867           description: Response codes found in [response codes](https://wiki.onap.org/).
20868       parameters:
20869         - name: site-pair-set-id
20870           in: path
20871           description: Unique id of site pair set.
20872           required: true
20873           type: string
20874           example: __SITE-PAIR-SET-ID__
20875         - name: routing-instance-id
20876           in: path
20877           description: Unique id of routing instance
20878           required: true
20879           type: string
20880           example: __ROUTING-INSTANCE-ID__
20881   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship:
20882     put:
20883       tags:
20884         - Network
20885       summary: see node definition for valid relationships
20886       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
20887       consumes:
20888         - application/json
20889         - application/xml
20890       produces:
20891         - application/json
20892         - application/xml
20893       responses:
20894         "default":
20895           description: Response codes found in [response codes](https://wiki.onap.org/).
20896       parameters:
20897         - name: site-pair-set-id
20898           in: path
20899           description: Unique id of site pair set.
20900           required: true
20901           type: string
20902           example: __SITE-PAIR-SET-ID__
20903         - name: routing-instance-id
20904           in: path
20905           description: Unique id of routing instance
20906           required: true
20907           type: string
20908           example: __ROUTING-INSTANCE-ID__
20909         - name: body
20910           in: body
20911           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
20912           required: true
20913           schema:
20914             $ref: "#/definitions/relationship"
20915     delete:
20916       tags:
20917         - Network
20918       summary: delete an existing relationship
20919       description: delete an existing relationship
20920       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
20921       consumes:
20922         - application/json
20923         - application/xml
20924       produces:
20925         - application/json
20926         - application/xml
20927       responses:
20928         "default":
20929           description: Response codes found in [response codes](https://wiki.onap.org/).
20930       parameters:
20931         - name: site-pair-set-id
20932           in: path
20933           description: Unique id of site pair set.
20934           required: true
20935           type: string
20936           example: __SITE-PAIR-SET-ID__
20937         - name: routing-instance-id
20938           in: path
20939           description: Unique id of routing instance
20940           required: true
20941           type: string
20942           example: __ROUTING-INSTANCE-ID__
20943   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}:
20944     get:
20945       tags:
20946         - Network
20947       summary: returns routing-instance
20948       description: returns routing-instance
20949       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
20950       produces:
20951         - application/json
20952         - application/xml
20953       responses:
20954         "200":
20955           description: successful operation
20956           schema:
20957               $ref: "#/getDefinitions/routing-instance"
20958         "default":
20959           description: Response codes found in [response codes](https://wiki.onap.org/).
20960       parameters:
20961         - name: site-pair-set-id
20962           in: path
20963           description: Unique id of site pair set.
20964           required: true
20965           type: string
20966           example: __SITE-PAIR-SET-ID__
20967         - name: routing-instance-id
20968           in: path
20969           description: Unique id of routing instance
20970           required: true
20971           type: string
20972           example: __ROUTING-INSTANCE-ID__
20973     put:
20974       tags:
20975         - Network
20976       summary: create or update an existing routing-instance
20977       description: |
20978         Create or update an existing routing-instance.
20979         #
20980         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
20981       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
20982       consumes:
20983         - application/json
20984         - application/xml
20985       produces:
20986         - application/json
20987         - application/xml
20988       responses:
20989         "default":
20990           description: Response codes found in [response codes](https://wiki.onap.org/).
20991       parameters:
20992         - name: site-pair-set-id
20993           in: path
20994           description: Unique id of site pair set.
20995           required: true
20996           type: string
20997           example: __SITE-PAIR-SET-ID__
20998         - name: routing-instance-id
20999           in: path
21000           description: Unique id of routing instance
21001           required: true
21002           type: string
21003           example: __ROUTING-INSTANCE-ID__
21004         - name: body
21005           in: body
21006           description: routing-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
21007           required: true
21008           schema:
21009             $ref: "#/definitions/routing-instance"
21010     patch:
21011       tags:
21012         - Network
21013       summary: update an existing routing-instance
21014       description: |
21015         Update an existing routing-instance
21016         #
21017         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21018         The PUT operation will entirely replace an existing object.
21019         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
21020         #
21021         Other differences between PUT and PATCH are:
21022         #
21023         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
21024         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21025         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21026       operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
21027       consumes:
21028         - application/json
21029         - application/xml
21030       produces:
21031         - application/json
21032         - application/xml
21033       responses:
21034         "default":
21035           description: Response codes found in [response codes](https://wiki.onap.org/).
21036       parameters:
21037         - name: site-pair-set-id
21038           in: path
21039           description: Unique id of site pair set.
21040           required: true
21041           type: string
21042           example: __SITE-PAIR-SET-ID__
21043         - name: routing-instance-id
21044           in: path
21045           description: Unique id of routing instance
21046           required: true
21047           type: string
21048           example: __ROUTING-INSTANCE-ID__
21049         - name: body
21050           in: body
21051           description: routing-instance object that needs to be created or updated.
21052           required: true
21053           schema:
21054             $ref: "#/patchDefinitions/routing-instance"
21055     delete:
21056       tags:
21057         - Network
21058       summary: delete an existing routing-instance
21059       description: delete an existing routing-instance
21060       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
21061       consumes:
21062         - application/json
21063         - application/xml
21064       produces:
21065         - application/json
21066         - application/xml
21067       responses:
21068         "default":
21069           description: Response codes found in [response codes](https://wiki.onap.org/).
21070       parameters:
21071         - name: site-pair-set-id
21072           in: path
21073           description: Unique id of site pair set.
21074           required: true
21075           type: string
21076           example: __SITE-PAIR-SET-ID__
21077         - name: routing-instance-id
21078           in: path
21079           description: Unique id of routing instance
21080           required: true
21081           type: string
21082           example: __ROUTING-INSTANCE-ID__
21083         - name: resource-version
21084           in: query
21085           description: resource-version for concurrency
21086           required: true
21087           type: string
21088   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances:
21089     get:
21090       tags:
21091         - Network
21092       summary: returns routing-instances
21093       description: returns routing-instances
21094       operationId: getNetworkSitePairSetsSitePairSetRoutingInstances
21095       produces:
21096         - application/json
21097         - application/xml
21098       responses:
21099         "200":
21100           description: successful operation
21101           schema:
21102               $ref: "#/getDefinitions/routing-instances"
21103         "default":
21104           description: Response codes found in [response codes](https://wiki.onap.org/).
21105       parameters:
21106         - name: site-pair-set-id
21107           in: path
21108           description: Unique id of site pair set.
21109           required: true
21110           type: string
21111           example: __SITE-PAIR-SET-ID__
21112   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship:
21113     put:
21114       tags:
21115         - Network
21116       summary: see node definition for valid relationships
21117       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRelationshipListRelationship
21118       consumes:
21119         - application/json
21120         - application/xml
21121       produces:
21122         - application/json
21123         - application/xml
21124       responses:
21125         "default":
21126           description: Response codes found in [response codes](https://wiki.onap.org/).
21127       parameters:
21128         - name: site-pair-set-id
21129           in: path
21130           description: Unique id of site pair set.
21131           required: true
21132           type: string
21133           example: __SITE-PAIR-SET-ID__
21134         - name: body
21135           in: body
21136           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkSitePairSetsSitePairSet.json)
21137           required: true
21138           schema:
21139             $ref: "#/definitions/relationship"
21140     delete:
21141       tags:
21142         - Network
21143       summary: delete an existing relationship
21144       description: delete an existing relationship
21145       operationId: deleteNetworkSitePairSetsSitePairSetRelationshipListRelationship
21146       consumes:
21147         - application/json
21148         - application/xml
21149       produces:
21150         - application/json
21151         - application/xml
21152       responses:
21153         "default":
21154           description: Response codes found in [response codes](https://wiki.onap.org/).
21155       parameters:
21156         - name: site-pair-set-id
21157           in: path
21158           description: Unique id of site pair set.
21159           required: true
21160           type: string
21161           example: __SITE-PAIR-SET-ID__
21162   /network/site-pair-sets/site-pair-set/{site-pair-set-id}:
21163     get:
21164       tags:
21165         - Network
21166       summary: returns site-pair-set
21167       description: returns site-pair-set
21168       operationId: getNetworkSitePairSetsSitePairSet
21169       produces:
21170         - application/json
21171         - application/xml
21172       responses:
21173         "200":
21174           description: successful operation
21175           schema:
21176               $ref: "#/getDefinitions/site-pair-set"
21177         "default":
21178           description: Response codes found in [response codes](https://wiki.onap.org/).
21179       parameters:
21180         - name: site-pair-set-id
21181           in: path
21182           description: Unique id of site pair set.
21183           required: true
21184           type: string
21185           example: __SITE-PAIR-SET-ID__
21186     put:
21187       tags:
21188         - Network
21189       summary: create or update an existing site-pair-set
21190       description: |
21191         Create or update an existing site-pair-set.
21192         #
21193         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
21194       operationId: createOrUpdateNetworkSitePairSetsSitePairSet
21195       consumes:
21196         - application/json
21197         - application/xml
21198       produces:
21199         - application/json
21200         - application/xml
21201       responses:
21202         "default":
21203           description: Response codes found in [response codes](https://wiki.onap.org/).
21204       parameters:
21205         - name: site-pair-set-id
21206           in: path
21207           description: Unique id of site pair set.
21208           required: true
21209           type: string
21210           example: __SITE-PAIR-SET-ID__
21211         - name: body
21212           in: body
21213           description: site-pair-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkSitePairSetsSitePairSet.json)
21214           required: true
21215           schema:
21216             $ref: "#/definitions/site-pair-set"
21217     patch:
21218       tags:
21219         - Network
21220       summary: update an existing site-pair-set
21221       description: |
21222         Update an existing site-pair-set
21223         #
21224         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21225         The PUT operation will entirely replace an existing object.
21226         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
21227         #
21228         Other differences between PUT and PATCH are:
21229         #
21230         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
21231         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21232         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21233       operationId: UpdateNetworkSitePairSetsSitePairSet
21234       consumes:
21235         - application/json
21236         - application/xml
21237       produces:
21238         - application/json
21239         - application/xml
21240       responses:
21241         "default":
21242           description: Response codes found in [response codes](https://wiki.onap.org/).
21243       parameters:
21244         - name: site-pair-set-id
21245           in: path
21246           description: Unique id of site pair set.
21247           required: true
21248           type: string
21249           example: __SITE-PAIR-SET-ID__
21250         - name: body
21251           in: body
21252           description: site-pair-set object that needs to be created or updated.
21253           required: true
21254           schema:
21255             $ref: "#/patchDefinitions/site-pair-set"
21256     delete:
21257       tags:
21258         - Network
21259       summary: delete an existing site-pair-set
21260       description: delete an existing site-pair-set
21261       operationId: deleteNetworkSitePairSetsSitePairSet
21262       consumes:
21263         - application/json
21264         - application/xml
21265       produces:
21266         - application/json
21267         - application/xml
21268       responses:
21269         "default":
21270           description: Response codes found in [response codes](https://wiki.onap.org/).
21271       parameters:
21272         - name: site-pair-set-id
21273           in: path
21274           description: Unique id of site pair set.
21275           required: true
21276           type: string
21277           example: __SITE-PAIR-SET-ID__
21278         - name: resource-version
21279           in: query
21280           description: resource-version for concurrency
21281           required: true
21282           type: string
21283   /network/site-pair-sets:
21284     get:
21285       tags:
21286         - Network
21287       summary: returns site-pair-sets
21288       description: returns site-pair-sets
21289       operationId: getNetworkSitePairSets
21290       produces:
21291         - application/json
21292         - application/xml
21293       responses:
21294         "200":
21295           description: successful operation
21296           schema:
21297               $ref: "#/getDefinitions/site-pair-sets"
21298         "default":
21299           description: Response codes found in [response codes](https://wiki.onap.org/).
21300   /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship:
21301     put:
21302       tags:
21303         - Network
21304       summary: see node definition for valid relationships
21305       operationId: createOrUpdateNetworkVpnBindingsVpnBindingRelationshipListRelationship
21306       consumes:
21307         - application/json
21308         - application/xml
21309       produces:
21310         - application/json
21311         - application/xml
21312       responses:
21313         "default":
21314           description: Response codes found in [response codes](https://wiki.onap.org/).
21315       parameters:
21316         - name: vpn-id
21317           in: path
21318           description: VPN ID, globally unique within A&AI
21319           required: true
21320           type: string
21321           example: __VPN-ID__
21322         - name: body
21323           in: body
21324           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVpnBindingsVpnBinding.json)
21325           required: true
21326           schema:
21327             $ref: "#/definitions/relationship"
21328     delete:
21329       tags:
21330         - Network
21331       summary: delete an existing relationship
21332       description: delete an existing relationship
21333       operationId: deleteNetworkVpnBindingsVpnBindingRelationshipListRelationship
21334       consumes:
21335         - application/json
21336         - application/xml
21337       produces:
21338         - application/json
21339         - application/xml
21340       responses:
21341         "default":
21342           description: Response codes found in [response codes](https://wiki.onap.org/).
21343       parameters:
21344         - name: vpn-id
21345           in: path
21346           description: VPN ID, globally unique within A&AI
21347           required: true
21348           type: string
21349           example: __VPN-ID__
21350   /network/vpn-bindings/vpn-binding/{vpn-id}:
21351     get:
21352       tags:
21353         - Network
21354       summary: returns vpn-binding
21355       description: returns vpn-binding
21356       operationId: getNetworkVpnBindingsVpnBinding
21357       produces:
21358         - application/json
21359         - application/xml
21360       responses:
21361         "200":
21362           description: successful operation
21363           schema:
21364               $ref: "#/getDefinitions/vpn-binding"
21365         "default":
21366           description: Response codes found in [response codes](https://wiki.onap.org/).
21367       parameters:
21368         - name: vpn-id
21369           in: path
21370           description: VPN ID, globally unique within A&AI
21371           required: true
21372           type: string
21373           example: __VPN-ID__
21374         - name: vpn-name
21375           in: query
21376           description: VPN Name
21377           required: false
21378           type: string
21379         - name: global-route-target
21380           in: query
21381           description: Number used to identify a VPN, globally unique in the network
21382           required: false
21383           type: string
21384         - name: vpn-type
21385           in: query
21386           description: Type of the vpn, should be taken from enumerated/valid values
21387           required: false
21388           type: string
21389     put:
21390       tags:
21391         - Network
21392       summary: create or update an existing vpn-binding
21393       description: |
21394         Create or update an existing vpn-binding.
21395         #
21396         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
21397       operationId: createOrUpdateNetworkVpnBindingsVpnBinding
21398       consumes:
21399         - application/json
21400         - application/xml
21401       produces:
21402         - application/json
21403         - application/xml
21404       responses:
21405         "default":
21406           description: Response codes found in [response codes](https://wiki.onap.org/).
21407       parameters:
21408         - name: vpn-id
21409           in: path
21410           description: VPN ID, globally unique within A&AI
21411           required: true
21412           type: string
21413           example: __VPN-ID__
21414         - name: body
21415           in: body
21416           description: vpn-binding object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVpnBindingsVpnBinding.json)
21417           required: true
21418           schema:
21419             $ref: "#/definitions/vpn-binding"
21420     patch:
21421       tags:
21422         - Network
21423       summary: update an existing vpn-binding
21424       description: |
21425         Update an existing vpn-binding
21426         #
21427         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21428         The PUT operation will entirely replace an existing object.
21429         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
21430         #
21431         Other differences between PUT and PATCH are:
21432         #
21433         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
21434         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21435         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21436       operationId: UpdateNetworkVpnBindingsVpnBinding
21437       consumes:
21438         - application/json
21439         - application/xml
21440       produces:
21441         - application/json
21442         - application/xml
21443       responses:
21444         "default":
21445           description: Response codes found in [response codes](https://wiki.onap.org/).
21446       parameters:
21447         - name: vpn-id
21448           in: path
21449           description: VPN ID, globally unique within A&AI
21450           required: true
21451           type: string
21452           example: __VPN-ID__
21453         - name: body
21454           in: body
21455           description: vpn-binding object that needs to be created or updated.
21456           required: true
21457           schema:
21458             $ref: "#/patchDefinitions/vpn-binding"
21459     delete:
21460       tags:
21461         - Network
21462       summary: delete an existing vpn-binding
21463       description: delete an existing vpn-binding
21464       operationId: deleteNetworkVpnBindingsVpnBinding
21465       consumes:
21466         - application/json
21467         - application/xml
21468       produces:
21469         - application/json
21470         - application/xml
21471       responses:
21472         "default":
21473           description: Response codes found in [response codes](https://wiki.onap.org/).
21474       parameters:
21475         - name: vpn-id
21476           in: path
21477           description: VPN ID, globally unique within A&AI
21478           required: true
21479           type: string
21480           example: __VPN-ID__
21481         - name: resource-version
21482           in: query
21483           description: resource-version for concurrency
21484           required: true
21485           type: string
21486   /network/vpn-bindings:
21487     get:
21488       tags:
21489         - Network
21490       summary: returns vpn-bindings
21491       description: returns vpn-bindings
21492       operationId: getNetworkVpnBindings
21493       produces:
21494         - application/json
21495         - application/xml
21496       responses:
21497         "200":
21498           description: successful operation
21499           schema:
21500               $ref: "#/getDefinitions/vpn-bindings"
21501         "default":
21502           description: Response codes found in [response codes](https://wiki.onap.org/).
21503   /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship:
21504     put:
21505       tags:
21506         - Network
21507       summary: see node definition for valid relationships
21508       operationId: createOrUpdateNetworkVplsPesVplsPeRelationshipListRelationship
21509       consumes:
21510         - application/json
21511         - application/xml
21512       produces:
21513         - application/json
21514         - application/xml
21515       responses:
21516         "default":
21517           description: Response codes found in [response codes](https://wiki.onap.org/).
21518       parameters:
21519         - name: equipment-name
21520           in: path
21521           required: true
21522           type: string
21523           example: __EQUIPMENT-NAME__
21524         - name: body
21525           in: body
21526           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPe.json)
21527           required: true
21528           schema:
21529             $ref: "#/definitions/relationship"
21530     delete:
21531       tags:
21532         - Network
21533       summary: delete an existing relationship
21534       description: delete an existing relationship
21535       operationId: deleteNetworkVplsPesVplsPeRelationshipListRelationship
21536       consumes:
21537         - application/json
21538         - application/xml
21539       produces:
21540         - application/json
21541         - application/xml
21542       responses:
21543         "default":
21544           description: Response codes found in [response codes](https://wiki.onap.org/).
21545       parameters:
21546         - name: equipment-name
21547           in: path
21548           required: true
21549           type: string
21550           example: __EQUIPMENT-NAME__
21551   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
21552     put:
21553       tags:
21554         - Network
21555       summary: see node definition for valid relationships
21556       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
21557       consumes:
21558         - application/json
21559         - application/xml
21560       produces:
21561         - application/json
21562         - application/xml
21563       responses:
21564         "default":
21565           description: Response codes found in [response codes](https://wiki.onap.org/).
21566       parameters:
21567         - name: equipment-name
21568           in: path
21569           required: true
21570           type: string
21571           example: __EQUIPMENT-NAME__
21572         - name: interface-name
21573           in: path
21574           description: Name that identifies the physical interface
21575           required: true
21576           type: string
21577           example: __INTERFACE-NAME__
21578         - name: body
21579           in: body
21580           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterface.json)
21581           required: true
21582           schema:
21583             $ref: "#/definitions/relationship"
21584     delete:
21585       tags:
21586         - Network
21587       summary: delete an existing relationship
21588       description: delete an existing relationship
21589       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
21590       consumes:
21591         - application/json
21592         - application/xml
21593       produces:
21594         - application/json
21595         - application/xml
21596       responses:
21597         "default":
21598           description: Response codes found in [response codes](https://wiki.onap.org/).
21599       parameters:
21600         - name: equipment-name
21601           in: path
21602           required: true
21603           type: string
21604           example: __EQUIPMENT-NAME__
21605         - name: interface-name
21606           in: path
21607           description: Name that identifies the physical interface
21608           required: true
21609           type: string
21610           example: __INTERFACE-NAME__
21611   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
21612     put:
21613       tags:
21614         - Network
21615       summary: see node definition for valid relationships
21616       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
21617       consumes:
21618         - application/json
21619         - application/xml
21620       produces:
21621         - application/json
21622         - application/xml
21623       responses:
21624         "default":
21625           description: Response codes found in [response codes](https://wiki.onap.org/).
21626       parameters:
21627         - name: equipment-name
21628           in: path
21629           required: true
21630           type: string
21631           example: __EQUIPMENT-NAME__
21632         - name: interface-name
21633           in: path
21634           description: Name that identifies the physical interface
21635           required: true
21636           type: string
21637           example: __INTERFACE-NAME__
21638         - name: interface-name
21639           in: path
21640           description: Name given to the interface
21641           required: true
21642           type: string
21643           example: __INTERFACE-NAME__
21644         - name: vlan-interface
21645           in: path
21646           description: String that identifies the interface
21647           required: true
21648           type: string
21649           example: __VLAN-INTERFACE__
21650         - name: body
21651           in: body
21652           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
21653           required: true
21654           schema:
21655             $ref: "#/definitions/relationship"
21656     delete:
21657       tags:
21658         - Network
21659       summary: delete an existing relationship
21660       description: delete an existing relationship
21661       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
21662       consumes:
21663         - application/json
21664         - application/xml
21665       produces:
21666         - application/json
21667         - application/xml
21668       responses:
21669         "default":
21670           description: Response codes found in [response codes](https://wiki.onap.org/).
21671       parameters:
21672         - name: equipment-name
21673           in: path
21674           required: true
21675           type: string
21676           example: __EQUIPMENT-NAME__
21677         - name: interface-name
21678           in: path
21679           description: Name that identifies the physical interface
21680           required: true
21681           type: string
21682           example: __INTERFACE-NAME__
21683         - name: interface-name
21684           in: path
21685           description: Name given to the interface
21686           required: true
21687           type: string
21688           example: __INTERFACE-NAME__
21689         - name: vlan-interface
21690           in: path
21691           description: String that identifies the interface
21692           required: true
21693           type: string
21694           example: __VLAN-INTERFACE__
21695   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
21696     put:
21697       tags:
21698         - Network
21699       summary: see node definition for valid relationships
21700       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
21701       consumes:
21702         - application/json
21703         - application/xml
21704       produces:
21705         - application/json
21706         - application/xml
21707       responses:
21708         "default":
21709           description: Response codes found in [response codes](https://wiki.onap.org/).
21710       parameters:
21711         - name: equipment-name
21712           in: path
21713           required: true
21714           type: string
21715           example: __EQUIPMENT-NAME__
21716         - name: interface-name
21717           in: path
21718           description: Name that identifies the physical interface
21719           required: true
21720           type: string
21721           example: __INTERFACE-NAME__
21722         - name: interface-name
21723           in: path
21724           description: Name given to the interface
21725           required: true
21726           type: string
21727           example: __INTERFACE-NAME__
21728         - name: vlan-interface
21729           in: path
21730           description: String that identifies the interface
21731           required: true
21732           type: string
21733           example: __VLAN-INTERFACE__
21734         - name: l3-interface-ipv4-address
21735           in: path
21736           description: IP address
21737           required: true
21738           type: string
21739           example: __L3-INTERFACE-IPV4-ADDRESS__
21740         - name: body
21741           in: body
21742           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
21743           required: true
21744           schema:
21745             $ref: "#/definitions/relationship"
21746     delete:
21747       tags:
21748         - Network
21749       summary: delete an existing relationship
21750       description: delete an existing relationship
21751       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
21752       consumes:
21753         - application/json
21754         - application/xml
21755       produces:
21756         - application/json
21757         - application/xml
21758       responses:
21759         "default":
21760           description: Response codes found in [response codes](https://wiki.onap.org/).
21761       parameters:
21762         - name: equipment-name
21763           in: path
21764           required: true
21765           type: string
21766           example: __EQUIPMENT-NAME__
21767         - name: interface-name
21768           in: path
21769           description: Name that identifies the physical interface
21770           required: true
21771           type: string
21772           example: __INTERFACE-NAME__
21773         - name: interface-name
21774           in: path
21775           description: Name given to the interface
21776           required: true
21777           type: string
21778           example: __INTERFACE-NAME__
21779         - name: vlan-interface
21780           in: path
21781           description: String that identifies the interface
21782           required: true
21783           type: string
21784           example: __VLAN-INTERFACE__
21785         - name: l3-interface-ipv4-address
21786           in: path
21787           description: IP address
21788           required: true
21789           type: string
21790           example: __L3-INTERFACE-IPV4-ADDRESS__
21791   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
21792     get:
21793       tags:
21794         - Network
21795       summary: returns l3-interface-ipv4-address-list
21796       description: returns l3-interface-ipv4-address-list
21797       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
21798       produces:
21799         - application/json
21800         - application/xml
21801       responses:
21802         "200":
21803           description: successful operation
21804           schema:
21805               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
21806         "default":
21807           description: Response codes found in [response codes](https://wiki.onap.org/).
21808       parameters:
21809         - name: equipment-name
21810           in: path
21811           required: true
21812           type: string
21813           example: __EQUIPMENT-NAME__
21814         - name: interface-name
21815           in: path
21816           description: Name that identifies the physical interface
21817           required: true
21818           type: string
21819           example: __INTERFACE-NAME__
21820         - name: interface-name
21821           in: path
21822           description: Name given to the interface
21823           required: true
21824           type: string
21825           example: __INTERFACE-NAME__
21826         - name: vlan-interface
21827           in: path
21828           description: String that identifies the interface
21829           required: true
21830           type: string
21831           example: __VLAN-INTERFACE__
21832         - name: l3-interface-ipv4-address
21833           in: path
21834           description: IP address
21835           required: true
21836           type: string
21837           example: __L3-INTERFACE-IPV4-ADDRESS__
21838         - name: prov-status
21839           in: query
21840           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
21841           required: false
21842           type: string
21843         - name: prov-status
21844           in: query
21845           description: Trigger for operational monitoring of this resource by Service Assurance systems.
21846           required: false
21847           type: string
21848         - name: interface-id
21849           in: query
21850           description: ID of interface
21851           required: false
21852           type: string
21853         - name: macaddr
21854           in: query
21855           description: MAC address for the interface
21856           required: false
21857           type: string
21858         - name: network-name
21859           in: query
21860           description: Name of the network
21861           required: false
21862           type: string
21863         - name: vlan-id-inner
21864           in: query
21865           description: Inner VLAN tag
21866           required: false
21867           type: integer
21868           format: int64
21869         - name: vpn-id
21870           in: query
21871           description: This indicates the customers VPN ID associated with this vlan
21872           required: false
21873           type: string
21874         - name: vlan-id-inner
21875           in: query
21876           description: Inner VLAN tag
21877           required: false
21878           type: integer
21879           format: int64
21880         - name: neutron-network-id
21881           in: query
21882           description: Neutron network id of the interface that address belongs to
21883           required: false
21884           type: string
21885         - name: neutron-subnet-id
21886           in: query
21887           description: Neutron id of subnet that address belongs to
21888           required: false
21889           type: string
21890     put:
21891       tags:
21892         - Network
21893       summary: create or update an existing l3-interface-ipv4-address-list
21894       description: |
21895         Create or update an existing l3-interface-ipv4-address-list.
21896         #
21897         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
21898       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
21899       consumes:
21900         - application/json
21901         - application/xml
21902       produces:
21903         - application/json
21904         - application/xml
21905       responses:
21906         "default":
21907           description: Response codes found in [response codes](https://wiki.onap.org/).
21908       parameters:
21909         - name: equipment-name
21910           in: path
21911           required: true
21912           type: string
21913           example: __EQUIPMENT-NAME__
21914         - name: interface-name
21915           in: path
21916           description: Name that identifies the physical interface
21917           required: true
21918           type: string
21919           example: __INTERFACE-NAME__
21920         - name: interface-name
21921           in: path
21922           description: Name given to the interface
21923           required: true
21924           type: string
21925           example: __INTERFACE-NAME__
21926         - name: vlan-interface
21927           in: path
21928           description: String that identifies the interface
21929           required: true
21930           type: string
21931           example: __VLAN-INTERFACE__
21932         - name: l3-interface-ipv4-address
21933           in: path
21934           description: IP address
21935           required: true
21936           type: string
21937           example: __L3-INTERFACE-IPV4-ADDRESS__
21938         - name: body
21939           in: body
21940           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
21941           required: true
21942           schema:
21943             $ref: "#/definitions/l3-interface-ipv4-address-list"
21944     patch:
21945       tags:
21946         - Network
21947       summary: update an existing l3-interface-ipv4-address-list
21948       description: |
21949         Update an existing l3-interface-ipv4-address-list
21950         #
21951         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21952         The PUT operation will entirely replace an existing object.
21953         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
21954         #
21955         Other differences between PUT and PATCH are:
21956         #
21957         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
21958         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21959         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21960       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
21961       consumes:
21962         - application/json
21963         - application/xml
21964       produces:
21965         - application/json
21966         - application/xml
21967       responses:
21968         "default":
21969           description: Response codes found in [response codes](https://wiki.onap.org/).
21970       parameters:
21971         - name: equipment-name
21972           in: path
21973           required: true
21974           type: string
21975           example: __EQUIPMENT-NAME__
21976         - name: interface-name
21977           in: path
21978           description: Name that identifies the physical interface
21979           required: true
21980           type: string
21981           example: __INTERFACE-NAME__
21982         - name: interface-name
21983           in: path
21984           description: Name given to the interface
21985           required: true
21986           type: string
21987           example: __INTERFACE-NAME__
21988         - name: vlan-interface
21989           in: path
21990           description: String that identifies the interface
21991           required: true
21992           type: string
21993           example: __VLAN-INTERFACE__
21994         - name: l3-interface-ipv4-address
21995           in: path
21996           description: IP address
21997           required: true
21998           type: string
21999           example: __L3-INTERFACE-IPV4-ADDRESS__
22000         - name: body
22001           in: body
22002           description: l3-interface-ipv4-address-list object that needs to be created or updated.
22003           required: true
22004           schema:
22005             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
22006     delete:
22007       tags:
22008         - Network
22009       summary: delete an existing l3-interface-ipv4-address-list
22010       description: delete an existing l3-interface-ipv4-address-list
22011       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
22012       consumes:
22013         - application/json
22014         - application/xml
22015       produces:
22016         - application/json
22017         - application/xml
22018       responses:
22019         "default":
22020           description: Response codes found in [response codes](https://wiki.onap.org/).
22021       parameters:
22022         - name: equipment-name
22023           in: path
22024           required: true
22025           type: string
22026           example: __EQUIPMENT-NAME__
22027         - name: interface-name
22028           in: path
22029           description: Name that identifies the physical interface
22030           required: true
22031           type: string
22032           example: __INTERFACE-NAME__
22033         - name: interface-name
22034           in: path
22035           description: Name given to the interface
22036           required: true
22037           type: string
22038           example: __INTERFACE-NAME__
22039         - name: vlan-interface
22040           in: path
22041           description: String that identifies the interface
22042           required: true
22043           type: string
22044           example: __VLAN-INTERFACE__
22045         - name: l3-interface-ipv4-address
22046           in: path
22047           description: IP address
22048           required: true
22049           type: string
22050           example: __L3-INTERFACE-IPV4-ADDRESS__
22051         - name: resource-version
22052           in: query
22053           description: resource-version for concurrency
22054           required: true
22055           type: string
22056   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
22057     put:
22058       tags:
22059         - Network
22060       summary: see node definition for valid relationships
22061       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
22062       consumes:
22063         - application/json
22064         - application/xml
22065       produces:
22066         - application/json
22067         - application/xml
22068       responses:
22069         "default":
22070           description: Response codes found in [response codes](https://wiki.onap.org/).
22071       parameters:
22072         - name: equipment-name
22073           in: path
22074           required: true
22075           type: string
22076           example: __EQUIPMENT-NAME__
22077         - name: interface-name
22078           in: path
22079           description: Name that identifies the physical interface
22080           required: true
22081           type: string
22082           example: __INTERFACE-NAME__
22083         - name: interface-name
22084           in: path
22085           description: Name given to the interface
22086           required: true
22087           type: string
22088           example: __INTERFACE-NAME__
22089         - name: vlan-interface
22090           in: path
22091           description: String that identifies the interface
22092           required: true
22093           type: string
22094           example: __VLAN-INTERFACE__
22095         - name: l3-interface-ipv6-address
22096           in: path
22097           description: IP address
22098           required: true
22099           type: string
22100           example: __L3-INTERFACE-IPV6-ADDRESS__
22101         - name: body
22102           in: body
22103           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
22104           required: true
22105           schema:
22106             $ref: "#/definitions/relationship"
22107     delete:
22108       tags:
22109         - Network
22110       summary: delete an existing relationship
22111       description: delete an existing relationship
22112       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
22113       consumes:
22114         - application/json
22115         - application/xml
22116       produces:
22117         - application/json
22118         - application/xml
22119       responses:
22120         "default":
22121           description: Response codes found in [response codes](https://wiki.onap.org/).
22122       parameters:
22123         - name: equipment-name
22124           in: path
22125           required: true
22126           type: string
22127           example: __EQUIPMENT-NAME__
22128         - name: interface-name
22129           in: path
22130           description: Name that identifies the physical interface
22131           required: true
22132           type: string
22133           example: __INTERFACE-NAME__
22134         - name: interface-name
22135           in: path
22136           description: Name given to the interface
22137           required: true
22138           type: string
22139           example: __INTERFACE-NAME__
22140         - name: vlan-interface
22141           in: path
22142           description: String that identifies the interface
22143           required: true
22144           type: string
22145           example: __VLAN-INTERFACE__
22146         - name: l3-interface-ipv6-address
22147           in: path
22148           description: IP address
22149           required: true
22150           type: string
22151           example: __L3-INTERFACE-IPV6-ADDRESS__
22152   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
22153     get:
22154       tags:
22155         - Network
22156       summary: returns l3-interface-ipv6-address-list
22157       description: returns l3-interface-ipv6-address-list
22158       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
22159       produces:
22160         - application/json
22161         - application/xml
22162       responses:
22163         "200":
22164           description: successful operation
22165           schema:
22166               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
22167         "default":
22168           description: Response codes found in [response codes](https://wiki.onap.org/).
22169       parameters:
22170         - name: equipment-name
22171           in: path
22172           required: true
22173           type: string
22174           example: __EQUIPMENT-NAME__
22175         - name: interface-name
22176           in: path
22177           description: Name that identifies the physical interface
22178           required: true
22179           type: string
22180           example: __INTERFACE-NAME__
22181         - name: interface-name
22182           in: path
22183           description: Name given to the interface
22184           required: true
22185           type: string
22186           example: __INTERFACE-NAME__
22187         - name: vlan-interface
22188           in: path
22189           description: String that identifies the interface
22190           required: true
22191           type: string
22192           example: __VLAN-INTERFACE__
22193         - name: l3-interface-ipv6-address
22194           in: path
22195           description: IP address
22196           required: true
22197           type: string
22198           example: __L3-INTERFACE-IPV6-ADDRESS__
22199         - name: prov-status
22200           in: query
22201           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
22202           required: false
22203           type: string
22204         - name: prov-status
22205           in: query
22206           description: Trigger for operational monitoring of this resource by Service Assurance systems.
22207           required: false
22208           type: string
22209         - name: interface-id
22210           in: query
22211           description: ID of interface
22212           required: false
22213           type: string
22214         - name: macaddr
22215           in: query
22216           description: MAC address for the interface
22217           required: false
22218           type: string
22219         - name: network-name
22220           in: query
22221           description: Name of the network
22222           required: false
22223           type: string
22224         - name: vlan-id-inner
22225           in: query
22226           description: Inner VLAN tag
22227           required: false
22228           type: integer
22229           format: int64
22230         - name: vpn-id
22231           in: query
22232           description: This indicates the customers VPN ID associated with this vlan
22233           required: false
22234           type: string
22235         - name: vlan-id-inner
22236           in: query
22237           description: Inner VLAN tag
22238           required: false
22239           type: integer
22240           format: int64
22241         - name: neutron-network-id
22242           in: query
22243           description: Neutron network id of the interface that address belongs to
22244           required: false
22245           type: string
22246         - name: neutron-subnet-id
22247           in: query
22248           description: Neutron id of subnet that address belongs to
22249           required: false
22250           type: string
22251     put:
22252       tags:
22253         - Network
22254       summary: create or update an existing l3-interface-ipv6-address-list
22255       description: |
22256         Create or update an existing l3-interface-ipv6-address-list.
22257         #
22258         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
22259       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
22260       consumes:
22261         - application/json
22262         - application/xml
22263       produces:
22264         - application/json
22265         - application/xml
22266       responses:
22267         "default":
22268           description: Response codes found in [response codes](https://wiki.onap.org/).
22269       parameters:
22270         - name: equipment-name
22271           in: path
22272           required: true
22273           type: string
22274           example: __EQUIPMENT-NAME__
22275         - name: interface-name
22276           in: path
22277           description: Name that identifies the physical interface
22278           required: true
22279           type: string
22280           example: __INTERFACE-NAME__
22281         - name: interface-name
22282           in: path
22283           description: Name given to the interface
22284           required: true
22285           type: string
22286           example: __INTERFACE-NAME__
22287         - name: vlan-interface
22288           in: path
22289           description: String that identifies the interface
22290           required: true
22291           type: string
22292           example: __VLAN-INTERFACE__
22293         - name: l3-interface-ipv6-address
22294           in: path
22295           description: IP address
22296           required: true
22297           type: string
22298           example: __L3-INTERFACE-IPV6-ADDRESS__
22299         - name: body
22300           in: body
22301           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
22302           required: true
22303           schema:
22304             $ref: "#/definitions/l3-interface-ipv6-address-list"
22305     patch:
22306       tags:
22307         - Network
22308       summary: update an existing l3-interface-ipv6-address-list
22309       description: |
22310         Update an existing l3-interface-ipv6-address-list
22311         #
22312         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22313         The PUT operation will entirely replace an existing object.
22314         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
22315         #
22316         Other differences between PUT and PATCH are:
22317         #
22318         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22319         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22320         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22321       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
22322       consumes:
22323         - application/json
22324         - application/xml
22325       produces:
22326         - application/json
22327         - application/xml
22328       responses:
22329         "default":
22330           description: Response codes found in [response codes](https://wiki.onap.org/).
22331       parameters:
22332         - name: equipment-name
22333           in: path
22334           required: true
22335           type: string
22336           example: __EQUIPMENT-NAME__
22337         - name: interface-name
22338           in: path
22339           description: Name that identifies the physical interface
22340           required: true
22341           type: string
22342           example: __INTERFACE-NAME__
22343         - name: interface-name
22344           in: path
22345           description: Name given to the interface
22346           required: true
22347           type: string
22348           example: __INTERFACE-NAME__
22349         - name: vlan-interface
22350           in: path
22351           description: String that identifies the interface
22352           required: true
22353           type: string
22354           example: __VLAN-INTERFACE__
22355         - name: l3-interface-ipv6-address
22356           in: path
22357           description: IP address
22358           required: true
22359           type: string
22360           example: __L3-INTERFACE-IPV6-ADDRESS__
22361         - name: body
22362           in: body
22363           description: l3-interface-ipv6-address-list object that needs to be created or updated.
22364           required: true
22365           schema:
22366             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
22367     delete:
22368       tags:
22369         - Network
22370       summary: delete an existing l3-interface-ipv6-address-list
22371       description: delete an existing l3-interface-ipv6-address-list
22372       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
22373       consumes:
22374         - application/json
22375         - application/xml
22376       produces:
22377         - application/json
22378         - application/xml
22379       responses:
22380         "default":
22381           description: Response codes found in [response codes](https://wiki.onap.org/).
22382       parameters:
22383         - name: equipment-name
22384           in: path
22385           required: true
22386           type: string
22387           example: __EQUIPMENT-NAME__
22388         - name: interface-name
22389           in: path
22390           description: Name that identifies the physical interface
22391           required: true
22392           type: string
22393           example: __INTERFACE-NAME__
22394         - name: interface-name
22395           in: path
22396           description: Name given to the interface
22397           required: true
22398           type: string
22399           example: __INTERFACE-NAME__
22400         - name: vlan-interface
22401           in: path
22402           description: String that identifies the interface
22403           required: true
22404           type: string
22405           example: __VLAN-INTERFACE__
22406         - name: l3-interface-ipv6-address
22407           in: path
22408           description: IP address
22409           required: true
22410           type: string
22411           example: __L3-INTERFACE-IPV6-ADDRESS__
22412         - name: resource-version
22413           in: query
22414           description: resource-version for concurrency
22415           required: true
22416           type: string
22417   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
22418     get:
22419       tags:
22420         - Network
22421       summary: returns vlan
22422       description: returns vlan
22423       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
22424       produces:
22425         - application/json
22426         - application/xml
22427       responses:
22428         "200":
22429           description: successful operation
22430           schema:
22431               $ref: "#/getDefinitions/vlan"
22432         "default":
22433           description: Response codes found in [response codes](https://wiki.onap.org/).
22434       parameters:
22435         - name: equipment-name
22436           in: path
22437           required: true
22438           type: string
22439           example: __EQUIPMENT-NAME__
22440         - name: interface-name
22441           in: path
22442           description: Name that identifies the physical interface
22443           required: true
22444           type: string
22445           example: __INTERFACE-NAME__
22446         - name: interface-name
22447           in: path
22448           description: Name given to the interface
22449           required: true
22450           type: string
22451           example: __INTERFACE-NAME__
22452         - name: vlan-interface
22453           in: path
22454           description: String that identifies the interface
22455           required: true
22456           type: string
22457           example: __VLAN-INTERFACE__
22458         - name: prov-status
22459           in: query
22460           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
22461           required: false
22462           type: string
22463         - name: prov-status
22464           in: query
22465           description: Trigger for operational monitoring of this resource by Service Assurance systems.
22466           required: false
22467           type: string
22468         - name: interface-id
22469           in: query
22470           description: ID of interface
22471           required: false
22472           type: string
22473         - name: macaddr
22474           in: query
22475           description: MAC address for the interface
22476           required: false
22477           type: string
22478         - name: network-name
22479           in: query
22480           description: Name of the network
22481           required: false
22482           type: string
22483         - name: vlan-id-inner
22484           in: query
22485           description: Inner VLAN tag
22486           required: false
22487           type: integer
22488           format: int64
22489         - name: vpn-id
22490           in: query
22491           description: This indicates the customers VPN ID associated with this vlan
22492           required: false
22493           type: string
22494     put:
22495       tags:
22496         - Network
22497       summary: create or update an existing vlan
22498       description: |
22499         Create or update an existing vlan.
22500         #
22501         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
22502       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
22503       consumes:
22504         - application/json
22505         - application/xml
22506       produces:
22507         - application/json
22508         - application/xml
22509       responses:
22510         "default":
22511           description: Response codes found in [response codes](https://wiki.onap.org/).
22512       parameters:
22513         - name: equipment-name
22514           in: path
22515           required: true
22516           type: string
22517           example: __EQUIPMENT-NAME__
22518         - name: interface-name
22519           in: path
22520           description: Name that identifies the physical interface
22521           required: true
22522           type: string
22523           example: __INTERFACE-NAME__
22524         - name: interface-name
22525           in: path
22526           description: Name given to the interface
22527           required: true
22528           type: string
22529           example: __INTERFACE-NAME__
22530         - name: vlan-interface
22531           in: path
22532           description: String that identifies the interface
22533           required: true
22534           type: string
22535           example: __VLAN-INTERFACE__
22536         - name: body
22537           in: body
22538           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
22539           required: true
22540           schema:
22541             $ref: "#/definitions/vlan"
22542     patch:
22543       tags:
22544         - Network
22545       summary: update an existing vlan
22546       description: |
22547         Update an existing vlan
22548         #
22549         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22550         The PUT operation will entirely replace an existing object.
22551         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
22552         #
22553         Other differences between PUT and PATCH are:
22554         #
22555         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22556         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22557         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22558       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
22559       consumes:
22560         - application/json
22561         - application/xml
22562       produces:
22563         - application/json
22564         - application/xml
22565       responses:
22566         "default":
22567           description: Response codes found in [response codes](https://wiki.onap.org/).
22568       parameters:
22569         - name: equipment-name
22570           in: path
22571           required: true
22572           type: string
22573           example: __EQUIPMENT-NAME__
22574         - name: interface-name
22575           in: path
22576           description: Name that identifies the physical interface
22577           required: true
22578           type: string
22579           example: __INTERFACE-NAME__
22580         - name: interface-name
22581           in: path
22582           description: Name given to the interface
22583           required: true
22584           type: string
22585           example: __INTERFACE-NAME__
22586         - name: vlan-interface
22587           in: path
22588           description: String that identifies the interface
22589           required: true
22590           type: string
22591           example: __VLAN-INTERFACE__
22592         - name: body
22593           in: body
22594           description: vlan object that needs to be created or updated.
22595           required: true
22596           schema:
22597             $ref: "#/patchDefinitions/vlan"
22598     delete:
22599       tags:
22600         - Network
22601       summary: delete an existing vlan
22602       description: delete an existing vlan
22603       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
22604       consumes:
22605         - application/json
22606         - application/xml
22607       produces:
22608         - application/json
22609         - application/xml
22610       responses:
22611         "default":
22612           description: Response codes found in [response codes](https://wiki.onap.org/).
22613       parameters:
22614         - name: equipment-name
22615           in: path
22616           required: true
22617           type: string
22618           example: __EQUIPMENT-NAME__
22619         - name: interface-name
22620           in: path
22621           description: Name that identifies the physical interface
22622           required: true
22623           type: string
22624           example: __INTERFACE-NAME__
22625         - name: interface-name
22626           in: path
22627           description: Name given to the interface
22628           required: true
22629           type: string
22630           example: __INTERFACE-NAME__
22631         - name: vlan-interface
22632           in: path
22633           description: String that identifies the interface
22634           required: true
22635           type: string
22636           example: __VLAN-INTERFACE__
22637         - name: resource-version
22638           in: query
22639           description: resource-version for concurrency
22640           required: true
22641           type: string
22642   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
22643     get:
22644       tags:
22645         - Network
22646       summary: returns vlans
22647       description: returns vlans
22648       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlans
22649       produces:
22650         - application/json
22651         - application/xml
22652       responses:
22653         "200":
22654           description: successful operation
22655           schema:
22656               $ref: "#/getDefinitions/vlans"
22657         "default":
22658           description: Response codes found in [response codes](https://wiki.onap.org/).
22659       parameters:
22660         - name: equipment-name
22661           in: path
22662           required: true
22663           type: string
22664           example: __EQUIPMENT-NAME__
22665         - name: interface-name
22666           in: path
22667           description: Name that identifies the physical interface
22668           required: true
22669           type: string
22670           example: __INTERFACE-NAME__
22671         - name: interface-name
22672           in: path
22673           description: Name given to the interface
22674           required: true
22675           type: string
22676           example: __INTERFACE-NAME__
22677         - name: prov-status
22678           in: query
22679           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
22680           required: false
22681           type: string
22682         - name: prov-status
22683           in: query
22684           description: Trigger for operational monitoring of this resource by Service Assurance systems.
22685           required: false
22686           type: string
22687         - name: interface-id
22688           in: query
22689           description: ID of interface
22690           required: false
22691           type: string
22692         - name: macaddr
22693           in: query
22694           description: MAC address for the interface
22695           required: false
22696           type: string
22697         - name: network-name
22698           in: query
22699           description: Name of the network
22700           required: false
22701           type: string
22702   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
22703     put:
22704       tags:
22705         - Network
22706       summary: see node definition for valid relationships
22707       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
22708       consumes:
22709         - application/json
22710         - application/xml
22711       produces:
22712         - application/json
22713         - application/xml
22714       responses:
22715         "default":
22716           description: Response codes found in [response codes](https://wiki.onap.org/).
22717       parameters:
22718         - name: equipment-name
22719           in: path
22720           required: true
22721           type: string
22722           example: __EQUIPMENT-NAME__
22723         - name: interface-name
22724           in: path
22725           description: Name that identifies the physical interface
22726           required: true
22727           type: string
22728           example: __INTERFACE-NAME__
22729         - name: interface-name
22730           in: path
22731           description: Name given to the interface
22732           required: true
22733           type: string
22734           example: __INTERFACE-NAME__
22735         - name: pci-id
22736           in: path
22737           description: PCI ID used to identify the sriov-vf
22738           required: true
22739           type: string
22740           example: __PCI-ID__
22741         - name: body
22742           in: body
22743           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
22744           required: true
22745           schema:
22746             $ref: "#/definitions/relationship"
22747     delete:
22748       tags:
22749         - Network
22750       summary: delete an existing relationship
22751       description: delete an existing relationship
22752       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
22753       consumes:
22754         - application/json
22755         - application/xml
22756       produces:
22757         - application/json
22758         - application/xml
22759       responses:
22760         "default":
22761           description: Response codes found in [response codes](https://wiki.onap.org/).
22762       parameters:
22763         - name: equipment-name
22764           in: path
22765           required: true
22766           type: string
22767           example: __EQUIPMENT-NAME__
22768         - name: interface-name
22769           in: path
22770           description: Name that identifies the physical interface
22771           required: true
22772           type: string
22773           example: __INTERFACE-NAME__
22774         - name: interface-name
22775           in: path
22776           description: Name given to the interface
22777           required: true
22778           type: string
22779           example: __INTERFACE-NAME__
22780         - name: pci-id
22781           in: path
22782           description: PCI ID used to identify the sriov-vf
22783           required: true
22784           type: string
22785           example: __PCI-ID__
22786   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
22787     get:
22788       tags:
22789         - Network
22790       summary: returns sriov-vf
22791       description: returns sriov-vf
22792       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
22793       produces:
22794         - application/json
22795         - application/xml
22796       responses:
22797         "200":
22798           description: successful operation
22799           schema:
22800               $ref: "#/getDefinitions/sriov-vf"
22801         "default":
22802           description: Response codes found in [response codes](https://wiki.onap.org/).
22803       parameters:
22804         - name: equipment-name
22805           in: path
22806           required: true
22807           type: string
22808           example: __EQUIPMENT-NAME__
22809         - name: interface-name
22810           in: path
22811           description: Name that identifies the physical interface
22812           required: true
22813           type: string
22814           example: __INTERFACE-NAME__
22815         - name: interface-name
22816           in: path
22817           description: Name given to the interface
22818           required: true
22819           type: string
22820           example: __INTERFACE-NAME__
22821         - name: pci-id
22822           in: path
22823           description: PCI ID used to identify the sriov-vf
22824           required: true
22825           type: string
22826           example: __PCI-ID__
22827         - name: prov-status
22828           in: query
22829           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
22830           required: false
22831           type: string
22832         - name: prov-status
22833           in: query
22834           description: Trigger for operational monitoring of this resource by Service Assurance systems.
22835           required: false
22836           type: string
22837         - name: interface-id
22838           in: query
22839           description: ID of interface
22840           required: false
22841           type: string
22842         - name: macaddr
22843           in: query
22844           description: MAC address for the interface
22845           required: false
22846           type: string
22847         - name: network-name
22848           in: query
22849           description: Name of the network
22850           required: false
22851           type: string
22852         - name: vf-vlan-filter
22853           in: query
22854           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
22855           required: false
22856           type: string
22857         - name: vf-mac-filter
22858           in: query
22859           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
22860           required: false
22861           type: string
22862         - name: vf-vlan-strip
22863           in: query
22864           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
22865           required: false
22866           type: boolean
22867         - name: neutron-network-id
22868           in: query
22869           description: Neutron network id of the interface
22870           required: false
22871           type: string
22872     put:
22873       tags:
22874         - Network
22875       summary: create or update an existing sriov-vf
22876       description: |
22877         Create or update an existing sriov-vf.
22878         #
22879         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
22880       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
22881       consumes:
22882         - application/json
22883         - application/xml
22884       produces:
22885         - application/json
22886         - application/xml
22887       responses:
22888         "default":
22889           description: Response codes found in [response codes](https://wiki.onap.org/).
22890       parameters:
22891         - name: equipment-name
22892           in: path
22893           required: true
22894           type: string
22895           example: __EQUIPMENT-NAME__
22896         - name: interface-name
22897           in: path
22898           description: Name that identifies the physical interface
22899           required: true
22900           type: string
22901           example: __INTERFACE-NAME__
22902         - name: interface-name
22903           in: path
22904           description: Name given to the interface
22905           required: true
22906           type: string
22907           example: __INTERFACE-NAME__
22908         - name: pci-id
22909           in: path
22910           description: PCI ID used to identify the sriov-vf
22911           required: true
22912           type: string
22913           example: __PCI-ID__
22914         - name: body
22915           in: body
22916           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
22917           required: true
22918           schema:
22919             $ref: "#/definitions/sriov-vf"
22920     patch:
22921       tags:
22922         - Network
22923       summary: update an existing sriov-vf
22924       description: |
22925         Update an existing sriov-vf
22926         #
22927         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22928         The PUT operation will entirely replace an existing object.
22929         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
22930         #
22931         Other differences between PUT and PATCH are:
22932         #
22933         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22934         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22935         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22936       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
22937       consumes:
22938         - application/json
22939         - application/xml
22940       produces:
22941         - application/json
22942         - application/xml
22943       responses:
22944         "default":
22945           description: Response codes found in [response codes](https://wiki.onap.org/).
22946       parameters:
22947         - name: equipment-name
22948           in: path
22949           required: true
22950           type: string
22951           example: __EQUIPMENT-NAME__
22952         - name: interface-name
22953           in: path
22954           description: Name that identifies the physical interface
22955           required: true
22956           type: string
22957           example: __INTERFACE-NAME__
22958         - name: interface-name
22959           in: path
22960           description: Name given to the interface
22961           required: true
22962           type: string
22963           example: __INTERFACE-NAME__
22964         - name: pci-id
22965           in: path
22966           description: PCI ID used to identify the sriov-vf
22967           required: true
22968           type: string
22969           example: __PCI-ID__
22970         - name: body
22971           in: body
22972           description: sriov-vf object that needs to be created or updated.
22973           required: true
22974           schema:
22975             $ref: "#/patchDefinitions/sriov-vf"
22976     delete:
22977       tags:
22978         - Network
22979       summary: delete an existing sriov-vf
22980       description: delete an existing sriov-vf
22981       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
22982       consumes:
22983         - application/json
22984         - application/xml
22985       produces:
22986         - application/json
22987         - application/xml
22988       responses:
22989         "default":
22990           description: Response codes found in [response codes](https://wiki.onap.org/).
22991       parameters:
22992         - name: equipment-name
22993           in: path
22994           required: true
22995           type: string
22996           example: __EQUIPMENT-NAME__
22997         - name: interface-name
22998           in: path
22999           description: Name that identifies the physical interface
23000           required: true
23001           type: string
23002           example: __INTERFACE-NAME__
23003         - name: interface-name
23004           in: path
23005           description: Name given to the interface
23006           required: true
23007           type: string
23008           example: __INTERFACE-NAME__
23009         - name: pci-id
23010           in: path
23011           description: PCI ID used to identify the sriov-vf
23012           required: true
23013           type: string
23014           example: __PCI-ID__
23015         - name: resource-version
23016           in: query
23017           description: resource-version for concurrency
23018           required: true
23019           type: string
23020   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
23021     get:
23022       tags:
23023         - Network
23024       summary: returns sriov-vfs
23025       description: returns sriov-vfs
23026       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
23027       produces:
23028         - application/json
23029         - application/xml
23030       responses:
23031         "200":
23032           description: successful operation
23033           schema:
23034               $ref: "#/getDefinitions/sriov-vfs"
23035         "default":
23036           description: Response codes found in [response codes](https://wiki.onap.org/).
23037       parameters:
23038         - name: equipment-name
23039           in: path
23040           required: true
23041           type: string
23042           example: __EQUIPMENT-NAME__
23043         - name: interface-name
23044           in: path
23045           description: Name that identifies the physical interface
23046           required: true
23047           type: string
23048           example: __INTERFACE-NAME__
23049         - name: interface-name
23050           in: path
23051           description: Name given to the interface
23052           required: true
23053           type: string
23054           example: __INTERFACE-NAME__
23055         - name: prov-status
23056           in: query
23057           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
23058           required: false
23059           type: string
23060         - name: prov-status
23061           in: query
23062           description: Trigger for operational monitoring of this resource by Service Assurance systems.
23063           required: false
23064           type: string
23065         - name: interface-id
23066           in: query
23067           description: ID of interface
23068           required: false
23069           type: string
23070         - name: macaddr
23071           in: query
23072           description: MAC address for the interface
23073           required: false
23074           type: string
23075         - name: network-name
23076           in: query
23077           description: Name of the network
23078           required: false
23079           type: string
23080   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
23081     put:
23082       tags:
23083         - Network
23084       summary: see node definition for valid relationships
23085       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
23086       consumes:
23087         - application/json
23088         - application/xml
23089       produces:
23090         - application/json
23091         - application/xml
23092       responses:
23093         "default":
23094           description: Response codes found in [response codes](https://wiki.onap.org/).
23095       parameters:
23096         - name: equipment-name
23097           in: path
23098           required: true
23099           type: string
23100           example: __EQUIPMENT-NAME__
23101         - name: interface-name
23102           in: path
23103           description: Name that identifies the physical interface
23104           required: true
23105           type: string
23106           example: __INTERFACE-NAME__
23107         - name: interface-name
23108           in: path
23109           description: Name given to the interface
23110           required: true
23111           type: string
23112           example: __INTERFACE-NAME__
23113         - name: body
23114           in: body
23115           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
23116           required: true
23117           schema:
23118             $ref: "#/definitions/relationship"
23119     delete:
23120       tags:
23121         - Network
23122       summary: delete an existing relationship
23123       description: delete an existing relationship
23124       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
23125       consumes:
23126         - application/json
23127         - application/xml
23128       produces:
23129         - application/json
23130         - application/xml
23131       responses:
23132         "default":
23133           description: Response codes found in [response codes](https://wiki.onap.org/).
23134       parameters:
23135         - name: equipment-name
23136           in: path
23137           required: true
23138           type: string
23139           example: __EQUIPMENT-NAME__
23140         - name: interface-name
23141           in: path
23142           description: Name that identifies the physical interface
23143           required: true
23144           type: string
23145           example: __INTERFACE-NAME__
23146         - name: interface-name
23147           in: path
23148           description: Name given to the interface
23149           required: true
23150           type: string
23151           example: __INTERFACE-NAME__
23152   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
23153     put:
23154       tags:
23155         - Network
23156       summary: see node definition for valid relationships
23157       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
23158       consumes:
23159         - application/json
23160         - application/xml
23161       produces:
23162         - application/json
23163         - application/xml
23164       responses:
23165         "default":
23166           description: Response codes found in [response codes](https://wiki.onap.org/).
23167       parameters:
23168         - name: equipment-name
23169           in: path
23170           required: true
23171           type: string
23172           example: __EQUIPMENT-NAME__
23173         - name: interface-name
23174           in: path
23175           description: Name that identifies the physical interface
23176           required: true
23177           type: string
23178           example: __INTERFACE-NAME__
23179         - name: interface-name
23180           in: path
23181           description: Name given to the interface
23182           required: true
23183           type: string
23184           example: __INTERFACE-NAME__
23185         - name: l3-interface-ipv4-address
23186           in: path
23187           description: IP address
23188           required: true
23189           type: string
23190           example: __L3-INTERFACE-IPV4-ADDRESS__
23191         - name: body
23192           in: body
23193           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
23194           required: true
23195           schema:
23196             $ref: "#/definitions/relationship"
23197     delete:
23198       tags:
23199         - Network
23200       summary: delete an existing relationship
23201       description: delete an existing relationship
23202       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
23203       consumes:
23204         - application/json
23205         - application/xml
23206       produces:
23207         - application/json
23208         - application/xml
23209       responses:
23210         "default":
23211           description: Response codes found in [response codes](https://wiki.onap.org/).
23212       parameters:
23213         - name: equipment-name
23214           in: path
23215           required: true
23216           type: string
23217           example: __EQUIPMENT-NAME__
23218         - name: interface-name
23219           in: path
23220           description: Name that identifies the physical interface
23221           required: true
23222           type: string
23223           example: __INTERFACE-NAME__
23224         - name: interface-name
23225           in: path
23226           description: Name given to the interface
23227           required: true
23228           type: string
23229           example: __INTERFACE-NAME__
23230         - name: l3-interface-ipv4-address
23231           in: path
23232           description: IP address
23233           required: true
23234           type: string
23235           example: __L3-INTERFACE-IPV4-ADDRESS__
23236   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
23237     get:
23238       tags:
23239         - Network
23240       summary: returns l3-interface-ipv4-address-list
23241       description: returns l3-interface-ipv4-address-list
23242       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
23243       produces:
23244         - application/json
23245         - application/xml
23246       responses:
23247         "200":
23248           description: successful operation
23249           schema:
23250               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
23251         "default":
23252           description: Response codes found in [response codes](https://wiki.onap.org/).
23253       parameters:
23254         - name: equipment-name
23255           in: path
23256           required: true
23257           type: string
23258           example: __EQUIPMENT-NAME__
23259         - name: interface-name
23260           in: path
23261           description: Name that identifies the physical interface
23262           required: true
23263           type: string
23264           example: __INTERFACE-NAME__
23265         - name: interface-name
23266           in: path
23267           description: Name given to the interface
23268           required: true
23269           type: string
23270           example: __INTERFACE-NAME__
23271         - name: l3-interface-ipv4-address
23272           in: path
23273           description: IP address
23274           required: true
23275           type: string
23276           example: __L3-INTERFACE-IPV4-ADDRESS__
23277         - name: prov-status
23278           in: query
23279           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
23280           required: false
23281           type: string
23282         - name: prov-status
23283           in: query
23284           description: Trigger for operational monitoring of this resource by Service Assurance systems.
23285           required: false
23286           type: string
23287         - name: interface-id
23288           in: query
23289           description: ID of interface
23290           required: false
23291           type: string
23292         - name: macaddr
23293           in: query
23294           description: MAC address for the interface
23295           required: false
23296           type: string
23297         - name: network-name
23298           in: query
23299           description: Name of the network
23300           required: false
23301           type: string
23302         - name: vlan-id-inner
23303           in: query
23304           description: Inner VLAN tag
23305           required: false
23306           type: integer
23307           format: int64
23308         - name: neutron-network-id
23309           in: query
23310           description: Neutron network id of the interface that address belongs to
23311           required: false
23312           type: string
23313         - name: neutron-subnet-id
23314           in: query
23315           description: Neutron id of subnet that address belongs to
23316           required: false
23317           type: string
23318     put:
23319       tags:
23320         - Network
23321       summary: create or update an existing l3-interface-ipv4-address-list
23322       description: |
23323         Create or update an existing l3-interface-ipv4-address-list.
23324         #
23325         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
23326       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
23327       consumes:
23328         - application/json
23329         - application/xml
23330       produces:
23331         - application/json
23332         - application/xml
23333       responses:
23334         "default":
23335           description: Response codes found in [response codes](https://wiki.onap.org/).
23336       parameters:
23337         - name: equipment-name
23338           in: path
23339           required: true
23340           type: string
23341           example: __EQUIPMENT-NAME__
23342         - name: interface-name
23343           in: path
23344           description: Name that identifies the physical interface
23345           required: true
23346           type: string
23347           example: __INTERFACE-NAME__
23348         - name: interface-name
23349           in: path
23350           description: Name given to the interface
23351           required: true
23352           type: string
23353           example: __INTERFACE-NAME__
23354         - name: l3-interface-ipv4-address
23355           in: path
23356           description: IP address
23357           required: true
23358           type: string
23359           example: __L3-INTERFACE-IPV4-ADDRESS__
23360         - name: body
23361           in: body
23362           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
23363           required: true
23364           schema:
23365             $ref: "#/definitions/l3-interface-ipv4-address-list"
23366     patch:
23367       tags:
23368         - Network
23369       summary: update an existing l3-interface-ipv4-address-list
23370       description: |
23371         Update an existing l3-interface-ipv4-address-list
23372         #
23373         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23374         The PUT operation will entirely replace an existing object.
23375         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
23376         #
23377         Other differences between PUT and PATCH are:
23378         #
23379         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
23380         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23381         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23382       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
23383       consumes:
23384         - application/json
23385         - application/xml
23386       produces:
23387         - application/json
23388         - application/xml
23389       responses:
23390         "default":
23391           description: Response codes found in [response codes](https://wiki.onap.org/).
23392       parameters:
23393         - name: equipment-name
23394           in: path
23395           required: true
23396           type: string
23397           example: __EQUIPMENT-NAME__
23398         - name: interface-name
23399           in: path
23400           description: Name that identifies the physical interface
23401           required: true
23402           type: string
23403           example: __INTERFACE-NAME__
23404         - name: interface-name
23405           in: path
23406           description: Name given to the interface
23407           required: true
23408           type: string
23409           example: __INTERFACE-NAME__
23410         - name: l3-interface-ipv4-address
23411           in: path
23412           description: IP address
23413           required: true
23414           type: string
23415           example: __L3-INTERFACE-IPV4-ADDRESS__
23416         - name: body
23417           in: body
23418           description: l3-interface-ipv4-address-list object that needs to be created or updated.
23419           required: true
23420           schema:
23421             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
23422     delete:
23423       tags:
23424         - Network
23425       summary: delete an existing l3-interface-ipv4-address-list
23426       description: delete an existing l3-interface-ipv4-address-list
23427       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
23428       consumes:
23429         - application/json
23430         - application/xml
23431       produces:
23432         - application/json
23433         - application/xml
23434       responses:
23435         "default":
23436           description: Response codes found in [response codes](https://wiki.onap.org/).
23437       parameters:
23438         - name: equipment-name
23439           in: path
23440           required: true
23441           type: string
23442           example: __EQUIPMENT-NAME__
23443         - name: interface-name
23444           in: path
23445           description: Name that identifies the physical interface
23446           required: true
23447           type: string
23448           example: __INTERFACE-NAME__
23449         - name: interface-name
23450           in: path
23451           description: Name given to the interface
23452           required: true
23453           type: string
23454           example: __INTERFACE-NAME__
23455         - name: l3-interface-ipv4-address
23456           in: path
23457           description: IP address
23458           required: true
23459           type: string
23460           example: __L3-INTERFACE-IPV4-ADDRESS__
23461         - name: resource-version
23462           in: query
23463           description: resource-version for concurrency
23464           required: true
23465           type: string
23466   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
23467     put:
23468       tags:
23469         - Network
23470       summary: see node definition for valid relationships
23471       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
23472       consumes:
23473         - application/json
23474         - application/xml
23475       produces:
23476         - application/json
23477         - application/xml
23478       responses:
23479         "default":
23480           description: Response codes found in [response codes](https://wiki.onap.org/).
23481       parameters:
23482         - name: equipment-name
23483           in: path
23484           required: true
23485           type: string
23486           example: __EQUIPMENT-NAME__
23487         - name: interface-name
23488           in: path
23489           description: Name that identifies the physical interface
23490           required: true
23491           type: string
23492           example: __INTERFACE-NAME__
23493         - name: interface-name
23494           in: path
23495           description: Name given to the interface
23496           required: true
23497           type: string
23498           example: __INTERFACE-NAME__
23499         - name: l3-interface-ipv6-address
23500           in: path
23501           description: IP address
23502           required: true
23503           type: string
23504           example: __L3-INTERFACE-IPV6-ADDRESS__
23505         - name: body
23506           in: body
23507           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
23508           required: true
23509           schema:
23510             $ref: "#/definitions/relationship"
23511     delete:
23512       tags:
23513         - Network
23514       summary: delete an existing relationship
23515       description: delete an existing relationship
23516       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
23517       consumes:
23518         - application/json
23519         - application/xml
23520       produces:
23521         - application/json
23522         - application/xml
23523       responses:
23524         "default":
23525           description: Response codes found in [response codes](https://wiki.onap.org/).
23526       parameters:
23527         - name: equipment-name
23528           in: path
23529           required: true
23530           type: string
23531           example: __EQUIPMENT-NAME__
23532         - name: interface-name
23533           in: path
23534           description: Name that identifies the physical interface
23535           required: true
23536           type: string
23537           example: __INTERFACE-NAME__
23538         - name: interface-name
23539           in: path
23540           description: Name given to the interface
23541           required: true
23542           type: string
23543           example: __INTERFACE-NAME__
23544         - name: l3-interface-ipv6-address
23545           in: path
23546           description: IP address
23547           required: true
23548           type: string
23549           example: __L3-INTERFACE-IPV6-ADDRESS__
23550   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
23551     get:
23552       tags:
23553         - Network
23554       summary: returns l3-interface-ipv6-address-list
23555       description: returns l3-interface-ipv6-address-list
23556       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
23557       produces:
23558         - application/json
23559         - application/xml
23560       responses:
23561         "200":
23562           description: successful operation
23563           schema:
23564               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
23565         "default":
23566           description: Response codes found in [response codes](https://wiki.onap.org/).
23567       parameters:
23568         - name: equipment-name
23569           in: path
23570           required: true
23571           type: string
23572           example: __EQUIPMENT-NAME__
23573         - name: interface-name
23574           in: path
23575           description: Name that identifies the physical interface
23576           required: true
23577           type: string
23578           example: __INTERFACE-NAME__
23579         - name: interface-name
23580           in: path
23581           description: Name given to the interface
23582           required: true
23583           type: string
23584           example: __INTERFACE-NAME__
23585         - name: l3-interface-ipv6-address
23586           in: path
23587           description: IP address
23588           required: true
23589           type: string
23590           example: __L3-INTERFACE-IPV6-ADDRESS__
23591         - name: prov-status
23592           in: query
23593           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
23594           required: false
23595           type: string
23596         - name: prov-status
23597           in: query
23598           description: Trigger for operational monitoring of this resource by Service Assurance systems.
23599           required: false
23600           type: string
23601         - name: interface-id
23602           in: query
23603           description: ID of interface
23604           required: false
23605           type: string
23606         - name: macaddr
23607           in: query
23608           description: MAC address for the interface
23609           required: false
23610           type: string
23611         - name: network-name
23612           in: query
23613           description: Name of the network
23614           required: false
23615           type: string
23616         - name: vlan-id-inner
23617           in: query
23618           description: Inner VLAN tag
23619           required: false
23620           type: integer
23621           format: int64
23622         - name: neutron-network-id
23623           in: query
23624           description: Neutron network id of the interface that address belongs to
23625           required: false
23626           type: string
23627         - name: neutron-subnet-id
23628           in: query
23629           description: Neutron id of subnet that address belongs to
23630           required: false
23631           type: string
23632     put:
23633       tags:
23634         - Network
23635       summary: create or update an existing l3-interface-ipv6-address-list
23636       description: |
23637         Create or update an existing l3-interface-ipv6-address-list.
23638         #
23639         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
23640       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
23641       consumes:
23642         - application/json
23643         - application/xml
23644       produces:
23645         - application/json
23646         - application/xml
23647       responses:
23648         "default":
23649           description: Response codes found in [response codes](https://wiki.onap.org/).
23650       parameters:
23651         - name: equipment-name
23652           in: path
23653           required: true
23654           type: string
23655           example: __EQUIPMENT-NAME__
23656         - name: interface-name
23657           in: path
23658           description: Name that identifies the physical interface
23659           required: true
23660           type: string
23661           example: __INTERFACE-NAME__
23662         - name: interface-name
23663           in: path
23664           description: Name given to the interface
23665           required: true
23666           type: string
23667           example: __INTERFACE-NAME__
23668         - name: l3-interface-ipv6-address
23669           in: path
23670           description: IP address
23671           required: true
23672           type: string
23673           example: __L3-INTERFACE-IPV6-ADDRESS__
23674         - name: body
23675           in: body
23676           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
23677           required: true
23678           schema:
23679             $ref: "#/definitions/l3-interface-ipv6-address-list"
23680     patch:
23681       tags:
23682         - Network
23683       summary: update an existing l3-interface-ipv6-address-list
23684       description: |
23685         Update an existing l3-interface-ipv6-address-list
23686         #
23687         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23688         The PUT operation will entirely replace an existing object.
23689         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
23690         #
23691         Other differences between PUT and PATCH are:
23692         #
23693         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
23694         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23695         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23696       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
23697       consumes:
23698         - application/json
23699         - application/xml
23700       produces:
23701         - application/json
23702         - application/xml
23703       responses:
23704         "default":
23705           description: Response codes found in [response codes](https://wiki.onap.org/).
23706       parameters:
23707         - name: equipment-name
23708           in: path
23709           required: true
23710           type: string
23711           example: __EQUIPMENT-NAME__
23712         - name: interface-name
23713           in: path
23714           description: Name that identifies the physical interface
23715           required: true
23716           type: string
23717           example: __INTERFACE-NAME__
23718         - name: interface-name
23719           in: path
23720           description: Name given to the interface
23721           required: true
23722           type: string
23723           example: __INTERFACE-NAME__
23724         - name: l3-interface-ipv6-address
23725           in: path
23726           description: IP address
23727           required: true
23728           type: string
23729           example: __L3-INTERFACE-IPV6-ADDRESS__
23730         - name: body
23731           in: body
23732           description: l3-interface-ipv6-address-list object that needs to be created or updated.
23733           required: true
23734           schema:
23735             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
23736     delete:
23737       tags:
23738         - Network
23739       summary: delete an existing l3-interface-ipv6-address-list
23740       description: delete an existing l3-interface-ipv6-address-list
23741       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
23742       consumes:
23743         - application/json
23744         - application/xml
23745       produces:
23746         - application/json
23747         - application/xml
23748       responses:
23749         "default":
23750           description: Response codes found in [response codes](https://wiki.onap.org/).
23751       parameters:
23752         - name: equipment-name
23753           in: path
23754           required: true
23755           type: string
23756           example: __EQUIPMENT-NAME__
23757         - name: interface-name
23758           in: path
23759           description: Name that identifies the physical interface
23760           required: true
23761           type: string
23762           example: __INTERFACE-NAME__
23763         - name: interface-name
23764           in: path
23765           description: Name given to the interface
23766           required: true
23767           type: string
23768           example: __INTERFACE-NAME__
23769         - name: l3-interface-ipv6-address
23770           in: path
23771           description: IP address
23772           required: true
23773           type: string
23774           example: __L3-INTERFACE-IPV6-ADDRESS__
23775         - name: resource-version
23776           in: query
23777           description: resource-version for concurrency
23778           required: true
23779           type: string
23780   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
23781     get:
23782       tags:
23783         - Network
23784       summary: returns l-interface
23785       description: returns l-interface
23786       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
23787       produces:
23788         - application/json
23789         - application/xml
23790       responses:
23791         "200":
23792           description: successful operation
23793           schema:
23794               $ref: "#/getDefinitions/l-interface"
23795         "default":
23796           description: Response codes found in [response codes](https://wiki.onap.org/).
23797       parameters:
23798         - name: equipment-name
23799           in: path
23800           required: true
23801           type: string
23802           example: __EQUIPMENT-NAME__
23803         - name: interface-name
23804           in: path
23805           description: Name that identifies the physical interface
23806           required: true
23807           type: string
23808           example: __INTERFACE-NAME__
23809         - name: interface-name
23810           in: path
23811           description: Name given to the interface
23812           required: true
23813           type: string
23814           example: __INTERFACE-NAME__
23815         - name: prov-status
23816           in: query
23817           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
23818           required: false
23819           type: string
23820         - name: prov-status
23821           in: query
23822           description: Trigger for operational monitoring of this resource by Service Assurance systems.
23823           required: false
23824           type: string
23825         - name: interface-id
23826           in: query
23827           description: ID of interface
23828           required: false
23829           type: string
23830         - name: macaddr
23831           in: query
23832           description: MAC address for the interface
23833           required: false
23834           type: string
23835         - name: network-name
23836           in: query
23837           description: Name of the network
23838           required: false
23839           type: string
23840     put:
23841       tags:
23842         - Network
23843       summary: create or update an existing l-interface
23844       description: |
23845         Create or update an existing l-interface.
23846         #
23847         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
23848       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
23849       consumes:
23850         - application/json
23851         - application/xml
23852       produces:
23853         - application/json
23854         - application/xml
23855       responses:
23856         "default":
23857           description: Response codes found in [response codes](https://wiki.onap.org/).
23858       parameters:
23859         - name: equipment-name
23860           in: path
23861           required: true
23862           type: string
23863           example: __EQUIPMENT-NAME__
23864         - name: interface-name
23865           in: path
23866           description: Name that identifies the physical interface
23867           required: true
23868           type: string
23869           example: __INTERFACE-NAME__
23870         - name: interface-name
23871           in: path
23872           description: Name given to the interface
23873           required: true
23874           type: string
23875           example: __INTERFACE-NAME__
23876         - name: body
23877           in: body
23878           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
23879           required: true
23880           schema:
23881             $ref: "#/definitions/l-interface"
23882     patch:
23883       tags:
23884         - Network
23885       summary: update an existing l-interface
23886       description: |
23887         Update an existing l-interface
23888         #
23889         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23890         The PUT operation will entirely replace an existing object.
23891         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
23892         #
23893         Other differences between PUT and PATCH are:
23894         #
23895         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
23896         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23897         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23898       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
23899       consumes:
23900         - application/json
23901         - application/xml
23902       produces:
23903         - application/json
23904         - application/xml
23905       responses:
23906         "default":
23907           description: Response codes found in [response codes](https://wiki.onap.org/).
23908       parameters:
23909         - name: equipment-name
23910           in: path
23911           required: true
23912           type: string
23913           example: __EQUIPMENT-NAME__
23914         - name: interface-name
23915           in: path
23916           description: Name that identifies the physical interface
23917           required: true
23918           type: string
23919           example: __INTERFACE-NAME__
23920         - name: interface-name
23921           in: path
23922           description: Name given to the interface
23923           required: true
23924           type: string
23925           example: __INTERFACE-NAME__
23926         - name: body
23927           in: body
23928           description: l-interface object that needs to be created or updated.
23929           required: true
23930           schema:
23931             $ref: "#/patchDefinitions/l-interface"
23932     delete:
23933       tags:
23934         - Network
23935       summary: delete an existing l-interface
23936       description: delete an existing l-interface
23937       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
23938       consumes:
23939         - application/json
23940         - application/xml
23941       produces:
23942         - application/json
23943         - application/xml
23944       responses:
23945         "default":
23946           description: Response codes found in [response codes](https://wiki.onap.org/).
23947       parameters:
23948         - name: equipment-name
23949           in: path
23950           required: true
23951           type: string
23952           example: __EQUIPMENT-NAME__
23953         - name: interface-name
23954           in: path
23955           description: Name that identifies the physical interface
23956           required: true
23957           type: string
23958           example: __INTERFACE-NAME__
23959         - name: interface-name
23960           in: path
23961           description: Name given to the interface
23962           required: true
23963           type: string
23964           example: __INTERFACE-NAME__
23965         - name: resource-version
23966           in: query
23967           description: resource-version for concurrency
23968           required: true
23969           type: string
23970   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
23971     get:
23972       tags:
23973         - Network
23974       summary: returns l-interfaces
23975       description: returns l-interfaces
23976       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfaces
23977       produces:
23978         - application/json
23979         - application/xml
23980       responses:
23981         "200":
23982           description: successful operation
23983           schema:
23984               $ref: "#/getDefinitions/l-interfaces"
23985         "default":
23986           description: Response codes found in [response codes](https://wiki.onap.org/).
23987       parameters:
23988         - name: equipment-name
23989           in: path
23990           required: true
23991           type: string
23992           example: __EQUIPMENT-NAME__
23993         - name: interface-name
23994           in: path
23995           description: Name that identifies the physical interface
23996           required: true
23997           type: string
23998           example: __INTERFACE-NAME__
23999         - name: prov-status
24000           in: query
24001           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
24002           required: false
24003           type: string
24004         - name: prov-status
24005           in: query
24006           description: Trigger for operational monitoring of this resource by Service Assurance systems.
24007           required: false
24008           type: string
24009   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}:
24010     get:
24011       tags:
24012         - Network
24013       summary: returns p-interface
24014       description: returns p-interface
24015       operationId: getNetworkVplsPesVplsPePInterfacesPInterface
24016       produces:
24017         - application/json
24018         - application/xml
24019       responses:
24020         "200":
24021           description: successful operation
24022           schema:
24023               $ref: "#/getDefinitions/p-interface"
24024         "default":
24025           description: Response codes found in [response codes](https://wiki.onap.org/).
24026       parameters:
24027         - name: equipment-name
24028           in: path
24029           required: true
24030           type: string
24031           example: __EQUIPMENT-NAME__
24032         - name: interface-name
24033           in: path
24034           description: Name that identifies the physical interface
24035           required: true
24036           type: string
24037           example: __INTERFACE-NAME__
24038         - name: prov-status
24039           in: query
24040           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
24041           required: false
24042           type: string
24043         - name: prov-status
24044           in: query
24045           description: Trigger for operational monitoring of this resource by Service Assurance systems.
24046           required: false
24047           type: string
24048     put:
24049       tags:
24050         - Network
24051       summary: create or update an existing p-interface
24052       description: |
24053         Create or update an existing p-interface.
24054         #
24055         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
24056       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterface
24057       consumes:
24058         - application/json
24059         - application/xml
24060       produces:
24061         - application/json
24062         - application/xml
24063       responses:
24064         "default":
24065           description: Response codes found in [response codes](https://wiki.onap.org/).
24066       parameters:
24067         - name: equipment-name
24068           in: path
24069           required: true
24070           type: string
24071           example: __EQUIPMENT-NAME__
24072         - name: interface-name
24073           in: path
24074           description: Name that identifies the physical interface
24075           required: true
24076           type: string
24077           example: __INTERFACE-NAME__
24078         - name: body
24079           in: body
24080           description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterface.json)
24081           required: true
24082           schema:
24083             $ref: "#/definitions/p-interface"
24084     patch:
24085       tags:
24086         - Network
24087       summary: update an existing p-interface
24088       description: |
24089         Update an existing p-interface
24090         #
24091         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24092         The PUT operation will entirely replace an existing object.
24093         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
24094         #
24095         Other differences between PUT and PATCH are:
24096         #
24097         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
24098         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24099         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24100       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterface
24101       consumes:
24102         - application/json
24103         - application/xml
24104       produces:
24105         - application/json
24106         - application/xml
24107       responses:
24108         "default":
24109           description: Response codes found in [response codes](https://wiki.onap.org/).
24110       parameters:
24111         - name: equipment-name
24112           in: path
24113           required: true
24114           type: string
24115           example: __EQUIPMENT-NAME__
24116         - name: interface-name
24117           in: path
24118           description: Name that identifies the physical interface
24119           required: true
24120           type: string
24121           example: __INTERFACE-NAME__
24122         - name: body
24123           in: body
24124           description: p-interface object that needs to be created or updated.
24125           required: true
24126           schema:
24127             $ref: "#/patchDefinitions/p-interface"
24128     delete:
24129       tags:
24130         - Network
24131       summary: delete an existing p-interface
24132       description: delete an existing p-interface
24133       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterface
24134       consumes:
24135         - application/json
24136         - application/xml
24137       produces:
24138         - application/json
24139         - application/xml
24140       responses:
24141         "default":
24142           description: Response codes found in [response codes](https://wiki.onap.org/).
24143       parameters:
24144         - name: equipment-name
24145           in: path
24146           required: true
24147           type: string
24148           example: __EQUIPMENT-NAME__
24149         - name: interface-name
24150           in: path
24151           description: Name that identifies the physical interface
24152           required: true
24153           type: string
24154           example: __INTERFACE-NAME__
24155         - name: resource-version
24156           in: query
24157           description: resource-version for concurrency
24158           required: true
24159           type: string
24160   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces:
24161     get:
24162       tags:
24163         - Network
24164       summary: returns p-interfaces
24165       description: returns p-interfaces
24166       operationId: getNetworkVplsPesVplsPePInterfaces
24167       produces:
24168         - application/json
24169         - application/xml
24170       responses:
24171         "200":
24172           description: successful operation
24173           schema:
24174               $ref: "#/getDefinitions/p-interfaces"
24175         "default":
24176           description: Response codes found in [response codes](https://wiki.onap.org/).
24177       parameters:
24178         - name: equipment-name
24179           in: path
24180           required: true
24181           type: string
24182           example: __EQUIPMENT-NAME__
24183         - name: prov-status
24184           in: query
24185           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
24186           required: false
24187           type: string
24188   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
24189     put:
24190       tags:
24191         - Network
24192       summary: see node definition for valid relationships
24193       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
24194       consumes:
24195         - application/json
24196         - application/xml
24197       produces:
24198         - application/json
24199         - application/xml
24200       responses:
24201         "default":
24202           description: Response codes found in [response codes](https://wiki.onap.org/).
24203       parameters:
24204         - name: equipment-name
24205           in: path
24206           required: true
24207           type: string
24208           example: __EQUIPMENT-NAME__
24209         - name: interface-name
24210           in: path
24211           description: Name that identifies the link aggregate interface
24212           required: true
24213           type: string
24214           example: __INTERFACE-NAME__
24215         - name: body
24216           in: body
24217           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
24218           required: true
24219           schema:
24220             $ref: "#/definitions/relationship"
24221     delete:
24222       tags:
24223         - Network
24224       summary: delete an existing relationship
24225       description: delete an existing relationship
24226       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
24227       consumes:
24228         - application/json
24229         - application/xml
24230       produces:
24231         - application/json
24232         - application/xml
24233       responses:
24234         "default":
24235           description: Response codes found in [response codes](https://wiki.onap.org/).
24236       parameters:
24237         - name: equipment-name
24238           in: path
24239           required: true
24240           type: string
24241           example: __EQUIPMENT-NAME__
24242         - name: interface-name
24243           in: path
24244           description: Name that identifies the link aggregate interface
24245           required: true
24246           type: string
24247           example: __INTERFACE-NAME__
24248   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
24249     put:
24250       tags:
24251         - Network
24252       summary: see node definition for valid relationships
24253       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
24254       consumes:
24255         - application/json
24256         - application/xml
24257       produces:
24258         - application/json
24259         - application/xml
24260       responses:
24261         "default":
24262           description: Response codes found in [response codes](https://wiki.onap.org/).
24263       parameters:
24264         - name: equipment-name
24265           in: path
24266           required: true
24267           type: string
24268           example: __EQUIPMENT-NAME__
24269         - name: interface-name
24270           in: path
24271           description: Name that identifies the link aggregate interface
24272           required: true
24273           type: string
24274           example: __INTERFACE-NAME__
24275         - name: interface-name
24276           in: path
24277           description: Name given to the interface
24278           required: true
24279           type: string
24280           example: __INTERFACE-NAME__
24281         - name: vlan-interface
24282           in: path
24283           description: String that identifies the interface
24284           required: true
24285           type: string
24286           example: __VLAN-INTERFACE__
24287         - name: body
24288           in: body
24289           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
24290           required: true
24291           schema:
24292             $ref: "#/definitions/relationship"
24293     delete:
24294       tags:
24295         - Network
24296       summary: delete an existing relationship
24297       description: delete an existing relationship
24298       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
24299       consumes:
24300         - application/json
24301         - application/xml
24302       produces:
24303         - application/json
24304         - application/xml
24305       responses:
24306         "default":
24307           description: Response codes found in [response codes](https://wiki.onap.org/).
24308       parameters:
24309         - name: equipment-name
24310           in: path
24311           required: true
24312           type: string
24313           example: __EQUIPMENT-NAME__
24314         - name: interface-name
24315           in: path
24316           description: Name that identifies the link aggregate interface
24317           required: true
24318           type: string
24319           example: __INTERFACE-NAME__
24320         - name: interface-name
24321           in: path
24322           description: Name given to the interface
24323           required: true
24324           type: string
24325           example: __INTERFACE-NAME__
24326         - name: vlan-interface
24327           in: path
24328           description: String that identifies the interface
24329           required: true
24330           type: string
24331           example: __VLAN-INTERFACE__
24332   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
24333     put:
24334       tags:
24335         - Network
24336       summary: see node definition for valid relationships
24337       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
24338       consumes:
24339         - application/json
24340         - application/xml
24341       produces:
24342         - application/json
24343         - application/xml
24344       responses:
24345         "default":
24346           description: Response codes found in [response codes](https://wiki.onap.org/).
24347       parameters:
24348         - name: equipment-name
24349           in: path
24350           required: true
24351           type: string
24352           example: __EQUIPMENT-NAME__
24353         - name: interface-name
24354           in: path
24355           description: Name that identifies the link aggregate interface
24356           required: true
24357           type: string
24358           example: __INTERFACE-NAME__
24359         - name: interface-name
24360           in: path
24361           description: Name given to the interface
24362           required: true
24363           type: string
24364           example: __INTERFACE-NAME__
24365         - name: vlan-interface
24366           in: path
24367           description: String that identifies the interface
24368           required: true
24369           type: string
24370           example: __VLAN-INTERFACE__
24371         - name: l3-interface-ipv4-address
24372           in: path
24373           description: IP address
24374           required: true
24375           type: string
24376           example: __L3-INTERFACE-IPV4-ADDRESS__
24377         - name: body
24378           in: body
24379           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
24380           required: true
24381           schema:
24382             $ref: "#/definitions/relationship"
24383     delete:
24384       tags:
24385         - Network
24386       summary: delete an existing relationship
24387       description: delete an existing relationship
24388       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
24389       consumes:
24390         - application/json
24391         - application/xml
24392       produces:
24393         - application/json
24394         - application/xml
24395       responses:
24396         "default":
24397           description: Response codes found in [response codes](https://wiki.onap.org/).
24398       parameters:
24399         - name: equipment-name
24400           in: path
24401           required: true
24402           type: string
24403           example: __EQUIPMENT-NAME__
24404         - name: interface-name
24405           in: path
24406           description: Name that identifies the link aggregate interface
24407           required: true
24408           type: string
24409           example: __INTERFACE-NAME__
24410         - name: interface-name
24411           in: path
24412           description: Name given to the interface
24413           required: true
24414           type: string
24415           example: __INTERFACE-NAME__
24416         - name: vlan-interface
24417           in: path
24418           description: String that identifies the interface
24419           required: true
24420           type: string
24421           example: __VLAN-INTERFACE__
24422         - name: l3-interface-ipv4-address
24423           in: path
24424           description: IP address
24425           required: true
24426           type: string
24427           example: __L3-INTERFACE-IPV4-ADDRESS__
24428   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
24429     get:
24430       tags:
24431         - Network
24432       summary: returns l3-interface-ipv4-address-list
24433       description: returns l3-interface-ipv4-address-list
24434       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
24435       produces:
24436         - application/json
24437         - application/xml
24438       responses:
24439         "200":
24440           description: successful operation
24441           schema:
24442               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
24443         "default":
24444           description: Response codes found in [response codes](https://wiki.onap.org/).
24445       parameters:
24446         - name: equipment-name
24447           in: path
24448           required: true
24449           type: string
24450           example: __EQUIPMENT-NAME__
24451         - name: interface-name
24452           in: path
24453           description: Name that identifies the link aggregate interface
24454           required: true
24455           type: string
24456           example: __INTERFACE-NAME__
24457         - name: interface-name
24458           in: path
24459           description: Name given to the interface
24460           required: true
24461           type: string
24462           example: __INTERFACE-NAME__
24463         - name: vlan-interface
24464           in: path
24465           description: String that identifies the interface
24466           required: true
24467           type: string
24468           example: __VLAN-INTERFACE__
24469         - name: l3-interface-ipv4-address
24470           in: path
24471           description: IP address
24472           required: true
24473           type: string
24474           example: __L3-INTERFACE-IPV4-ADDRESS__
24475         - name: prov-status
24476           in: query
24477           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
24478           required: false
24479           type: string
24480         - name: interface-id
24481           in: query
24482           description: ID of interface
24483           required: false
24484           type: string
24485         - name: interface-role
24486           in: query
24487           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
24488           required: false
24489           type: string
24490         - name: interface-id
24491           in: query
24492           description: ID of interface
24493           required: false
24494           type: string
24495         - name: macaddr
24496           in: query
24497           description: MAC address for the interface
24498           required: false
24499           type: string
24500         - name: network-name
24501           in: query
24502           description: Name of the network
24503           required: false
24504           type: string
24505         - name: vlan-id-inner
24506           in: query
24507           description: Inner VLAN tag
24508           required: false
24509           type: integer
24510           format: int64
24511         - name: vpn-id
24512           in: query
24513           description: This indicates the customers VPN ID associated with this vlan
24514           required: false
24515           type: string
24516         - name: vlan-id-inner
24517           in: query
24518           description: Inner VLAN tag
24519           required: false
24520           type: integer
24521           format: int64
24522         - name: neutron-network-id
24523           in: query
24524           description: Neutron network id of the interface that address belongs to
24525           required: false
24526           type: string
24527         - name: neutron-subnet-id
24528           in: query
24529           description: Neutron id of subnet that address belongs to
24530           required: false
24531           type: string
24532     put:
24533       tags:
24534         - Network
24535       summary: create or update an existing l3-interface-ipv4-address-list
24536       description: |
24537         Create or update an existing l3-interface-ipv4-address-list.
24538         #
24539         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
24540       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
24541       consumes:
24542         - application/json
24543         - application/xml
24544       produces:
24545         - application/json
24546         - application/xml
24547       responses:
24548         "default":
24549           description: Response codes found in [response codes](https://wiki.onap.org/).
24550       parameters:
24551         - name: equipment-name
24552           in: path
24553           required: true
24554           type: string
24555           example: __EQUIPMENT-NAME__
24556         - name: interface-name
24557           in: path
24558           description: Name that identifies the link aggregate interface
24559           required: true
24560           type: string
24561           example: __INTERFACE-NAME__
24562         - name: interface-name
24563           in: path
24564           description: Name given to the interface
24565           required: true
24566           type: string
24567           example: __INTERFACE-NAME__
24568         - name: vlan-interface
24569           in: path
24570           description: String that identifies the interface
24571           required: true
24572           type: string
24573           example: __VLAN-INTERFACE__
24574         - name: l3-interface-ipv4-address
24575           in: path
24576           description: IP address
24577           required: true
24578           type: string
24579           example: __L3-INTERFACE-IPV4-ADDRESS__
24580         - name: body
24581           in: body
24582           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
24583           required: true
24584           schema:
24585             $ref: "#/definitions/l3-interface-ipv4-address-list"
24586     patch:
24587       tags:
24588         - Network
24589       summary: update an existing l3-interface-ipv4-address-list
24590       description: |
24591         Update an existing l3-interface-ipv4-address-list
24592         #
24593         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24594         The PUT operation will entirely replace an existing object.
24595         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
24596         #
24597         Other differences between PUT and PATCH are:
24598         #
24599         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
24600         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24601         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24602       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
24603       consumes:
24604         - application/json
24605         - application/xml
24606       produces:
24607         - application/json
24608         - application/xml
24609       responses:
24610         "default":
24611           description: Response codes found in [response codes](https://wiki.onap.org/).
24612       parameters:
24613         - name: equipment-name
24614           in: path
24615           required: true
24616           type: string
24617           example: __EQUIPMENT-NAME__
24618         - name: interface-name
24619           in: path
24620           description: Name that identifies the link aggregate interface
24621           required: true
24622           type: string
24623           example: __INTERFACE-NAME__
24624         - name: interface-name
24625           in: path
24626           description: Name given to the interface
24627           required: true
24628           type: string
24629           example: __INTERFACE-NAME__
24630         - name: vlan-interface
24631           in: path
24632           description: String that identifies the interface
24633           required: true
24634           type: string
24635           example: __VLAN-INTERFACE__
24636         - name: l3-interface-ipv4-address
24637           in: path
24638           description: IP address
24639           required: true
24640           type: string
24641           example: __L3-INTERFACE-IPV4-ADDRESS__
24642         - name: body
24643           in: body
24644           description: l3-interface-ipv4-address-list object that needs to be created or updated.
24645           required: true
24646           schema:
24647             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
24648     delete:
24649       tags:
24650         - Network
24651       summary: delete an existing l3-interface-ipv4-address-list
24652       description: delete an existing l3-interface-ipv4-address-list
24653       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
24654       consumes:
24655         - application/json
24656         - application/xml
24657       produces:
24658         - application/json
24659         - application/xml
24660       responses:
24661         "default":
24662           description: Response codes found in [response codes](https://wiki.onap.org/).
24663       parameters:
24664         - name: equipment-name
24665           in: path
24666           required: true
24667           type: string
24668           example: __EQUIPMENT-NAME__
24669         - name: interface-name
24670           in: path
24671           description: Name that identifies the link aggregate interface
24672           required: true
24673           type: string
24674           example: __INTERFACE-NAME__
24675         - name: interface-name
24676           in: path
24677           description: Name given to the interface
24678           required: true
24679           type: string
24680           example: __INTERFACE-NAME__
24681         - name: vlan-interface
24682           in: path
24683           description: String that identifies the interface
24684           required: true
24685           type: string
24686           example: __VLAN-INTERFACE__
24687         - name: l3-interface-ipv4-address
24688           in: path
24689           description: IP address
24690           required: true
24691           type: string
24692           example: __L3-INTERFACE-IPV4-ADDRESS__
24693         - name: resource-version
24694           in: query
24695           description: resource-version for concurrency
24696           required: true
24697           type: string
24698   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
24699     put:
24700       tags:
24701         - Network
24702       summary: see node definition for valid relationships
24703       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
24704       consumes:
24705         - application/json
24706         - application/xml
24707       produces:
24708         - application/json
24709         - application/xml
24710       responses:
24711         "default":
24712           description: Response codes found in [response codes](https://wiki.onap.org/).
24713       parameters:
24714         - name: equipment-name
24715           in: path
24716           required: true
24717           type: string
24718           example: __EQUIPMENT-NAME__
24719         - name: interface-name
24720           in: path
24721           description: Name that identifies the link aggregate interface
24722           required: true
24723           type: string
24724           example: __INTERFACE-NAME__
24725         - name: interface-name
24726           in: path
24727           description: Name given to the interface
24728           required: true
24729           type: string
24730           example: __INTERFACE-NAME__
24731         - name: vlan-interface
24732           in: path
24733           description: String that identifies the interface
24734           required: true
24735           type: string
24736           example: __VLAN-INTERFACE__
24737         - name: l3-interface-ipv6-address
24738           in: path
24739           description: IP address
24740           required: true
24741           type: string
24742           example: __L3-INTERFACE-IPV6-ADDRESS__
24743         - name: body
24744           in: body
24745           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
24746           required: true
24747           schema:
24748             $ref: "#/definitions/relationship"
24749     delete:
24750       tags:
24751         - Network
24752       summary: delete an existing relationship
24753       description: delete an existing relationship
24754       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
24755       consumes:
24756         - application/json
24757         - application/xml
24758       produces:
24759         - application/json
24760         - application/xml
24761       responses:
24762         "default":
24763           description: Response codes found in [response codes](https://wiki.onap.org/).
24764       parameters:
24765         - name: equipment-name
24766           in: path
24767           required: true
24768           type: string
24769           example: __EQUIPMENT-NAME__
24770         - name: interface-name
24771           in: path
24772           description: Name that identifies the link aggregate interface
24773           required: true
24774           type: string
24775           example: __INTERFACE-NAME__
24776         - name: interface-name
24777           in: path
24778           description: Name given to the interface
24779           required: true
24780           type: string
24781           example: __INTERFACE-NAME__
24782         - name: vlan-interface
24783           in: path
24784           description: String that identifies the interface
24785           required: true
24786           type: string
24787           example: __VLAN-INTERFACE__
24788         - name: l3-interface-ipv6-address
24789           in: path
24790           description: IP address
24791           required: true
24792           type: string
24793           example: __L3-INTERFACE-IPV6-ADDRESS__
24794   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
24795     get:
24796       tags:
24797         - Network
24798       summary: returns l3-interface-ipv6-address-list
24799       description: returns l3-interface-ipv6-address-list
24800       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
24801       produces:
24802         - application/json
24803         - application/xml
24804       responses:
24805         "200":
24806           description: successful operation
24807           schema:
24808               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
24809         "default":
24810           description: Response codes found in [response codes](https://wiki.onap.org/).
24811       parameters:
24812         - name: equipment-name
24813           in: path
24814           required: true
24815           type: string
24816           example: __EQUIPMENT-NAME__
24817         - name: interface-name
24818           in: path
24819           description: Name that identifies the link aggregate interface
24820           required: true
24821           type: string
24822           example: __INTERFACE-NAME__
24823         - name: interface-name
24824           in: path
24825           description: Name given to the interface
24826           required: true
24827           type: string
24828           example: __INTERFACE-NAME__
24829         - name: vlan-interface
24830           in: path
24831           description: String that identifies the interface
24832           required: true
24833           type: string
24834           example: __VLAN-INTERFACE__
24835         - name: l3-interface-ipv6-address
24836           in: path
24837           description: IP address
24838           required: true
24839           type: string
24840           example: __L3-INTERFACE-IPV6-ADDRESS__
24841         - name: prov-status
24842           in: query
24843           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
24844           required: false
24845           type: string
24846         - name: interface-id
24847           in: query
24848           description: ID of interface
24849           required: false
24850           type: string
24851         - name: interface-role
24852           in: query
24853           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
24854           required: false
24855           type: string
24856         - name: interface-id
24857           in: query
24858           description: ID of interface
24859           required: false
24860           type: string
24861         - name: macaddr
24862           in: query
24863           description: MAC address for the interface
24864           required: false
24865           type: string
24866         - name: network-name
24867           in: query
24868           description: Name of the network
24869           required: false
24870           type: string
24871         - name: vlan-id-inner
24872           in: query
24873           description: Inner VLAN tag
24874           required: false
24875           type: integer
24876           format: int64
24877         - name: vpn-id
24878           in: query
24879           description: This indicates the customers VPN ID associated with this vlan
24880           required: false
24881           type: string
24882         - name: vlan-id-inner
24883           in: query
24884           description: Inner VLAN tag
24885           required: false
24886           type: integer
24887           format: int64
24888         - name: neutron-network-id
24889           in: query
24890           description: Neutron network id of the interface that address belongs to
24891           required: false
24892           type: string
24893         - name: neutron-subnet-id
24894           in: query
24895           description: Neutron id of subnet that address belongs to
24896           required: false
24897           type: string
24898     put:
24899       tags:
24900         - Network
24901       summary: create or update an existing l3-interface-ipv6-address-list
24902       description: |
24903         Create or update an existing l3-interface-ipv6-address-list.
24904         #
24905         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
24906       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
24907       consumes:
24908         - application/json
24909         - application/xml
24910       produces:
24911         - application/json
24912         - application/xml
24913       responses:
24914         "default":
24915           description: Response codes found in [response codes](https://wiki.onap.org/).
24916       parameters:
24917         - name: equipment-name
24918           in: path
24919           required: true
24920           type: string
24921           example: __EQUIPMENT-NAME__
24922         - name: interface-name
24923           in: path
24924           description: Name that identifies the link aggregate interface
24925           required: true
24926           type: string
24927           example: __INTERFACE-NAME__
24928         - name: interface-name
24929           in: path
24930           description: Name given to the interface
24931           required: true
24932           type: string
24933           example: __INTERFACE-NAME__
24934         - name: vlan-interface
24935           in: path
24936           description: String that identifies the interface
24937           required: true
24938           type: string
24939           example: __VLAN-INTERFACE__
24940         - name: l3-interface-ipv6-address
24941           in: path
24942           description: IP address
24943           required: true
24944           type: string
24945           example: __L3-INTERFACE-IPV6-ADDRESS__
24946         - name: body
24947           in: body
24948           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
24949           required: true
24950           schema:
24951             $ref: "#/definitions/l3-interface-ipv6-address-list"
24952     patch:
24953       tags:
24954         - Network
24955       summary: update an existing l3-interface-ipv6-address-list
24956       description: |
24957         Update an existing l3-interface-ipv6-address-list
24958         #
24959         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24960         The PUT operation will entirely replace an existing object.
24961         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
24962         #
24963         Other differences between PUT and PATCH are:
24964         #
24965         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
24966         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24967         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24968       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
24969       consumes:
24970         - application/json
24971         - application/xml
24972       produces:
24973         - application/json
24974         - application/xml
24975       responses:
24976         "default":
24977           description: Response codes found in [response codes](https://wiki.onap.org/).
24978       parameters:
24979         - name: equipment-name
24980           in: path
24981           required: true
24982           type: string
24983           example: __EQUIPMENT-NAME__
24984         - name: interface-name
24985           in: path
24986           description: Name that identifies the link aggregate interface
24987           required: true
24988           type: string
24989           example: __INTERFACE-NAME__
24990         - name: interface-name
24991           in: path
24992           description: Name given to the interface
24993           required: true
24994           type: string
24995           example: __INTERFACE-NAME__
24996         - name: vlan-interface
24997           in: path
24998           description: String that identifies the interface
24999           required: true
25000           type: string
25001           example: __VLAN-INTERFACE__
25002         - name: l3-interface-ipv6-address
25003           in: path
25004           description: IP address
25005           required: true
25006           type: string
25007           example: __L3-INTERFACE-IPV6-ADDRESS__
25008         - name: body
25009           in: body
25010           description: l3-interface-ipv6-address-list object that needs to be created or updated.
25011           required: true
25012           schema:
25013             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
25014     delete:
25015       tags:
25016         - Network
25017       summary: delete an existing l3-interface-ipv6-address-list
25018       description: delete an existing l3-interface-ipv6-address-list
25019       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
25020       consumes:
25021         - application/json
25022         - application/xml
25023       produces:
25024         - application/json
25025         - application/xml
25026       responses:
25027         "default":
25028           description: Response codes found in [response codes](https://wiki.onap.org/).
25029       parameters:
25030         - name: equipment-name
25031           in: path
25032           required: true
25033           type: string
25034           example: __EQUIPMENT-NAME__
25035         - name: interface-name
25036           in: path
25037           description: Name that identifies the link aggregate interface
25038           required: true
25039           type: string
25040           example: __INTERFACE-NAME__
25041         - name: interface-name
25042           in: path
25043           description: Name given to the interface
25044           required: true
25045           type: string
25046           example: __INTERFACE-NAME__
25047         - name: vlan-interface
25048           in: path
25049           description: String that identifies the interface
25050           required: true
25051           type: string
25052           example: __VLAN-INTERFACE__
25053         - name: l3-interface-ipv6-address
25054           in: path
25055           description: IP address
25056           required: true
25057           type: string
25058           example: __L3-INTERFACE-IPV6-ADDRESS__
25059         - name: resource-version
25060           in: query
25061           description: resource-version for concurrency
25062           required: true
25063           type: string
25064   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
25065     get:
25066       tags:
25067         - Network
25068       summary: returns vlan
25069       description: returns vlan
25070       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
25071       produces:
25072         - application/json
25073         - application/xml
25074       responses:
25075         "200":
25076           description: successful operation
25077           schema:
25078               $ref: "#/getDefinitions/vlan"
25079         "default":
25080           description: Response codes found in [response codes](https://wiki.onap.org/).
25081       parameters:
25082         - name: equipment-name
25083           in: path
25084           required: true
25085           type: string
25086           example: __EQUIPMENT-NAME__
25087         - name: interface-name
25088           in: path
25089           description: Name that identifies the link aggregate interface
25090           required: true
25091           type: string
25092           example: __INTERFACE-NAME__
25093         - name: interface-name
25094           in: path
25095           description: Name given to the interface
25096           required: true
25097           type: string
25098           example: __INTERFACE-NAME__
25099         - name: vlan-interface
25100           in: path
25101           description: String that identifies the interface
25102           required: true
25103           type: string
25104           example: __VLAN-INTERFACE__
25105         - name: prov-status
25106           in: query
25107           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
25108           required: false
25109           type: string
25110         - name: interface-id
25111           in: query
25112           description: ID of interface
25113           required: false
25114           type: string
25115         - name: interface-role
25116           in: query
25117           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
25118           required: false
25119           type: string
25120         - name: interface-id
25121           in: query
25122           description: ID of interface
25123           required: false
25124           type: string
25125         - name: macaddr
25126           in: query
25127           description: MAC address for the interface
25128           required: false
25129           type: string
25130         - name: network-name
25131           in: query
25132           description: Name of the network
25133           required: false
25134           type: string
25135         - name: vlan-id-inner
25136           in: query
25137           description: Inner VLAN tag
25138           required: false
25139           type: integer
25140           format: int64
25141         - name: vpn-id
25142           in: query
25143           description: This indicates the customers VPN ID associated with this vlan
25144           required: false
25145           type: string
25146     put:
25147       tags:
25148         - Network
25149       summary: create or update an existing vlan
25150       description: |
25151         Create or update an existing vlan.
25152         #
25153         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
25154       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
25155       consumes:
25156         - application/json
25157         - application/xml
25158       produces:
25159         - application/json
25160         - application/xml
25161       responses:
25162         "default":
25163           description: Response codes found in [response codes](https://wiki.onap.org/).
25164       parameters:
25165         - name: equipment-name
25166           in: path
25167           required: true
25168           type: string
25169           example: __EQUIPMENT-NAME__
25170         - name: interface-name
25171           in: path
25172           description: Name that identifies the link aggregate interface
25173           required: true
25174           type: string
25175           example: __INTERFACE-NAME__
25176         - name: interface-name
25177           in: path
25178           description: Name given to the interface
25179           required: true
25180           type: string
25181           example: __INTERFACE-NAME__
25182         - name: vlan-interface
25183           in: path
25184           description: String that identifies the interface
25185           required: true
25186           type: string
25187           example: __VLAN-INTERFACE__
25188         - name: body
25189           in: body
25190           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
25191           required: true
25192           schema:
25193             $ref: "#/definitions/vlan"
25194     patch:
25195       tags:
25196         - Network
25197       summary: update an existing vlan
25198       description: |
25199         Update an existing vlan
25200         #
25201         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25202         The PUT operation will entirely replace an existing object.
25203         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
25204         #
25205         Other differences between PUT and PATCH are:
25206         #
25207         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
25208         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25209         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25210       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
25211       consumes:
25212         - application/json
25213         - application/xml
25214       produces:
25215         - application/json
25216         - application/xml
25217       responses:
25218         "default":
25219           description: Response codes found in [response codes](https://wiki.onap.org/).
25220       parameters:
25221         - name: equipment-name
25222           in: path
25223           required: true
25224           type: string
25225           example: __EQUIPMENT-NAME__
25226         - name: interface-name
25227           in: path
25228           description: Name that identifies the link aggregate interface
25229           required: true
25230           type: string
25231           example: __INTERFACE-NAME__
25232         - name: interface-name
25233           in: path
25234           description: Name given to the interface
25235           required: true
25236           type: string
25237           example: __INTERFACE-NAME__
25238         - name: vlan-interface
25239           in: path
25240           description: String that identifies the interface
25241           required: true
25242           type: string
25243           example: __VLAN-INTERFACE__
25244         - name: body
25245           in: body
25246           description: vlan object that needs to be created or updated.
25247           required: true
25248           schema:
25249             $ref: "#/patchDefinitions/vlan"
25250     delete:
25251       tags:
25252         - Network
25253       summary: delete an existing vlan
25254       description: delete an existing vlan
25255       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
25256       consumes:
25257         - application/json
25258         - application/xml
25259       produces:
25260         - application/json
25261         - application/xml
25262       responses:
25263         "default":
25264           description: Response codes found in [response codes](https://wiki.onap.org/).
25265       parameters:
25266         - name: equipment-name
25267           in: path
25268           required: true
25269           type: string
25270           example: __EQUIPMENT-NAME__
25271         - name: interface-name
25272           in: path
25273           description: Name that identifies the link aggregate interface
25274           required: true
25275           type: string
25276           example: __INTERFACE-NAME__
25277         - name: interface-name
25278           in: path
25279           description: Name given to the interface
25280           required: true
25281           type: string
25282           example: __INTERFACE-NAME__
25283         - name: vlan-interface
25284           in: path
25285           description: String that identifies the interface
25286           required: true
25287           type: string
25288           example: __VLAN-INTERFACE__
25289         - name: resource-version
25290           in: query
25291           description: resource-version for concurrency
25292           required: true
25293           type: string
25294   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
25295     get:
25296       tags:
25297         - Network
25298       summary: returns vlans
25299       description: returns vlans
25300       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
25301       produces:
25302         - application/json
25303         - application/xml
25304       responses:
25305         "200":
25306           description: successful operation
25307           schema:
25308               $ref: "#/getDefinitions/vlans"
25309         "default":
25310           description: Response codes found in [response codes](https://wiki.onap.org/).
25311       parameters:
25312         - name: equipment-name
25313           in: path
25314           required: true
25315           type: string
25316           example: __EQUIPMENT-NAME__
25317         - name: interface-name
25318           in: path
25319           description: Name that identifies the link aggregate interface
25320           required: true
25321           type: string
25322           example: __INTERFACE-NAME__
25323         - name: interface-name
25324           in: path
25325           description: Name given to the interface
25326           required: true
25327           type: string
25328           example: __INTERFACE-NAME__
25329         - name: prov-status
25330           in: query
25331           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
25332           required: false
25333           type: string
25334         - name: interface-id
25335           in: query
25336           description: ID of interface
25337           required: false
25338           type: string
25339         - name: interface-role
25340           in: query
25341           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
25342           required: false
25343           type: string
25344         - name: interface-id
25345           in: query
25346           description: ID of interface
25347           required: false
25348           type: string
25349         - name: macaddr
25350           in: query
25351           description: MAC address for the interface
25352           required: false
25353           type: string
25354         - name: network-name
25355           in: query
25356           description: Name of the network
25357           required: false
25358           type: string
25359   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
25360     put:
25361       tags:
25362         - Network
25363       summary: see node definition for valid relationships
25364       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
25365       consumes:
25366         - application/json
25367         - application/xml
25368       produces:
25369         - application/json
25370         - application/xml
25371       responses:
25372         "default":
25373           description: Response codes found in [response codes](https://wiki.onap.org/).
25374       parameters:
25375         - name: equipment-name
25376           in: path
25377           required: true
25378           type: string
25379           example: __EQUIPMENT-NAME__
25380         - name: interface-name
25381           in: path
25382           description: Name that identifies the link aggregate interface
25383           required: true
25384           type: string
25385           example: __INTERFACE-NAME__
25386         - name: interface-name
25387           in: path
25388           description: Name given to the interface
25389           required: true
25390           type: string
25391           example: __INTERFACE-NAME__
25392         - name: pci-id
25393           in: path
25394           description: PCI ID used to identify the sriov-vf
25395           required: true
25396           type: string
25397           example: __PCI-ID__
25398         - name: body
25399           in: body
25400           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
25401           required: true
25402           schema:
25403             $ref: "#/definitions/relationship"
25404     delete:
25405       tags:
25406         - Network
25407       summary: delete an existing relationship
25408       description: delete an existing relationship
25409       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
25410       consumes:
25411         - application/json
25412         - application/xml
25413       produces:
25414         - application/json
25415         - application/xml
25416       responses:
25417         "default":
25418           description: Response codes found in [response codes](https://wiki.onap.org/).
25419       parameters:
25420         - name: equipment-name
25421           in: path
25422           required: true
25423           type: string
25424           example: __EQUIPMENT-NAME__
25425         - name: interface-name
25426           in: path
25427           description: Name that identifies the link aggregate interface
25428           required: true
25429           type: string
25430           example: __INTERFACE-NAME__
25431         - name: interface-name
25432           in: path
25433           description: Name given to the interface
25434           required: true
25435           type: string
25436           example: __INTERFACE-NAME__
25437         - name: pci-id
25438           in: path
25439           description: PCI ID used to identify the sriov-vf
25440           required: true
25441           type: string
25442           example: __PCI-ID__
25443   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
25444     get:
25445       tags:
25446         - Network
25447       summary: returns sriov-vf
25448       description: returns sriov-vf
25449       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
25450       produces:
25451         - application/json
25452         - application/xml
25453       responses:
25454         "200":
25455           description: successful operation
25456           schema:
25457               $ref: "#/getDefinitions/sriov-vf"
25458         "default":
25459           description: Response codes found in [response codes](https://wiki.onap.org/).
25460       parameters:
25461         - name: equipment-name
25462           in: path
25463           required: true
25464           type: string
25465           example: __EQUIPMENT-NAME__
25466         - name: interface-name
25467           in: path
25468           description: Name that identifies the link aggregate interface
25469           required: true
25470           type: string
25471           example: __INTERFACE-NAME__
25472         - name: interface-name
25473           in: path
25474           description: Name given to the interface
25475           required: true
25476           type: string
25477           example: __INTERFACE-NAME__
25478         - name: pci-id
25479           in: path
25480           description: PCI ID used to identify the sriov-vf
25481           required: true
25482           type: string
25483           example: __PCI-ID__
25484         - name: prov-status
25485           in: query
25486           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
25487           required: false
25488           type: string
25489         - name: interface-id
25490           in: query
25491           description: ID of interface
25492           required: false
25493           type: string
25494         - name: interface-role
25495           in: query
25496           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
25497           required: false
25498           type: string
25499         - name: interface-id
25500           in: query
25501           description: ID of interface
25502           required: false
25503           type: string
25504         - name: macaddr
25505           in: query
25506           description: MAC address for the interface
25507           required: false
25508           type: string
25509         - name: network-name
25510           in: query
25511           description: Name of the network
25512           required: false
25513           type: string
25514         - name: vf-vlan-filter
25515           in: query
25516           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
25517           required: false
25518           type: string
25519         - name: vf-mac-filter
25520           in: query
25521           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
25522           required: false
25523           type: string
25524         - name: vf-vlan-strip
25525           in: query
25526           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
25527           required: false
25528           type: boolean
25529         - name: neutron-network-id
25530           in: query
25531           description: Neutron network id of the interface
25532           required: false
25533           type: string
25534     put:
25535       tags:
25536         - Network
25537       summary: create or update an existing sriov-vf
25538       description: |
25539         Create or update an existing sriov-vf.
25540         #
25541         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
25542       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
25543       consumes:
25544         - application/json
25545         - application/xml
25546       produces:
25547         - application/json
25548         - application/xml
25549       responses:
25550         "default":
25551           description: Response codes found in [response codes](https://wiki.onap.org/).
25552       parameters:
25553         - name: equipment-name
25554           in: path
25555           required: true
25556           type: string
25557           example: __EQUIPMENT-NAME__
25558         - name: interface-name
25559           in: path
25560           description: Name that identifies the link aggregate interface
25561           required: true
25562           type: string
25563           example: __INTERFACE-NAME__
25564         - name: interface-name
25565           in: path
25566           description: Name given to the interface
25567           required: true
25568           type: string
25569           example: __INTERFACE-NAME__
25570         - name: pci-id
25571           in: path
25572           description: PCI ID used to identify the sriov-vf
25573           required: true
25574           type: string
25575           example: __PCI-ID__
25576         - name: body
25577           in: body
25578           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
25579           required: true
25580           schema:
25581             $ref: "#/definitions/sriov-vf"
25582     patch:
25583       tags:
25584         - Network
25585       summary: update an existing sriov-vf
25586       description: |
25587         Update an existing sriov-vf
25588         #
25589         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25590         The PUT operation will entirely replace an existing object.
25591         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
25592         #
25593         Other differences between PUT and PATCH are:
25594         #
25595         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
25596         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25597         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25598       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
25599       consumes:
25600         - application/json
25601         - application/xml
25602       produces:
25603         - application/json
25604         - application/xml
25605       responses:
25606         "default":
25607           description: Response codes found in [response codes](https://wiki.onap.org/).
25608       parameters:
25609         - name: equipment-name
25610           in: path
25611           required: true
25612           type: string
25613           example: __EQUIPMENT-NAME__
25614         - name: interface-name
25615           in: path
25616           description: Name that identifies the link aggregate interface
25617           required: true
25618           type: string
25619           example: __INTERFACE-NAME__
25620         - name: interface-name
25621           in: path
25622           description: Name given to the interface
25623           required: true
25624           type: string
25625           example: __INTERFACE-NAME__
25626         - name: pci-id
25627           in: path
25628           description: PCI ID used to identify the sriov-vf
25629           required: true
25630           type: string
25631           example: __PCI-ID__
25632         - name: body
25633           in: body
25634           description: sriov-vf object that needs to be created or updated.
25635           required: true
25636           schema:
25637             $ref: "#/patchDefinitions/sriov-vf"
25638     delete:
25639       tags:
25640         - Network
25641       summary: delete an existing sriov-vf
25642       description: delete an existing sriov-vf
25643       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
25644       consumes:
25645         - application/json
25646         - application/xml
25647       produces:
25648         - application/json
25649         - application/xml
25650       responses:
25651         "default":
25652           description: Response codes found in [response codes](https://wiki.onap.org/).
25653       parameters:
25654         - name: equipment-name
25655           in: path
25656           required: true
25657           type: string
25658           example: __EQUIPMENT-NAME__
25659         - name: interface-name
25660           in: path
25661           description: Name that identifies the link aggregate interface
25662           required: true
25663           type: string
25664           example: __INTERFACE-NAME__
25665         - name: interface-name
25666           in: path
25667           description: Name given to the interface
25668           required: true
25669           type: string
25670           example: __INTERFACE-NAME__
25671         - name: pci-id
25672           in: path
25673           description: PCI ID used to identify the sriov-vf
25674           required: true
25675           type: string
25676           example: __PCI-ID__
25677         - name: resource-version
25678           in: query
25679           description: resource-version for concurrency
25680           required: true
25681           type: string
25682   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
25683     get:
25684       tags:
25685         - Network
25686       summary: returns sriov-vfs
25687       description: returns sriov-vfs
25688       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
25689       produces:
25690         - application/json
25691         - application/xml
25692       responses:
25693         "200":
25694           description: successful operation
25695           schema:
25696               $ref: "#/getDefinitions/sriov-vfs"
25697         "default":
25698           description: Response codes found in [response codes](https://wiki.onap.org/).
25699       parameters:
25700         - name: equipment-name
25701           in: path
25702           required: true
25703           type: string
25704           example: __EQUIPMENT-NAME__
25705         - name: interface-name
25706           in: path
25707           description: Name that identifies the link aggregate interface
25708           required: true
25709           type: string
25710           example: __INTERFACE-NAME__
25711         - name: interface-name
25712           in: path
25713           description: Name given to the interface
25714           required: true
25715           type: string
25716           example: __INTERFACE-NAME__
25717         - name: prov-status
25718           in: query
25719           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
25720           required: false
25721           type: string
25722         - name: interface-id
25723           in: query
25724           description: ID of interface
25725           required: false
25726           type: string
25727         - name: interface-role
25728           in: query
25729           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
25730           required: false
25731           type: string
25732         - name: interface-id
25733           in: query
25734           description: ID of interface
25735           required: false
25736           type: string
25737         - name: macaddr
25738           in: query
25739           description: MAC address for the interface
25740           required: false
25741           type: string
25742         - name: network-name
25743           in: query
25744           description: Name of the network
25745           required: false
25746           type: string
25747   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
25748     put:
25749       tags:
25750         - Network
25751       summary: see node definition for valid relationships
25752       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
25753       consumes:
25754         - application/json
25755         - application/xml
25756       produces:
25757         - application/json
25758         - application/xml
25759       responses:
25760         "default":
25761           description: Response codes found in [response codes](https://wiki.onap.org/).
25762       parameters:
25763         - name: equipment-name
25764           in: path
25765           required: true
25766           type: string
25767           example: __EQUIPMENT-NAME__
25768         - name: interface-name
25769           in: path
25770           description: Name that identifies the link aggregate interface
25771           required: true
25772           type: string
25773           example: __INTERFACE-NAME__
25774         - name: interface-name
25775           in: path
25776           description: Name given to the interface
25777           required: true
25778           type: string
25779           example: __INTERFACE-NAME__
25780         - name: body
25781           in: body
25782           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
25783           required: true
25784           schema:
25785             $ref: "#/definitions/relationship"
25786     delete:
25787       tags:
25788         - Network
25789       summary: delete an existing relationship
25790       description: delete an existing relationship
25791       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
25792       consumes:
25793         - application/json
25794         - application/xml
25795       produces:
25796         - application/json
25797         - application/xml
25798       responses:
25799         "default":
25800           description: Response codes found in [response codes](https://wiki.onap.org/).
25801       parameters:
25802         - name: equipment-name
25803           in: path
25804           required: true
25805           type: string
25806           example: __EQUIPMENT-NAME__
25807         - name: interface-name
25808           in: path
25809           description: Name that identifies the link aggregate interface
25810           required: true
25811           type: string
25812           example: __INTERFACE-NAME__
25813         - name: interface-name
25814           in: path
25815           description: Name given to the interface
25816           required: true
25817           type: string
25818           example: __INTERFACE-NAME__
25819   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
25820     put:
25821       tags:
25822         - Network
25823       summary: see node definition for valid relationships
25824       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
25825       consumes:
25826         - application/json
25827         - application/xml
25828       produces:
25829         - application/json
25830         - application/xml
25831       responses:
25832         "default":
25833           description: Response codes found in [response codes](https://wiki.onap.org/).
25834       parameters:
25835         - name: equipment-name
25836           in: path
25837           required: true
25838           type: string
25839           example: __EQUIPMENT-NAME__
25840         - name: interface-name
25841           in: path
25842           description: Name that identifies the link aggregate interface
25843           required: true
25844           type: string
25845           example: __INTERFACE-NAME__
25846         - name: interface-name
25847           in: path
25848           description: Name given to the interface
25849           required: true
25850           type: string
25851           example: __INTERFACE-NAME__
25852         - name: l3-interface-ipv4-address
25853           in: path
25854           description: IP address
25855           required: true
25856           type: string
25857           example: __L3-INTERFACE-IPV4-ADDRESS__
25858         - name: body
25859           in: body
25860           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
25861           required: true
25862           schema:
25863             $ref: "#/definitions/relationship"
25864     delete:
25865       tags:
25866         - Network
25867       summary: delete an existing relationship
25868       description: delete an existing relationship
25869       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
25870       consumes:
25871         - application/json
25872         - application/xml
25873       produces:
25874         - application/json
25875         - application/xml
25876       responses:
25877         "default":
25878           description: Response codes found in [response codes](https://wiki.onap.org/).
25879       parameters:
25880         - name: equipment-name
25881           in: path
25882           required: true
25883           type: string
25884           example: __EQUIPMENT-NAME__
25885         - name: interface-name
25886           in: path
25887           description: Name that identifies the link aggregate interface
25888           required: true
25889           type: string
25890           example: __INTERFACE-NAME__
25891         - name: interface-name
25892           in: path
25893           description: Name given to the interface
25894           required: true
25895           type: string
25896           example: __INTERFACE-NAME__
25897         - name: l3-interface-ipv4-address
25898           in: path
25899           description: IP address
25900           required: true
25901           type: string
25902           example: __L3-INTERFACE-IPV4-ADDRESS__
25903   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
25904     get:
25905       tags:
25906         - Network
25907       summary: returns l3-interface-ipv4-address-list
25908       description: returns l3-interface-ipv4-address-list
25909       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
25910       produces:
25911         - application/json
25912         - application/xml
25913       responses:
25914         "200":
25915           description: successful operation
25916           schema:
25917               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
25918         "default":
25919           description: Response codes found in [response codes](https://wiki.onap.org/).
25920       parameters:
25921         - name: equipment-name
25922           in: path
25923           required: true
25924           type: string
25925           example: __EQUIPMENT-NAME__
25926         - name: interface-name
25927           in: path
25928           description: Name that identifies the link aggregate interface
25929           required: true
25930           type: string
25931           example: __INTERFACE-NAME__
25932         - name: interface-name
25933           in: path
25934           description: Name given to the interface
25935           required: true
25936           type: string
25937           example: __INTERFACE-NAME__
25938         - name: l3-interface-ipv4-address
25939           in: path
25940           description: IP address
25941           required: true
25942           type: string
25943           example: __L3-INTERFACE-IPV4-ADDRESS__
25944         - name: prov-status
25945           in: query
25946           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
25947           required: false
25948           type: string
25949         - name: interface-id
25950           in: query
25951           description: ID of interface
25952           required: false
25953           type: string
25954         - name: interface-role
25955           in: query
25956           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
25957           required: false
25958           type: string
25959         - name: interface-id
25960           in: query
25961           description: ID of interface
25962           required: false
25963           type: string
25964         - name: macaddr
25965           in: query
25966           description: MAC address for the interface
25967           required: false
25968           type: string
25969         - name: network-name
25970           in: query
25971           description: Name of the network
25972           required: false
25973           type: string
25974         - name: vlan-id-inner
25975           in: query
25976           description: Inner VLAN tag
25977           required: false
25978           type: integer
25979           format: int64
25980         - name: neutron-network-id
25981           in: query
25982           description: Neutron network id of the interface that address belongs to
25983           required: false
25984           type: string
25985         - name: neutron-subnet-id
25986           in: query
25987           description: Neutron id of subnet that address belongs to
25988           required: false
25989           type: string
25990     put:
25991       tags:
25992         - Network
25993       summary: create or update an existing l3-interface-ipv4-address-list
25994       description: |
25995         Create or update an existing l3-interface-ipv4-address-list.
25996         #
25997         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
25998       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
25999       consumes:
26000         - application/json
26001         - application/xml
26002       produces:
26003         - application/json
26004         - application/xml
26005       responses:
26006         "default":
26007           description: Response codes found in [response codes](https://wiki.onap.org/).
26008       parameters:
26009         - name: equipment-name
26010           in: path
26011           required: true
26012           type: string
26013           example: __EQUIPMENT-NAME__
26014         - name: interface-name
26015           in: path
26016           description: Name that identifies the link aggregate interface
26017           required: true
26018           type: string
26019           example: __INTERFACE-NAME__
26020         - name: interface-name
26021           in: path
26022           description: Name given to the interface
26023           required: true
26024           type: string
26025           example: __INTERFACE-NAME__
26026         - name: l3-interface-ipv4-address
26027           in: path
26028           description: IP address
26029           required: true
26030           type: string
26031           example: __L3-INTERFACE-IPV4-ADDRESS__
26032         - name: body
26033           in: body
26034           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
26035           required: true
26036           schema:
26037             $ref: "#/definitions/l3-interface-ipv4-address-list"
26038     patch:
26039       tags:
26040         - Network
26041       summary: update an existing l3-interface-ipv4-address-list
26042       description: |
26043         Update an existing l3-interface-ipv4-address-list
26044         #
26045         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26046         The PUT operation will entirely replace an existing object.
26047         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
26048         #
26049         Other differences between PUT and PATCH are:
26050         #
26051         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
26052         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26053         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26054       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
26055       consumes:
26056         - application/json
26057         - application/xml
26058       produces:
26059         - application/json
26060         - application/xml
26061       responses:
26062         "default":
26063           description: Response codes found in [response codes](https://wiki.onap.org/).
26064       parameters:
26065         - name: equipment-name
26066           in: path
26067           required: true
26068           type: string
26069           example: __EQUIPMENT-NAME__
26070         - name: interface-name
26071           in: path
26072           description: Name that identifies the link aggregate interface
26073           required: true
26074           type: string
26075           example: __INTERFACE-NAME__
26076         - name: interface-name
26077           in: path
26078           description: Name given to the interface
26079           required: true
26080           type: string
26081           example: __INTERFACE-NAME__
26082         - name: l3-interface-ipv4-address
26083           in: path
26084           description: IP address
26085           required: true
26086           type: string
26087           example: __L3-INTERFACE-IPV4-ADDRESS__
26088         - name: body
26089           in: body
26090           description: l3-interface-ipv4-address-list object that needs to be created or updated.
26091           required: true
26092           schema:
26093             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
26094     delete:
26095       tags:
26096         - Network
26097       summary: delete an existing l3-interface-ipv4-address-list
26098       description: delete an existing l3-interface-ipv4-address-list
26099       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
26100       consumes:
26101         - application/json
26102         - application/xml
26103       produces:
26104         - application/json
26105         - application/xml
26106       responses:
26107         "default":
26108           description: Response codes found in [response codes](https://wiki.onap.org/).
26109       parameters:
26110         - name: equipment-name
26111           in: path
26112           required: true
26113           type: string
26114           example: __EQUIPMENT-NAME__
26115         - name: interface-name
26116           in: path
26117           description: Name that identifies the link aggregate interface
26118           required: true
26119           type: string
26120           example: __INTERFACE-NAME__
26121         - name: interface-name
26122           in: path
26123           description: Name given to the interface
26124           required: true
26125           type: string
26126           example: __INTERFACE-NAME__
26127         - name: l3-interface-ipv4-address
26128           in: path
26129           description: IP address
26130           required: true
26131           type: string
26132           example: __L3-INTERFACE-IPV4-ADDRESS__
26133         - name: resource-version
26134           in: query
26135           description: resource-version for concurrency
26136           required: true
26137           type: string
26138   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
26139     put:
26140       tags:
26141         - Network
26142       summary: see node definition for valid relationships
26143       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
26144       consumes:
26145         - application/json
26146         - application/xml
26147       produces:
26148         - application/json
26149         - application/xml
26150       responses:
26151         "default":
26152           description: Response codes found in [response codes](https://wiki.onap.org/).
26153       parameters:
26154         - name: equipment-name
26155           in: path
26156           required: true
26157           type: string
26158           example: __EQUIPMENT-NAME__
26159         - name: interface-name
26160           in: path
26161           description: Name that identifies the link aggregate interface
26162           required: true
26163           type: string
26164           example: __INTERFACE-NAME__
26165         - name: interface-name
26166           in: path
26167           description: Name given to the interface
26168           required: true
26169           type: string
26170           example: __INTERFACE-NAME__
26171         - name: l3-interface-ipv6-address
26172           in: path
26173           description: IP address
26174           required: true
26175           type: string
26176           example: __L3-INTERFACE-IPV6-ADDRESS__
26177         - name: body
26178           in: body
26179           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
26180           required: true
26181           schema:
26182             $ref: "#/definitions/relationship"
26183     delete:
26184       tags:
26185         - Network
26186       summary: delete an existing relationship
26187       description: delete an existing relationship
26188       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
26189       consumes:
26190         - application/json
26191         - application/xml
26192       produces:
26193         - application/json
26194         - application/xml
26195       responses:
26196         "default":
26197           description: Response codes found in [response codes](https://wiki.onap.org/).
26198       parameters:
26199         - name: equipment-name
26200           in: path
26201           required: true
26202           type: string
26203           example: __EQUIPMENT-NAME__
26204         - name: interface-name
26205           in: path
26206           description: Name that identifies the link aggregate interface
26207           required: true
26208           type: string
26209           example: __INTERFACE-NAME__
26210         - name: interface-name
26211           in: path
26212           description: Name given to the interface
26213           required: true
26214           type: string
26215           example: __INTERFACE-NAME__
26216         - name: l3-interface-ipv6-address
26217           in: path
26218           description: IP address
26219           required: true
26220           type: string
26221           example: __L3-INTERFACE-IPV6-ADDRESS__
26222   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
26223     get:
26224       tags:
26225         - Network
26226       summary: returns l3-interface-ipv6-address-list
26227       description: returns l3-interface-ipv6-address-list
26228       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
26229       produces:
26230         - application/json
26231         - application/xml
26232       responses:
26233         "200":
26234           description: successful operation
26235           schema:
26236               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
26237         "default":
26238           description: Response codes found in [response codes](https://wiki.onap.org/).
26239       parameters:
26240         - name: equipment-name
26241           in: path
26242           required: true
26243           type: string
26244           example: __EQUIPMENT-NAME__
26245         - name: interface-name
26246           in: path
26247           description: Name that identifies the link aggregate interface
26248           required: true
26249           type: string
26250           example: __INTERFACE-NAME__
26251         - name: interface-name
26252           in: path
26253           description: Name given to the interface
26254           required: true
26255           type: string
26256           example: __INTERFACE-NAME__
26257         - name: l3-interface-ipv6-address
26258           in: path
26259           description: IP address
26260           required: true
26261           type: string
26262           example: __L3-INTERFACE-IPV6-ADDRESS__
26263         - name: prov-status
26264           in: query
26265           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
26266           required: false
26267           type: string
26268         - name: interface-id
26269           in: query
26270           description: ID of interface
26271           required: false
26272           type: string
26273         - name: interface-role
26274           in: query
26275           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
26276           required: false
26277           type: string
26278         - name: interface-id
26279           in: query
26280           description: ID of interface
26281           required: false
26282           type: string
26283         - name: macaddr
26284           in: query
26285           description: MAC address for the interface
26286           required: false
26287           type: string
26288         - name: network-name
26289           in: query
26290           description: Name of the network
26291           required: false
26292           type: string
26293         - name: vlan-id-inner
26294           in: query
26295           description: Inner VLAN tag
26296           required: false
26297           type: integer
26298           format: int64
26299         - name: neutron-network-id
26300           in: query
26301           description: Neutron network id of the interface that address belongs to
26302           required: false
26303           type: string
26304         - name: neutron-subnet-id
26305           in: query
26306           description: Neutron id of subnet that address belongs to
26307           required: false
26308           type: string
26309     put:
26310       tags:
26311         - Network
26312       summary: create or update an existing l3-interface-ipv6-address-list
26313       description: |
26314         Create or update an existing l3-interface-ipv6-address-list.
26315         #
26316         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
26317       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
26318       consumes:
26319         - application/json
26320         - application/xml
26321       produces:
26322         - application/json
26323         - application/xml
26324       responses:
26325         "default":
26326           description: Response codes found in [response codes](https://wiki.onap.org/).
26327       parameters:
26328         - name: equipment-name
26329           in: path
26330           required: true
26331           type: string
26332           example: __EQUIPMENT-NAME__
26333         - name: interface-name
26334           in: path
26335           description: Name that identifies the link aggregate interface
26336           required: true
26337           type: string
26338           example: __INTERFACE-NAME__
26339         - name: interface-name
26340           in: path
26341           description: Name given to the interface
26342           required: true
26343           type: string
26344           example: __INTERFACE-NAME__
26345         - name: l3-interface-ipv6-address
26346           in: path
26347           description: IP address
26348           required: true
26349           type: string
26350           example: __L3-INTERFACE-IPV6-ADDRESS__
26351         - name: body
26352           in: body
26353           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
26354           required: true
26355           schema:
26356             $ref: "#/definitions/l3-interface-ipv6-address-list"
26357     patch:
26358       tags:
26359         - Network
26360       summary: update an existing l3-interface-ipv6-address-list
26361       description: |
26362         Update an existing l3-interface-ipv6-address-list
26363         #
26364         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26365         The PUT operation will entirely replace an existing object.
26366         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
26367         #
26368         Other differences between PUT and PATCH are:
26369         #
26370         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
26371         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26372         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26373       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
26374       consumes:
26375         - application/json
26376         - application/xml
26377       produces:
26378         - application/json
26379         - application/xml
26380       responses:
26381         "default":
26382           description: Response codes found in [response codes](https://wiki.onap.org/).
26383       parameters:
26384         - name: equipment-name
26385           in: path
26386           required: true
26387           type: string
26388           example: __EQUIPMENT-NAME__
26389         - name: interface-name
26390           in: path
26391           description: Name that identifies the link aggregate interface
26392           required: true
26393           type: string
26394           example: __INTERFACE-NAME__
26395         - name: interface-name
26396           in: path
26397           description: Name given to the interface
26398           required: true
26399           type: string
26400           example: __INTERFACE-NAME__
26401         - name: l3-interface-ipv6-address
26402           in: path
26403           description: IP address
26404           required: true
26405           type: string
26406           example: __L3-INTERFACE-IPV6-ADDRESS__
26407         - name: body
26408           in: body
26409           description: l3-interface-ipv6-address-list object that needs to be created or updated.
26410           required: true
26411           schema:
26412             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
26413     delete:
26414       tags:
26415         - Network
26416       summary: delete an existing l3-interface-ipv6-address-list
26417       description: delete an existing l3-interface-ipv6-address-list
26418       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
26419       consumes:
26420         - application/json
26421         - application/xml
26422       produces:
26423         - application/json
26424         - application/xml
26425       responses:
26426         "default":
26427           description: Response codes found in [response codes](https://wiki.onap.org/).
26428       parameters:
26429         - name: equipment-name
26430           in: path
26431           required: true
26432           type: string
26433           example: __EQUIPMENT-NAME__
26434         - name: interface-name
26435           in: path
26436           description: Name that identifies the link aggregate interface
26437           required: true
26438           type: string
26439           example: __INTERFACE-NAME__
26440         - name: interface-name
26441           in: path
26442           description: Name given to the interface
26443           required: true
26444           type: string
26445           example: __INTERFACE-NAME__
26446         - name: l3-interface-ipv6-address
26447           in: path
26448           description: IP address
26449           required: true
26450           type: string
26451           example: __L3-INTERFACE-IPV6-ADDRESS__
26452         - name: resource-version
26453           in: query
26454           description: resource-version for concurrency
26455           required: true
26456           type: string
26457   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
26458     get:
26459       tags:
26460         - Network
26461       summary: returns l-interface
26462       description: returns l-interface
26463       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
26464       produces:
26465         - application/json
26466         - application/xml
26467       responses:
26468         "200":
26469           description: successful operation
26470           schema:
26471               $ref: "#/getDefinitions/l-interface"
26472         "default":
26473           description: Response codes found in [response codes](https://wiki.onap.org/).
26474       parameters:
26475         - name: equipment-name
26476           in: path
26477           required: true
26478           type: string
26479           example: __EQUIPMENT-NAME__
26480         - name: interface-name
26481           in: path
26482           description: Name that identifies the link aggregate interface
26483           required: true
26484           type: string
26485           example: __INTERFACE-NAME__
26486         - name: interface-name
26487           in: path
26488           description: Name given to the interface
26489           required: true
26490           type: string
26491           example: __INTERFACE-NAME__
26492         - name: prov-status
26493           in: query
26494           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
26495           required: false
26496           type: string
26497         - name: interface-id
26498           in: query
26499           description: ID of interface
26500           required: false
26501           type: string
26502         - name: interface-role
26503           in: query
26504           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
26505           required: false
26506           type: string
26507         - name: interface-id
26508           in: query
26509           description: ID of interface
26510           required: false
26511           type: string
26512         - name: macaddr
26513           in: query
26514           description: MAC address for the interface
26515           required: false
26516           type: string
26517         - name: network-name
26518           in: query
26519           description: Name of the network
26520           required: false
26521           type: string
26522     put:
26523       tags:
26524         - Network
26525       summary: create or update an existing l-interface
26526       description: |
26527         Create or update an existing l-interface.
26528         #
26529         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
26530       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
26531       consumes:
26532         - application/json
26533         - application/xml
26534       produces:
26535         - application/json
26536         - application/xml
26537       responses:
26538         "default":
26539           description: Response codes found in [response codes](https://wiki.onap.org/).
26540       parameters:
26541         - name: equipment-name
26542           in: path
26543           required: true
26544           type: string
26545           example: __EQUIPMENT-NAME__
26546         - name: interface-name
26547           in: path
26548           description: Name that identifies the link aggregate interface
26549           required: true
26550           type: string
26551           example: __INTERFACE-NAME__
26552         - name: interface-name
26553           in: path
26554           description: Name given to the interface
26555           required: true
26556           type: string
26557           example: __INTERFACE-NAME__
26558         - name: body
26559           in: body
26560           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
26561           required: true
26562           schema:
26563             $ref: "#/definitions/l-interface"
26564     patch:
26565       tags:
26566         - Network
26567       summary: update an existing l-interface
26568       description: |
26569         Update an existing l-interface
26570         #
26571         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26572         The PUT operation will entirely replace an existing object.
26573         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
26574         #
26575         Other differences between PUT and PATCH are:
26576         #
26577         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
26578         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26579         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26580       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
26581       consumes:
26582         - application/json
26583         - application/xml
26584       produces:
26585         - application/json
26586         - application/xml
26587       responses:
26588         "default":
26589           description: Response codes found in [response codes](https://wiki.onap.org/).
26590       parameters:
26591         - name: equipment-name
26592           in: path
26593           required: true
26594           type: string
26595           example: __EQUIPMENT-NAME__
26596         - name: interface-name
26597           in: path
26598           description: Name that identifies the link aggregate interface
26599           required: true
26600           type: string
26601           example: __INTERFACE-NAME__
26602         - name: interface-name
26603           in: path
26604           description: Name given to the interface
26605           required: true
26606           type: string
26607           example: __INTERFACE-NAME__
26608         - name: body
26609           in: body
26610           description: l-interface object that needs to be created or updated.
26611           required: true
26612           schema:
26613             $ref: "#/patchDefinitions/l-interface"
26614     delete:
26615       tags:
26616         - Network
26617       summary: delete an existing l-interface
26618       description: delete an existing l-interface
26619       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
26620       consumes:
26621         - application/json
26622         - application/xml
26623       produces:
26624         - application/json
26625         - application/xml
26626       responses:
26627         "default":
26628           description: Response codes found in [response codes](https://wiki.onap.org/).
26629       parameters:
26630         - name: equipment-name
26631           in: path
26632           required: true
26633           type: string
26634           example: __EQUIPMENT-NAME__
26635         - name: interface-name
26636           in: path
26637           description: Name that identifies the link aggregate interface
26638           required: true
26639           type: string
26640           example: __INTERFACE-NAME__
26641         - name: interface-name
26642           in: path
26643           description: Name given to the interface
26644           required: true
26645           type: string
26646           example: __INTERFACE-NAME__
26647         - name: resource-version
26648           in: query
26649           description: resource-version for concurrency
26650           required: true
26651           type: string
26652   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
26653     get:
26654       tags:
26655         - Network
26656       summary: returns l-interfaces
26657       description: returns l-interfaces
26658       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfaces
26659       produces:
26660         - application/json
26661         - application/xml
26662       responses:
26663         "200":
26664           description: successful operation
26665           schema:
26666               $ref: "#/getDefinitions/l-interfaces"
26667         "default":
26668           description: Response codes found in [response codes](https://wiki.onap.org/).
26669       parameters:
26670         - name: equipment-name
26671           in: path
26672           required: true
26673           type: string
26674           example: __EQUIPMENT-NAME__
26675         - name: interface-name
26676           in: path
26677           description: Name that identifies the link aggregate interface
26678           required: true
26679           type: string
26680           example: __INTERFACE-NAME__
26681         - name: prov-status
26682           in: query
26683           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
26684           required: false
26685           type: string
26686         - name: interface-id
26687           in: query
26688           description: ID of interface
26689           required: false
26690           type: string
26691         - name: interface-role
26692           in: query
26693           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
26694           required: false
26695           type: string
26696   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}:
26697     get:
26698       tags:
26699         - Network
26700       summary: returns lag-interface
26701       description: returns lag-interface
26702       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterface
26703       produces:
26704         - application/json
26705         - application/xml
26706       responses:
26707         "200":
26708           description: successful operation
26709           schema:
26710               $ref: "#/getDefinitions/lag-interface"
26711         "default":
26712           description: Response codes found in [response codes](https://wiki.onap.org/).
26713       parameters:
26714         - name: equipment-name
26715           in: path
26716           required: true
26717           type: string
26718           example: __EQUIPMENT-NAME__
26719         - name: interface-name
26720           in: path
26721           description: Name that identifies the link aggregate interface
26722           required: true
26723           type: string
26724           example: __INTERFACE-NAME__
26725         - name: prov-status
26726           in: query
26727           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
26728           required: false
26729           type: string
26730         - name: interface-id
26731           in: query
26732           description: ID of interface
26733           required: false
26734           type: string
26735         - name: interface-role
26736           in: query
26737           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
26738           required: false
26739           type: string
26740     put:
26741       tags:
26742         - Network
26743       summary: create or update an existing lag-interface
26744       description: |
26745         Create or update an existing lag-interface.
26746         #
26747         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
26748       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
26749       consumes:
26750         - application/json
26751         - application/xml
26752       produces:
26753         - application/json
26754         - application/xml
26755       responses:
26756         "default":
26757           description: Response codes found in [response codes](https://wiki.onap.org/).
26758       parameters:
26759         - name: equipment-name
26760           in: path
26761           required: true
26762           type: string
26763           example: __EQUIPMENT-NAME__
26764         - name: interface-name
26765           in: path
26766           description: Name that identifies the link aggregate interface
26767           required: true
26768           type: string
26769           example: __INTERFACE-NAME__
26770         - name: body
26771           in: body
26772           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
26773           required: true
26774           schema:
26775             $ref: "#/definitions/lag-interface"
26776     patch:
26777       tags:
26778         - Network
26779       summary: update an existing lag-interface
26780       description: |
26781         Update an existing lag-interface
26782         #
26783         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26784         The PUT operation will entirely replace an existing object.
26785         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
26786         #
26787         Other differences between PUT and PATCH are:
26788         #
26789         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
26790         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26791         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26792       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
26793       consumes:
26794         - application/json
26795         - application/xml
26796       produces:
26797         - application/json
26798         - application/xml
26799       responses:
26800         "default":
26801           description: Response codes found in [response codes](https://wiki.onap.org/).
26802       parameters:
26803         - name: equipment-name
26804           in: path
26805           required: true
26806           type: string
26807           example: __EQUIPMENT-NAME__
26808         - name: interface-name
26809           in: path
26810           description: Name that identifies the link aggregate interface
26811           required: true
26812           type: string
26813           example: __INTERFACE-NAME__
26814         - name: body
26815           in: body
26816           description: lag-interface object that needs to be created or updated.
26817           required: true
26818           schema:
26819             $ref: "#/patchDefinitions/lag-interface"
26820     delete:
26821       tags:
26822         - Network
26823       summary: delete an existing lag-interface
26824       description: delete an existing lag-interface
26825       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterface
26826       consumes:
26827         - application/json
26828         - application/xml
26829       produces:
26830         - application/json
26831         - application/xml
26832       responses:
26833         "default":
26834           description: Response codes found in [response codes](https://wiki.onap.org/).
26835       parameters:
26836         - name: equipment-name
26837           in: path
26838           required: true
26839           type: string
26840           example: __EQUIPMENT-NAME__
26841         - name: interface-name
26842           in: path
26843           description: Name that identifies the link aggregate interface
26844           required: true
26845           type: string
26846           example: __INTERFACE-NAME__
26847         - name: resource-version
26848           in: query
26849           description: resource-version for concurrency
26850           required: true
26851           type: string
26852   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces:
26853     get:
26854       tags:
26855         - Network
26856       summary: returns lag-interfaces
26857       description: returns lag-interfaces
26858       operationId: getNetworkVplsPesVplsPeLagInterfaces
26859       produces:
26860         - application/json
26861         - application/xml
26862       responses:
26863         "200":
26864           description: successful operation
26865           schema:
26866               $ref: "#/getDefinitions/lag-interfaces"
26867         "default":
26868           description: Response codes found in [response codes](https://wiki.onap.org/).
26869       parameters:
26870         - name: equipment-name
26871           in: path
26872           required: true
26873           type: string
26874           example: __EQUIPMENT-NAME__
26875         - name: prov-status
26876           in: query
26877           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
26878           required: false
26879           type: string
26880   /network/vpls-pes/vpls-pe/{equipment-name}:
26881     get:
26882       tags:
26883         - Network
26884       summary: returns vpls-pe
26885       description: returns vpls-pe
26886       operationId: getNetworkVplsPesVplsPe
26887       produces:
26888         - application/json
26889         - application/xml
26890       responses:
26891         "200":
26892           description: successful operation
26893           schema:
26894               $ref: "#/getDefinitions/vpls-pe"
26895         "default":
26896           description: Response codes found in [response codes](https://wiki.onap.org/).
26897       parameters:
26898         - name: equipment-name
26899           in: path
26900           required: true
26901           type: string
26902           example: __EQUIPMENT-NAME__
26903         - name: prov-status
26904           in: query
26905           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
26906           required: false
26907           type: string
26908     put:
26909       tags:
26910         - Network
26911       summary: create or update an existing vpls-pe
26912       description: |
26913         Create or update an existing vpls-pe.
26914         #
26915         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
26916       operationId: createOrUpdateNetworkVplsPesVplsPe
26917       consumes:
26918         - application/json
26919         - application/xml
26920       produces:
26921         - application/json
26922         - application/xml
26923       responses:
26924         "default":
26925           description: Response codes found in [response codes](https://wiki.onap.org/).
26926       parameters:
26927         - name: equipment-name
26928           in: path
26929           required: true
26930           type: string
26931           example: __EQUIPMENT-NAME__
26932         - name: body
26933           in: body
26934           description: vpls-pe object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPe.json)
26935           required: true
26936           schema:
26937             $ref: "#/definitions/vpls-pe"
26938     patch:
26939       tags:
26940         - Network
26941       summary: update an existing vpls-pe
26942       description: |
26943         Update an existing vpls-pe
26944         #
26945         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26946         The PUT operation will entirely replace an existing object.
26947         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
26948         #
26949         Other differences between PUT and PATCH are:
26950         #
26951         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
26952         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26953         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26954       operationId: UpdateNetworkVplsPesVplsPe
26955       consumes:
26956         - application/json
26957         - application/xml
26958       produces:
26959         - application/json
26960         - application/xml
26961       responses:
26962         "default":
26963           description: Response codes found in [response codes](https://wiki.onap.org/).
26964       parameters:
26965         - name: equipment-name
26966           in: path
26967           required: true
26968           type: string
26969           example: __EQUIPMENT-NAME__
26970         - name: body
26971           in: body
26972           description: vpls-pe object that needs to be created or updated.
26973           required: true
26974           schema:
26975             $ref: "#/patchDefinitions/vpls-pe"
26976     delete:
26977       tags:
26978         - Network
26979       summary: delete an existing vpls-pe
26980       description: delete an existing vpls-pe
26981       operationId: deleteNetworkVplsPesVplsPe
26982       consumes:
26983         - application/json
26984         - application/xml
26985       produces:
26986         - application/json
26987         - application/xml
26988       responses:
26989         "default":
26990           description: Response codes found in [response codes](https://wiki.onap.org/).
26991       parameters:
26992         - name: equipment-name
26993           in: path
26994           required: true
26995           type: string
26996           example: __EQUIPMENT-NAME__
26997         - name: resource-version
26998           in: query
26999           description: resource-version for concurrency
27000           required: true
27001           type: string
27002   /network/vpls-pes:
27003     get:
27004       tags:
27005         - Network
27006       summary: returns vpls-pes
27007       description: returns vpls-pes
27008       operationId: getNetworkVplsPes
27009       produces:
27010         - application/json
27011         - application/xml
27012       responses:
27013         "200":
27014           description: successful operation
27015           schema:
27016               $ref: "#/getDefinitions/vpls-pes"
27017         "default":
27018           description: Response codes found in [response codes](https://wiki.onap.org/).
27019   /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship:
27020     put:
27021       tags:
27022         - Network
27023       summary: see node definition for valid relationships
27024       operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
27025       consumes:
27026         - application/json
27027         - application/xml
27028       produces:
27029         - application/json
27030         - application/xml
27031       responses:
27032         "default":
27033           description: Response codes found in [response codes](https://wiki.onap.org/).
27034       parameters:
27035         - name: multicast-configuration-id
27036           in: path
27037           description: Unique id of multicast configuration.
27038           required: true
27039           type: string
27040           example: __MULTICAST-CONFIGURATION-ID__
27041         - name: body
27042           in: body
27043           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkMulticastConfigurationsMulticastConfiguration.json)
27044           required: true
27045           schema:
27046             $ref: "#/definitions/relationship"
27047     delete:
27048       tags:
27049         - Network
27050       summary: delete an existing relationship
27051       description: delete an existing relationship
27052       operationId: deleteNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
27053       consumes:
27054         - application/json
27055         - application/xml
27056       produces:
27057         - application/json
27058         - application/xml
27059       responses:
27060         "default":
27061           description: Response codes found in [response codes](https://wiki.onap.org/).
27062       parameters:
27063         - name: multicast-configuration-id
27064           in: path
27065           description: Unique id of multicast configuration.
27066           required: true
27067           type: string
27068           example: __MULTICAST-CONFIGURATION-ID__
27069   /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}:
27070     get:
27071       tags:
27072         - Network
27073       summary: returns multicast-configuration
27074       description: returns multicast-configuration
27075       operationId: getNetworkMulticastConfigurationsMulticastConfiguration
27076       produces:
27077         - application/json
27078         - application/xml
27079       responses:
27080         "200":
27081           description: successful operation
27082           schema:
27083               $ref: "#/getDefinitions/multicast-configuration"
27084         "default":
27085           description: Response codes found in [response codes](https://wiki.onap.org/).
27086       parameters:
27087         - name: multicast-configuration-id
27088           in: path
27089           description: Unique id of multicast configuration.
27090           required: true
27091           type: string
27092           example: __MULTICAST-CONFIGURATION-ID__
27093     put:
27094       tags:
27095         - Network
27096       summary: create or update an existing multicast-configuration
27097       description: |
27098         Create or update an existing multicast-configuration.
27099         #
27100         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
27101       operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfiguration
27102       consumes:
27103         - application/json
27104         - application/xml
27105       produces:
27106         - application/json
27107         - application/xml
27108       responses:
27109         "default":
27110           description: Response codes found in [response codes](https://wiki.onap.org/).
27111       parameters:
27112         - name: multicast-configuration-id
27113           in: path
27114           description: Unique id of multicast configuration.
27115           required: true
27116           type: string
27117           example: __MULTICAST-CONFIGURATION-ID__
27118         - name: body
27119           in: body
27120           description: multicast-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkMulticastConfigurationsMulticastConfiguration.json)
27121           required: true
27122           schema:
27123             $ref: "#/definitions/multicast-configuration"
27124     patch:
27125       tags:
27126         - Network
27127       summary: update an existing multicast-configuration
27128       description: |
27129         Update an existing multicast-configuration
27130         #
27131         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27132         The PUT operation will entirely replace an existing object.
27133         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
27134         #
27135         Other differences between PUT and PATCH are:
27136         #
27137         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
27138         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27139         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27140       operationId: UpdateNetworkMulticastConfigurationsMulticastConfiguration
27141       consumes:
27142         - application/json
27143         - application/xml
27144       produces:
27145         - application/json
27146         - application/xml
27147       responses:
27148         "default":
27149           description: Response codes found in [response codes](https://wiki.onap.org/).
27150       parameters:
27151         - name: multicast-configuration-id
27152           in: path
27153           description: Unique id of multicast configuration.
27154           required: true
27155           type: string
27156           example: __MULTICAST-CONFIGURATION-ID__
27157         - name: body
27158           in: body
27159           description: multicast-configuration object that needs to be created or updated.
27160           required: true
27161           schema:
27162             $ref: "#/patchDefinitions/multicast-configuration"
27163     delete:
27164       tags:
27165         - Network
27166       summary: delete an existing multicast-configuration
27167       description: delete an existing multicast-configuration
27168       operationId: deleteNetworkMulticastConfigurationsMulticastConfiguration
27169       consumes:
27170         - application/json
27171         - application/xml
27172       produces:
27173         - application/json
27174         - application/xml
27175       responses:
27176         "default":
27177           description: Response codes found in [response codes](https://wiki.onap.org/).
27178       parameters:
27179         - name: multicast-configuration-id
27180           in: path
27181           description: Unique id of multicast configuration.
27182           required: true
27183           type: string
27184           example: __MULTICAST-CONFIGURATION-ID__
27185         - name: resource-version
27186           in: query
27187           description: resource-version for concurrency
27188           required: true
27189           type: string
27190   /network/multicast-configurations:
27191     get:
27192       tags:
27193         - Network
27194       summary: returns multicast-configurations
27195       description: returns multicast-configurations
27196       operationId: getNetworkMulticastConfigurations
27197       produces:
27198         - application/json
27199         - application/xml
27200       responses:
27201         "200":
27202           description: successful operation
27203           schema:
27204               $ref: "#/getDefinitions/multicast-configurations"
27205         "default":
27206           description: Response codes found in [response codes](https://wiki.onap.org/).
27207   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship:
27208     put:
27209       tags:
27210         - Network
27211       summary: see node definition for valid relationships
27212       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
27213       consumes:
27214         - application/json
27215         - application/xml
27216       produces:
27217         - application/json
27218         - application/xml
27219       responses:
27220         "default":
27221           description: Response codes found in [response codes](https://wiki.onap.org/).
27222       parameters:
27223         - name: vnf-id
27224           in: path
27225           description: Unique id of VNF.  This is unique across the graph.
27226           required: true
27227           type: string
27228           example: __VNF-ID__
27229         - name: interface-id
27230           in: path
27231           description: Unique ID of the interface
27232           required: true
27233           type: string
27234           example: __INTERFACE-ID__
27235         - name: cvlan-tag
27236           in: path
27237           description: See mis-na-virtualization-platform.yang
27238           required: true
27239           type: integer
27240           format: int64
27241           example: __CVLAN-TAG__
27242         - name: body
27243           in: body
27244           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
27245           required: true
27246           schema:
27247             $ref: "#/definitions/relationship"
27248     delete:
27249       tags:
27250         - Network
27251       summary: delete an existing relationship
27252       description: delete an existing relationship
27253       operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
27254       consumes:
27255         - application/json
27256         - application/xml
27257       produces:
27258         - application/json
27259         - application/xml
27260       responses:
27261         "default":
27262           description: Response codes found in [response codes](https://wiki.onap.org/).
27263       parameters:
27264         - name: vnf-id
27265           in: path
27266           description: Unique id of VNF.  This is unique across the graph.
27267           required: true
27268           type: string
27269           example: __VNF-ID__
27270         - name: interface-id
27271           in: path
27272           description: Unique ID of the interface
27273           required: true
27274           type: string
27275           example: __INTERFACE-ID__
27276         - name: cvlan-tag
27277           in: path
27278           description: See mis-na-virtualization-platform.yang
27279           required: true
27280           type: integer
27281           format: int64
27282           example: __CVLAN-TAG__
27283   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}:
27284     get:
27285       tags:
27286         - Network
27287       summary: returns cvlan-tag-entry
27288       description: returns cvlan-tag-entry
27289       operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
27290       produces:
27291         - application/json
27292         - application/xml
27293       responses:
27294         "200":
27295           description: successful operation
27296           schema:
27297               $ref: "#/getDefinitions/cvlan-tag-entry"
27298         "default":
27299           description: Response codes found in [response codes](https://wiki.onap.org/).
27300       parameters:
27301         - name: vnf-id
27302           in: path
27303           description: Unique id of VNF.  This is unique across the graph.
27304           required: true
27305           type: string
27306           example: __VNF-ID__
27307         - name: interface-id
27308           in: path
27309           description: Unique ID of the interface
27310           required: true
27311           type: string
27312           example: __INTERFACE-ID__
27313         - name: cvlan-tag
27314           in: path
27315           description: See mis-na-virtualization-platform.yang
27316           required: true
27317           type: integer
27318           format: int64
27319           example: __CVLAN-TAG__
27320         - name: vnf-name
27321           in: query
27322           description: Name of VNF.
27323           required: false
27324           type: string
27325         - name: vnf-name2
27326           in: query
27327           description: Alternate name of VNF.
27328           required: false
27329           type: string
27330         - name: vnf-type
27331           in: query
27332           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
27333           required: false
27334           type: string
27335         - name: service-id
27336           in: query
27337           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
27338           required: false
27339           type: string
27340         - name: regional-resource-zone
27341           in: query
27342           description: Regional way of organizing pservers, source of truth should define values
27343           required: false
27344           type: string
27345         - name: prov-status
27346           in: query
27347           description: Trigger for operational monitoring of this resource by Service Assurance systems.
27348           required: false
27349           type: string
27350         - name: heat-stack-id
27351           in: query
27352           description: Heat stack id corresponding to this instance, managed by MSO
27353           required: false
27354           type: string
27355         - name: vpe-id
27356           in: query
27357           description: Unique ID of VPE connected to this VCE.
27358           required: false
27359           type: string
27360         - name: port-group-id
27361           in: query
27362           description: Unique ID for port group in vmware
27363           required: false
27364           type: string
27365         - name: switch-name
27366           in: query
27367           description: DVS or standard switch name (should be non-null for port groups associated with DVS)
27368           required: false
27369           type: string
27370         - name: heat-stack-id
27371           in: query
27372           description: Heat stack id corresponding to this instance, managed by MSO
27373           required: false
27374           type: string
27375     put:
27376       tags:
27377         - Network
27378       summary: create or update an existing cvlan-tag-entry
27379       description: |
27380         Create or update an existing cvlan-tag-entry.
27381         #
27382         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
27383       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
27384       consumes:
27385         - application/json
27386         - application/xml
27387       produces:
27388         - application/json
27389         - application/xml
27390       responses:
27391         "default":
27392           description: Response codes found in [response codes](https://wiki.onap.org/).
27393       parameters:
27394         - name: vnf-id
27395           in: path
27396           description: Unique id of VNF.  This is unique across the graph.
27397           required: true
27398           type: string
27399           example: __VNF-ID__
27400         - name: interface-id
27401           in: path
27402           description: Unique ID of the interface
27403           required: true
27404           type: string
27405           example: __INTERFACE-ID__
27406         - name: cvlan-tag
27407           in: path
27408           description: See mis-na-virtualization-platform.yang
27409           required: true
27410           type: integer
27411           format: int64
27412           example: __CVLAN-TAG__
27413         - name: body
27414           in: body
27415           description: cvlan-tag-entry object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
27416           required: true
27417           schema:
27418             $ref: "#/definitions/cvlan-tag-entry"
27419     patch:
27420       tags:
27421         - Network
27422       summary: update an existing cvlan-tag-entry
27423       description: |
27424         Update an existing cvlan-tag-entry
27425         #
27426         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27427         The PUT operation will entirely replace an existing object.
27428         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
27429         #
27430         Other differences between PUT and PATCH are:
27431         #
27432         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
27433         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27434         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27435       operationId: UpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
27436       consumes:
27437         - application/json
27438         - application/xml
27439       produces:
27440         - application/json
27441         - application/xml
27442       responses:
27443         "default":
27444           description: Response codes found in [response codes](https://wiki.onap.org/).
27445       parameters:
27446         - name: vnf-id
27447           in: path
27448           description: Unique id of VNF.  This is unique across the graph.
27449           required: true
27450           type: string
27451           example: __VNF-ID__
27452         - name: interface-id
27453           in: path
27454           description: Unique ID of the interface
27455           required: true
27456           type: string
27457           example: __INTERFACE-ID__
27458         - name: cvlan-tag
27459           in: path
27460           description: See mis-na-virtualization-platform.yang
27461           required: true
27462           type: integer
27463           format: int64
27464           example: __CVLAN-TAG__
27465         - name: body
27466           in: body
27467           description: cvlan-tag-entry object that needs to be created or updated.
27468           required: true
27469           schema:
27470             $ref: "#/patchDefinitions/cvlan-tag-entry"
27471     delete:
27472       tags:
27473         - Network
27474       summary: delete an existing cvlan-tag-entry
27475       description: delete an existing cvlan-tag-entry
27476       operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
27477       consumes:
27478         - application/json
27479         - application/xml
27480       produces:
27481         - application/json
27482         - application/xml
27483       responses:
27484         "default":
27485           description: Response codes found in [response codes](https://wiki.onap.org/).
27486       parameters:
27487         - name: vnf-id
27488           in: path
27489           description: Unique id of VNF.  This is unique across the graph.
27490           required: true
27491           type: string
27492           example: __VNF-ID__
27493         - name: interface-id
27494           in: path
27495           description: Unique ID of the interface
27496           required: true
27497           type: string
27498           example: __INTERFACE-ID__
27499         - name: cvlan-tag
27500           in: path
27501           description: See mis-na-virtualization-platform.yang
27502           required: true
27503           type: integer
27504           format: int64
27505           example: __CVLAN-TAG__
27506         - name: resource-version
27507           in: query
27508           description: resource-version for concurrency
27509           required: true
27510           type: string
27511   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags:
27512     get:
27513       tags:
27514         - Network
27515       summary: returns cvlan-tags
27516       description: returns cvlan-tags
27517       operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTags
27518       produces:
27519         - application/json
27520         - application/xml
27521       responses:
27522         "200":
27523           description: successful operation
27524           schema:
27525               $ref: "#/getDefinitions/cvlan-tags"
27526         "default":
27527           description: Response codes found in [response codes](https://wiki.onap.org/).
27528       parameters:
27529         - name: vnf-id
27530           in: path
27531           description: Unique id of VNF.  This is unique across the graph.
27532           required: true
27533           type: string
27534           example: __VNF-ID__
27535         - name: interface-id
27536           in: path
27537           description: Unique ID of the interface
27538           required: true
27539           type: string
27540           example: __INTERFACE-ID__
27541         - name: vnf-name
27542           in: query
27543           description: Name of VNF.
27544           required: false
27545           type: string
27546         - name: vnf-name2
27547           in: query
27548           description: Alternate name of VNF.
27549           required: false
27550           type: string
27551         - name: vnf-type
27552           in: query
27553           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
27554           required: false
27555           type: string
27556         - name: service-id
27557           in: query
27558           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
27559           required: false
27560           type: string
27561         - name: regional-resource-zone
27562           in: query
27563           description: Regional way of organizing pservers, source of truth should define values
27564           required: false
27565           type: string
27566         - name: prov-status
27567           in: query
27568           description: Trigger for operational monitoring of this resource by Service Assurance systems.
27569           required: false
27570           type: string
27571         - name: heat-stack-id
27572           in: query
27573           description: Heat stack id corresponding to this instance, managed by MSO
27574           required: false
27575           type: string
27576         - name: vpe-id
27577           in: query
27578           description: Unique ID of VPE connected to this VCE.
27579           required: false
27580           type: string
27581         - name: port-group-id
27582           in: query
27583           description: Unique ID for port group in vmware
27584           required: false
27585           type: string
27586         - name: switch-name
27587           in: query
27588           description: DVS or standard switch name (should be non-null for port groups associated with DVS)
27589           required: false
27590           type: string
27591         - name: heat-stack-id
27592           in: query
27593           description: Heat stack id corresponding to this instance, managed by MSO
27594           required: false
27595           type: string
27596   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship:
27597     put:
27598       tags:
27599         - Network
27600       summary: see node definition for valid relationships
27601       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
27602       consumes:
27603         - application/json
27604         - application/xml
27605       produces:
27606         - application/json
27607         - application/xml
27608       responses:
27609         "default":
27610           description: Response codes found in [response codes](https://wiki.onap.org/).
27611       parameters:
27612         - name: vnf-id
27613           in: path
27614           description: Unique id of VNF.  This is unique across the graph.
27615           required: true
27616           type: string
27617           example: __VNF-ID__
27618         - name: interface-id
27619           in: path
27620           description: Unique ID of the interface
27621           required: true
27622           type: string
27623           example: __INTERFACE-ID__
27624         - name: body
27625           in: body
27626           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVcePortGroupsPortGroup.json)
27627           required: true
27628           schema:
27629             $ref: "#/definitions/relationship"
27630     delete:
27631       tags:
27632         - Network
27633       summary: delete an existing relationship
27634       description: delete an existing relationship
27635       operationId: deleteNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
27636       consumes:
27637         - application/json
27638         - application/xml
27639       produces:
27640         - application/json
27641         - application/xml
27642       responses:
27643         "default":
27644           description: Response codes found in [response codes](https://wiki.onap.org/).
27645       parameters:
27646         - name: vnf-id
27647           in: path
27648           description: Unique id of VNF.  This is unique across the graph.
27649           required: true
27650           type: string
27651           example: __VNF-ID__
27652         - name: interface-id
27653           in: path
27654           description: Unique ID of the interface
27655           required: true
27656           type: string
27657           example: __INTERFACE-ID__
27658   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}:
27659     get:
27660       tags:
27661         - Network
27662       summary: returns port-group
27663       description: returns port-group
27664       operationId: getNetworkVcesVcePortGroupsPortGroup
27665       produces:
27666         - application/json
27667         - application/xml
27668       responses:
27669         "200":
27670           description: successful operation
27671           schema:
27672               $ref: "#/getDefinitions/port-group"
27673         "default":
27674           description: Response codes found in [response codes](https://wiki.onap.org/).
27675       parameters:
27676         - name: vnf-id
27677           in: path
27678           description: Unique id of VNF.  This is unique across the graph.
27679           required: true
27680           type: string
27681           example: __VNF-ID__
27682         - name: interface-id
27683           in: path
27684           description: Unique ID of the interface
27685           required: true
27686           type: string
27687           example: __INTERFACE-ID__
27688         - name: vnf-name
27689           in: query
27690           description: Name of VNF.
27691           required: false
27692           type: string
27693         - name: vnf-name2
27694           in: query
27695           description: Alternate name of VNF.
27696           required: false
27697           type: string
27698         - name: vnf-type
27699           in: query
27700           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
27701           required: false
27702           type: string
27703         - name: service-id
27704           in: query
27705           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
27706           required: false
27707           type: string
27708         - name: regional-resource-zone
27709           in: query
27710           description: Regional way of organizing pservers, source of truth should define values
27711           required: false
27712           type: string
27713         - name: prov-status
27714           in: query
27715           description: Trigger for operational monitoring of this resource by Service Assurance systems.
27716           required: false
27717           type: string
27718         - name: heat-stack-id
27719           in: query
27720           description: Heat stack id corresponding to this instance, managed by MSO
27721           required: false
27722           type: string
27723         - name: vpe-id
27724           in: query
27725           description: Unique ID of VPE connected to this VCE.
27726           required: false
27727           type: string
27728         - name: port-group-id
27729           in: query
27730           description: Unique ID for port group in vmware
27731           required: false
27732           type: string
27733         - name: switch-name
27734           in: query
27735           description: DVS or standard switch name (should be non-null for port groups associated with DVS)
27736           required: false
27737           type: string
27738         - name: heat-stack-id
27739           in: query
27740           description: Heat stack id corresponding to this instance, managed by MSO
27741           required: false
27742           type: string
27743     put:
27744       tags:
27745         - Network
27746       summary: create or update an existing port-group
27747       description: |
27748         Create or update an existing port-group.
27749         #
27750         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
27751       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroup
27752       consumes:
27753         - application/json
27754         - application/xml
27755       produces:
27756         - application/json
27757         - application/xml
27758       responses:
27759         "default":
27760           description: Response codes found in [response codes](https://wiki.onap.org/).
27761       parameters:
27762         - name: vnf-id
27763           in: path
27764           description: Unique id of VNF.  This is unique across the graph.
27765           required: true
27766           type: string
27767           example: __VNF-ID__
27768         - name: interface-id
27769           in: path
27770           description: Unique ID of the interface
27771           required: true
27772           type: string
27773           example: __INTERFACE-ID__
27774         - name: body
27775           in: body
27776           description: port-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVcePortGroupsPortGroup.json)
27777           required: true
27778           schema:
27779             $ref: "#/definitions/port-group"
27780     patch:
27781       tags:
27782         - Network
27783       summary: update an existing port-group
27784       description: |
27785         Update an existing port-group
27786         #
27787         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27788         The PUT operation will entirely replace an existing object.
27789         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
27790         #
27791         Other differences between PUT and PATCH are:
27792         #
27793         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
27794         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27795         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27796       operationId: UpdateNetworkVcesVcePortGroupsPortGroup
27797       consumes:
27798         - application/json
27799         - application/xml
27800       produces:
27801         - application/json
27802         - application/xml
27803       responses:
27804         "default":
27805           description: Response codes found in [response codes](https://wiki.onap.org/).
27806       parameters:
27807         - name: vnf-id
27808           in: path
27809           description: Unique id of VNF.  This is unique across the graph.
27810           required: true
27811           type: string
27812           example: __VNF-ID__
27813         - name: interface-id
27814           in: path
27815           description: Unique ID of the interface
27816           required: true
27817           type: string
27818           example: __INTERFACE-ID__
27819         - name: body
27820           in: body
27821           description: port-group object that needs to be created or updated.
27822           required: true
27823           schema:
27824             $ref: "#/patchDefinitions/port-group"
27825     delete:
27826       tags:
27827         - Network
27828       summary: delete an existing port-group
27829       description: delete an existing port-group
27830       operationId: deleteNetworkVcesVcePortGroupsPortGroup
27831       consumes:
27832         - application/json
27833         - application/xml
27834       produces:
27835         - application/json
27836         - application/xml
27837       responses:
27838         "default":
27839           description: Response codes found in [response codes](https://wiki.onap.org/).
27840       parameters:
27841         - name: vnf-id
27842           in: path
27843           description: Unique id of VNF.  This is unique across the graph.
27844           required: true
27845           type: string
27846           example: __VNF-ID__
27847         - name: interface-id
27848           in: path
27849           description: Unique ID of the interface
27850           required: true
27851           type: string
27852           example: __INTERFACE-ID__
27853         - name: resource-version
27854           in: query
27855           description: resource-version for concurrency
27856           required: true
27857           type: string
27858   /network/vces/vce/{vnf-id}/port-groups:
27859     get:
27860       tags:
27861         - Network
27862       summary: returns port-groups
27863       description: returns port-groups
27864       operationId: getNetworkVcesVcePortGroups
27865       produces:
27866         - application/json
27867         - application/xml
27868       responses:
27869         "200":
27870           description: successful operation
27871           schema:
27872               $ref: "#/getDefinitions/port-groups"
27873         "default":
27874           description: Response codes found in [response codes](https://wiki.onap.org/).
27875       parameters:
27876         - name: vnf-id
27877           in: path
27878           description: Unique id of VNF.  This is unique across the graph.
27879           required: true
27880           type: string
27881           example: __VNF-ID__
27882         - name: vnf-name
27883           in: query
27884           description: Name of VNF.
27885           required: false
27886           type: string
27887         - name: vnf-name2
27888           in: query
27889           description: Alternate name of VNF.
27890           required: false
27891           type: string
27892         - name: vnf-type
27893           in: query
27894           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
27895           required: false
27896           type: string
27897         - name: service-id
27898           in: query
27899           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
27900           required: false
27901           type: string
27902         - name: regional-resource-zone
27903           in: query
27904           description: Regional way of organizing pservers, source of truth should define values
27905           required: false
27906           type: string
27907         - name: prov-status
27908           in: query
27909           description: Trigger for operational monitoring of this resource by Service Assurance systems.
27910           required: false
27911           type: string
27912         - name: heat-stack-id
27913           in: query
27914           description: Heat stack id corresponding to this instance, managed by MSO
27915           required: false
27916           type: string
27917         - name: vpe-id
27918           in: query
27919           description: Unique ID of VPE connected to this VCE.
27920           required: false
27921           type: string
27922   /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship:
27923     put:
27924       tags:
27925         - Network
27926       summary: see node definition for valid relationships
27927       operationId: createOrUpdateNetworkVcesVceLicensesLicenseRelationshipListRelationship
27928       consumes:
27929         - application/json
27930         - application/xml
27931       produces:
27932         - application/json
27933         - application/xml
27934       responses:
27935         "default":
27936           description: Response codes found in [response codes](https://wiki.onap.org/).
27937       parameters:
27938         - name: vnf-id
27939           in: path
27940           description: Unique id of VNF.  This is unique across the graph.
27941           required: true
27942           type: string
27943           example: __VNF-ID__
27944         - name: group-uuid
27945           in: path
27946           description: Unique ID for the license group the resource belongs to, should be uuid.
27947           required: true
27948           type: string
27949           example: __GROUP-UUID__
27950         - name: resource-uuid
27951           in: path
27952           description: Unique ID of a license resource.
27953           required: true
27954           type: string
27955           example: __RESOURCE-UUID__
27956         - name: body
27957           in: body
27958           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVceLicensesLicense.json)
27959           required: true
27960           schema:
27961             $ref: "#/definitions/relationship"
27962     delete:
27963       tags:
27964         - Network
27965       summary: delete an existing relationship
27966       description: delete an existing relationship
27967       operationId: deleteNetworkVcesVceLicensesLicenseRelationshipListRelationship
27968       consumes:
27969         - application/json
27970         - application/xml
27971       produces:
27972         - application/json
27973         - application/xml
27974       responses:
27975         "default":
27976           description: Response codes found in [response codes](https://wiki.onap.org/).
27977       parameters:
27978         - name: vnf-id
27979           in: path
27980           description: Unique id of VNF.  This is unique across the graph.
27981           required: true
27982           type: string
27983           example: __VNF-ID__
27984         - name: group-uuid
27985           in: path
27986           description: Unique ID for the license group the resource belongs to, should be uuid.
27987           required: true
27988           type: string
27989           example: __GROUP-UUID__
27990         - name: resource-uuid
27991           in: path
27992           description: Unique ID of a license resource.
27993           required: true
27994           type: string
27995           example: __RESOURCE-UUID__
27996   /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}:
27997     get:
27998       tags:
27999         - Network
28000       summary: returns license
28001       description: returns license
28002       operationId: getNetworkVcesVceLicensesLicense
28003       produces:
28004         - application/json
28005         - application/xml
28006       responses:
28007         "200":
28008           description: successful operation
28009           schema:
28010               $ref: "#/getDefinitions/license"
28011         "default":
28012           description: Response codes found in [response codes](https://wiki.onap.org/).
28013       parameters:
28014         - name: vnf-id
28015           in: path
28016           description: Unique id of VNF.  This is unique across the graph.
28017           required: true
28018           type: string
28019           example: __VNF-ID__
28020         - name: group-uuid
28021           in: path
28022           description: Unique ID for the license group the resource belongs to, should be uuid.
28023           required: true
28024           type: string
28025           example: __GROUP-UUID__
28026         - name: resource-uuid
28027           in: path
28028           description: Unique ID of a license resource.
28029           required: true
28030           type: string
28031           example: __RESOURCE-UUID__
28032         - name: vnf-name
28033           in: query
28034           description: Name of VNF.
28035           required: false
28036           type: string
28037         - name: vnf-name2
28038           in: query
28039           description: Alternate name of VNF.
28040           required: false
28041           type: string
28042         - name: vnf-type
28043           in: query
28044           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
28045           required: false
28046           type: string
28047         - name: service-id
28048           in: query
28049           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
28050           required: false
28051           type: string
28052         - name: regional-resource-zone
28053           in: query
28054           description: Regional way of organizing pservers, source of truth should define values
28055           required: false
28056           type: string
28057         - name: prov-status
28058           in: query
28059           description: Trigger for operational monitoring of this resource by Service Assurance systems.
28060           required: false
28061           type: string
28062         - name: heat-stack-id
28063           in: query
28064           description: Heat stack id corresponding to this instance, managed by MSO
28065           required: false
28066           type: string
28067         - name: vpe-id
28068           in: query
28069           description: Unique ID of VPE connected to this VCE.
28070           required: false
28071           type: string
28072     put:
28073       tags:
28074         - Network
28075       summary: create or update an existing license
28076       description: |
28077         Create or update an existing license.
28078         #
28079         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
28080       operationId: createOrUpdateNetworkVcesVceLicensesLicense
28081       consumes:
28082         - application/json
28083         - application/xml
28084       produces:
28085         - application/json
28086         - application/xml
28087       responses:
28088         "default":
28089           description: Response codes found in [response codes](https://wiki.onap.org/).
28090       parameters:
28091         - name: vnf-id
28092           in: path
28093           description: Unique id of VNF.  This is unique across the graph.
28094           required: true
28095           type: string
28096           example: __VNF-ID__
28097         - name: group-uuid
28098           in: path
28099           description: Unique ID for the license group the resource belongs to, should be uuid.
28100           required: true
28101           type: string
28102           example: __GROUP-UUID__
28103         - name: resource-uuid
28104           in: path
28105           description: Unique ID of a license resource.
28106           required: true
28107           type: string
28108           example: __RESOURCE-UUID__
28109         - name: body
28110           in: body
28111           description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVceLicensesLicense.json)
28112           required: true
28113           schema:
28114             $ref: "#/definitions/license"
28115     patch:
28116       tags:
28117         - Network
28118       summary: update an existing license
28119       description: |
28120         Update an existing license
28121         #
28122         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28123         The PUT operation will entirely replace an existing object.
28124         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
28125         #
28126         Other differences between PUT and PATCH are:
28127         #
28128         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
28129         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28130         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28131       operationId: UpdateNetworkVcesVceLicensesLicense
28132       consumes:
28133         - application/json
28134         - application/xml
28135       produces:
28136         - application/json
28137         - application/xml
28138       responses:
28139         "default":
28140           description: Response codes found in [response codes](https://wiki.onap.org/).
28141       parameters:
28142         - name: vnf-id
28143           in: path
28144           description: Unique id of VNF.  This is unique across the graph.
28145           required: true
28146           type: string
28147           example: __VNF-ID__
28148         - name: group-uuid
28149           in: path
28150           description: Unique ID for the license group the resource belongs to, should be uuid.
28151           required: true
28152           type: string
28153           example: __GROUP-UUID__
28154         - name: resource-uuid
28155           in: path
28156           description: Unique ID of a license resource.
28157           required: true
28158           type: string
28159           example: __RESOURCE-UUID__
28160         - name: body
28161           in: body
28162           description: license object that needs to be created or updated.
28163           required: true
28164           schema:
28165             $ref: "#/patchDefinitions/license"
28166     delete:
28167       tags:
28168         - Network
28169       summary: delete an existing license
28170       description: delete an existing license
28171       operationId: deleteNetworkVcesVceLicensesLicense
28172       consumes:
28173         - application/json
28174         - application/xml
28175       produces:
28176         - application/json
28177         - application/xml
28178       responses:
28179         "default":
28180           description: Response codes found in [response codes](https://wiki.onap.org/).
28181       parameters:
28182         - name: vnf-id
28183           in: path
28184           description: Unique id of VNF.  This is unique across the graph.
28185           required: true
28186           type: string
28187           example: __VNF-ID__
28188         - name: group-uuid
28189           in: path
28190           description: Unique ID for the license group the resource belongs to, should be uuid.
28191           required: true
28192           type: string
28193           example: __GROUP-UUID__
28194         - name: resource-uuid
28195           in: path
28196           description: Unique ID of a license resource.
28197           required: true
28198           type: string
28199           example: __RESOURCE-UUID__
28200         - name: resource-version
28201           in: query
28202           description: resource-version for concurrency
28203           required: true
28204           type: string
28205   /network/vces/vce/{vnf-id}/licenses:
28206     get:
28207       tags:
28208         - Network
28209       summary: returns licenses
28210       description: returns licenses
28211       operationId: getNetworkVcesVceLicenses
28212       produces:
28213         - application/json
28214         - application/xml
28215       responses:
28216         "200":
28217           description: successful operation
28218           schema:
28219               $ref: "#/getDefinitions/licenses"
28220         "default":
28221           description: Response codes found in [response codes](https://wiki.onap.org/).
28222       parameters:
28223         - name: vnf-id
28224           in: path
28225           description: Unique id of VNF.  This is unique across the graph.
28226           required: true
28227           type: string
28228           example: __VNF-ID__
28229         - name: vnf-name
28230           in: query
28231           description: Name of VNF.
28232           required: false
28233           type: string
28234         - name: vnf-name2
28235           in: query
28236           description: Alternate name of VNF.
28237           required: false
28238           type: string
28239         - name: vnf-type
28240           in: query
28241           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
28242           required: false
28243           type: string
28244         - name: service-id
28245           in: query
28246           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
28247           required: false
28248           type: string
28249         - name: regional-resource-zone
28250           in: query
28251           description: Regional way of organizing pservers, source of truth should define values
28252           required: false
28253           type: string
28254         - name: prov-status
28255           in: query
28256           description: Trigger for operational monitoring of this resource by Service Assurance systems.
28257           required: false
28258           type: string
28259         - name: heat-stack-id
28260           in: query
28261           description: Heat stack id corresponding to this instance, managed by MSO
28262           required: false
28263           type: string
28264         - name: vpe-id
28265           in: query
28266           description: Unique ID of VPE connected to this VCE.
28267           required: false
28268           type: string
28269   /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship:
28270     put:
28271       tags:
28272         - Network
28273       summary: see node definition for valid relationships
28274       operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship
28275       consumes:
28276         - application/json
28277         - application/xml
28278       produces:
28279         - application/json
28280         - application/xml
28281       responses:
28282         "default":
28283           description: Response codes found in [response codes](https://wiki.onap.org/).
28284       parameters:
28285         - name: vnf-id
28286           in: path
28287           description: Unique id of VNF.  This is unique across the graph.
28288           required: true
28289           type: string
28290           example: __VNF-ID__
28291         - name: group-uuid
28292           in: path
28293           description: Unique ID for the entitlement group the resource comes from, should be uuid.
28294           required: true
28295           type: string
28296           example: __GROUP-UUID__
28297         - name: resource-uuid
28298           in: path
28299           description: Unique ID of an entitlement resource.
28300           required: true
28301           type: string
28302           example: __RESOURCE-UUID__
28303         - name: body
28304           in: body
28305           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVceEntitlementsEntitlement.json)
28306           required: true
28307           schema:
28308             $ref: "#/definitions/relationship"
28309     delete:
28310       tags:
28311         - Network
28312       summary: delete an existing relationship
28313       description: delete an existing relationship
28314       operationId: deleteNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship
28315       consumes:
28316         - application/json
28317         - application/xml
28318       produces:
28319         - application/json
28320         - application/xml
28321       responses:
28322         "default":
28323           description: Response codes found in [response codes](https://wiki.onap.org/).
28324       parameters:
28325         - name: vnf-id
28326           in: path
28327           description: Unique id of VNF.  This is unique across the graph.
28328           required: true
28329           type: string
28330           example: __VNF-ID__
28331         - name: group-uuid
28332           in: path
28333           description: Unique ID for the entitlement group the resource comes from, should be uuid.
28334           required: true
28335           type: string
28336           example: __GROUP-UUID__
28337         - name: resource-uuid
28338           in: path
28339           description: Unique ID of an entitlement resource.
28340           required: true
28341           type: string
28342           example: __RESOURCE-UUID__
28343   /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}:
28344     get:
28345       tags:
28346         - Network
28347       summary: returns entitlement
28348       description: returns entitlement
28349       operationId: getNetworkVcesVceEntitlementsEntitlement
28350       produces:
28351         - application/json
28352         - application/xml
28353       responses:
28354         "200":
28355           description: successful operation
28356           schema:
28357               $ref: "#/getDefinitions/entitlement"
28358         "default":
28359           description: Response codes found in [response codes](https://wiki.onap.org/).
28360       parameters:
28361         - name: vnf-id
28362           in: path
28363           description: Unique id of VNF.  This is unique across the graph.
28364           required: true
28365           type: string
28366           example: __VNF-ID__
28367         - name: group-uuid
28368           in: path
28369           description: Unique ID for the entitlement group the resource comes from, should be uuid.
28370           required: true
28371           type: string
28372           example: __GROUP-UUID__
28373         - name: resource-uuid
28374           in: path
28375           description: Unique ID of an entitlement resource.
28376           required: true
28377           type: string
28378           example: __RESOURCE-UUID__
28379         - name: vnf-name
28380           in: query
28381           description: Name of VNF.
28382           required: false
28383           type: string
28384         - name: vnf-name2
28385           in: query
28386           description: Alternate name of VNF.
28387           required: false
28388           type: string
28389         - name: vnf-type
28390           in: query
28391           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
28392           required: false
28393           type: string
28394         - name: service-id
28395           in: query
28396           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
28397           required: false
28398           type: string
28399         - name: regional-resource-zone
28400           in: query
28401           description: Regional way of organizing pservers, source of truth should define values
28402           required: false
28403           type: string
28404         - name: prov-status
28405           in: query
28406           description: Trigger for operational monitoring of this resource by Service Assurance systems.
28407           required: false
28408           type: string
28409         - name: heat-stack-id
28410           in: query
28411           description: Heat stack id corresponding to this instance, managed by MSO
28412           required: false
28413           type: string
28414         - name: vpe-id
28415           in: query
28416           description: Unique ID of VPE connected to this VCE.
28417           required: false
28418           type: string
28419     put:
28420       tags:
28421         - Network
28422       summary: create or update an existing entitlement
28423       description: |
28424         Create or update an existing entitlement.
28425         #
28426         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
28427       operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlement
28428       consumes:
28429         - application/json
28430         - application/xml
28431       produces:
28432         - application/json
28433         - application/xml
28434       responses:
28435         "default":
28436           description: Response codes found in [response codes](https://wiki.onap.org/).
28437       parameters:
28438         - name: vnf-id
28439           in: path
28440           description: Unique id of VNF.  This is unique across the graph.
28441           required: true
28442           type: string
28443           example: __VNF-ID__
28444         - name: group-uuid
28445           in: path
28446           description: Unique ID for the entitlement group the resource comes from, should be uuid.
28447           required: true
28448           type: string
28449           example: __GROUP-UUID__
28450         - name: resource-uuid
28451           in: path
28452           description: Unique ID of an entitlement resource.
28453           required: true
28454           type: string
28455           example: __RESOURCE-UUID__
28456         - name: body
28457           in: body
28458           description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVceEntitlementsEntitlement.json)
28459           required: true
28460           schema:
28461             $ref: "#/definitions/entitlement"
28462     patch:
28463       tags:
28464         - Network
28465       summary: update an existing entitlement
28466       description: |
28467         Update an existing entitlement
28468         #
28469         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28470         The PUT operation will entirely replace an existing object.
28471         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
28472         #
28473         Other differences between PUT and PATCH are:
28474         #
28475         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
28476         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28477         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28478       operationId: UpdateNetworkVcesVceEntitlementsEntitlement
28479       consumes:
28480         - application/json
28481         - application/xml
28482       produces:
28483         - application/json
28484         - application/xml
28485       responses:
28486         "default":
28487           description: Response codes found in [response codes](https://wiki.onap.org/).
28488       parameters:
28489         - name: vnf-id
28490           in: path
28491           description: Unique id of VNF.  This is unique across the graph.
28492           required: true
28493           type: string
28494           example: __VNF-ID__
28495         - name: group-uuid
28496           in: path
28497           description: Unique ID for the entitlement group the resource comes from, should be uuid.
28498           required: true
28499           type: string
28500           example: __GROUP-UUID__
28501         - name: resource-uuid
28502           in: path
28503           description: Unique ID of an entitlement resource.
28504           required: true
28505           type: string
28506           example: __RESOURCE-UUID__
28507         - name: body
28508           in: body
28509           description: entitlement object that needs to be created or updated.
28510           required: true
28511           schema:
28512             $ref: "#/patchDefinitions/entitlement"
28513     delete:
28514       tags:
28515         - Network
28516       summary: delete an existing entitlement
28517       description: delete an existing entitlement
28518       operationId: deleteNetworkVcesVceEntitlementsEntitlement
28519       consumes:
28520         - application/json
28521         - application/xml
28522       produces:
28523         - application/json
28524         - application/xml
28525       responses:
28526         "default":
28527           description: Response codes found in [response codes](https://wiki.onap.org/).
28528       parameters:
28529         - name: vnf-id
28530           in: path
28531           description: Unique id of VNF.  This is unique across the graph.
28532           required: true
28533           type: string
28534           example: __VNF-ID__
28535         - name: group-uuid
28536           in: path
28537           description: Unique ID for the entitlement group the resource comes from, should be uuid.
28538           required: true
28539           type: string
28540           example: __GROUP-UUID__
28541         - name: resource-uuid
28542           in: path
28543           description: Unique ID of an entitlement resource.
28544           required: true
28545           type: string
28546           example: __RESOURCE-UUID__
28547         - name: resource-version
28548           in: query
28549           description: resource-version for concurrency
28550           required: true
28551           type: string
28552   /network/vces/vce/{vnf-id}/entitlements:
28553     get:
28554       tags:
28555         - Network
28556       summary: returns entitlements
28557       description: returns entitlements
28558       operationId: getNetworkVcesVceEntitlements
28559       produces:
28560         - application/json
28561         - application/xml
28562       responses:
28563         "200":
28564           description: successful operation
28565           schema:
28566               $ref: "#/getDefinitions/entitlements"
28567         "default":
28568           description: Response codes found in [response codes](https://wiki.onap.org/).
28569       parameters:
28570         - name: vnf-id
28571           in: path
28572           description: Unique id of VNF.  This is unique across the graph.
28573           required: true
28574           type: string
28575           example: __VNF-ID__
28576         - name: vnf-name
28577           in: query
28578           description: Name of VNF.
28579           required: false
28580           type: string
28581         - name: vnf-name2
28582           in: query
28583           description: Alternate name of VNF.
28584           required: false
28585           type: string
28586         - name: vnf-type
28587           in: query
28588           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
28589           required: false
28590           type: string
28591         - name: service-id
28592           in: query
28593           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
28594           required: false
28595           type: string
28596         - name: regional-resource-zone
28597           in: query
28598           description: Regional way of organizing pservers, source of truth should define values
28599           required: false
28600           type: string
28601         - name: prov-status
28602           in: query
28603           description: Trigger for operational monitoring of this resource by Service Assurance systems.
28604           required: false
28605           type: string
28606         - name: heat-stack-id
28607           in: query
28608           description: Heat stack id corresponding to this instance, managed by MSO
28609           required: false
28610           type: string
28611         - name: vpe-id
28612           in: query
28613           description: Unique ID of VPE connected to this VCE.
28614           required: false
28615           type: string
28616   /network/vces/vce/{vnf-id}/relationship-list/relationship:
28617     put:
28618       tags:
28619         - Network
28620       summary: see node definition for valid relationships
28621       operationId: createOrUpdateNetworkVcesVceRelationshipListRelationship
28622       consumes:
28623         - application/json
28624         - application/xml
28625       produces:
28626         - application/json
28627         - application/xml
28628       responses:
28629         "default":
28630           description: Response codes found in [response codes](https://wiki.onap.org/).
28631       parameters:
28632         - name: vnf-id
28633           in: path
28634           description: Unique id of VNF.  This is unique across the graph.
28635           required: true
28636           type: string
28637           example: __VNF-ID__
28638         - name: body
28639           in: body
28640           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVce.json)
28641           required: true
28642           schema:
28643             $ref: "#/definitions/relationship"
28644     delete:
28645       tags:
28646         - Network
28647       summary: delete an existing relationship
28648       description: delete an existing relationship
28649       operationId: deleteNetworkVcesVceRelationshipListRelationship
28650       consumes:
28651         - application/json
28652         - application/xml
28653       produces:
28654         - application/json
28655         - application/xml
28656       responses:
28657         "default":
28658           description: Response codes found in [response codes](https://wiki.onap.org/).
28659       parameters:
28660         - name: vnf-id
28661           in: path
28662           description: Unique id of VNF.  This is unique across the graph.
28663           required: true
28664           type: string
28665           example: __VNF-ID__
28666   /network/vces/vce/{vnf-id}:
28667     get:
28668       tags:
28669         - Network
28670       summary: returns vce
28671       description: returns vce
28672       operationId: getNetworkVcesVce
28673       produces:
28674         - application/json
28675         - application/xml
28676       responses:
28677         "200":
28678           description: successful operation
28679           schema:
28680               $ref: "#/getDefinitions/vce"
28681         "default":
28682           description: Response codes found in [response codes](https://wiki.onap.org/).
28683       parameters:
28684         - name: vnf-id
28685           in: path
28686           description: Unique id of VNF.  This is unique across the graph.
28687           required: true
28688           type: string
28689           example: __VNF-ID__
28690         - name: vnf-name
28691           in: query
28692           description: Name of VNF.
28693           required: false
28694           type: string
28695         - name: vnf-name2
28696           in: query
28697           description: Alternate name of VNF.
28698           required: false
28699           type: string
28700         - name: vnf-type
28701           in: query
28702           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
28703           required: false
28704           type: string
28705         - name: service-id
28706           in: query
28707           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
28708           required: false
28709           type: string
28710         - name: regional-resource-zone
28711           in: query
28712           description: Regional way of organizing pservers, source of truth should define values
28713           required: false
28714           type: string
28715         - name: prov-status
28716           in: query
28717           description: Trigger for operational monitoring of this resource by Service Assurance systems.
28718           required: false
28719           type: string
28720         - name: heat-stack-id
28721           in: query
28722           description: Heat stack id corresponding to this instance, managed by MSO
28723           required: false
28724           type: string
28725         - name: vpe-id
28726           in: query
28727           description: Unique ID of VPE connected to this VCE.
28728           required: false
28729           type: string
28730     put:
28731       tags:
28732         - Network
28733       summary: create or update an existing vce
28734       description: |
28735         Create or update an existing vce.
28736         #
28737         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
28738       operationId: createOrUpdateNetworkVcesVce
28739       consumes:
28740         - application/json
28741         - application/xml
28742       produces:
28743         - application/json
28744         - application/xml
28745       responses:
28746         "default":
28747           description: Response codes found in [response codes](https://wiki.onap.org/).
28748       parameters:
28749         - name: vnf-id
28750           in: path
28751           description: Unique id of VNF.  This is unique across the graph.
28752           required: true
28753           type: string
28754           example: __VNF-ID__
28755         - name: body
28756           in: body
28757           description: vce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVce.json)
28758           required: true
28759           schema:
28760             $ref: "#/definitions/vce"
28761     patch:
28762       tags:
28763         - Network
28764       summary: update an existing vce
28765       description: |
28766         Update an existing vce
28767         #
28768         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28769         The PUT operation will entirely replace an existing object.
28770         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
28771         #
28772         Other differences between PUT and PATCH are:
28773         #
28774         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
28775         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28776         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28777       operationId: UpdateNetworkVcesVce
28778       consumes:
28779         - application/json
28780         - application/xml
28781       produces:
28782         - application/json
28783         - application/xml
28784       responses:
28785         "default":
28786           description: Response codes found in [response codes](https://wiki.onap.org/).
28787       parameters:
28788         - name: vnf-id
28789           in: path
28790           description: Unique id of VNF.  This is unique across the graph.
28791           required: true
28792           type: string
28793           example: __VNF-ID__
28794         - name: body
28795           in: body
28796           description: vce object that needs to be created or updated.
28797           required: true
28798           schema:
28799             $ref: "#/patchDefinitions/vce"
28800     delete:
28801       tags:
28802         - Network
28803       summary: delete an existing vce
28804       description: delete an existing vce
28805       operationId: deleteNetworkVcesVce
28806       consumes:
28807         - application/json
28808         - application/xml
28809       produces:
28810         - application/json
28811         - application/xml
28812       responses:
28813         "default":
28814           description: Response codes found in [response codes](https://wiki.onap.org/).
28815       parameters:
28816         - name: vnf-id
28817           in: path
28818           description: Unique id of VNF.  This is unique across the graph.
28819           required: true
28820           type: string
28821           example: __VNF-ID__
28822         - name: resource-version
28823           in: query
28824           description: resource-version for concurrency
28825           required: true
28826           type: string
28827   /network/vces:
28828     get:
28829       tags:
28830         - Network
28831       summary: returns vces
28832       description: returns vces
28833       operationId: getNetworkVces
28834       produces:
28835         - application/json
28836         - application/xml
28837       responses:
28838         "200":
28839           description: successful operation
28840           schema:
28841               $ref: "#/getDefinitions/vces"
28842         "default":
28843           description: Response codes found in [response codes](https://wiki.onap.org/).
28844   /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship:
28845     put:
28846       tags:
28847         - Network
28848       summary: see node definition for valid relationships
28849       operationId: createOrUpdateNetworkVnfcsVnfcRelationshipListRelationship
28850       consumes:
28851         - application/json
28852         - application/xml
28853       produces:
28854         - application/json
28855         - application/xml
28856       responses:
28857         "default":
28858           description: Response codes found in [response codes](https://wiki.onap.org/).
28859       parameters:
28860         - name: vnfc-name
28861           in: path
28862           description: Unique ID of vnfc.
28863           required: true
28864           type: string
28865           example: __VNFC-NAME__
28866         - name: body
28867           in: body
28868           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVnfcsVnfc.json)
28869           required: true
28870           schema:
28871             $ref: "#/definitions/relationship"
28872     delete:
28873       tags:
28874         - Network
28875       summary: delete an existing relationship
28876       description: delete an existing relationship
28877       operationId: deleteNetworkVnfcsVnfcRelationshipListRelationship
28878       consumes:
28879         - application/json
28880         - application/xml
28881       produces:
28882         - application/json
28883         - application/xml
28884       responses:
28885         "default":
28886           description: Response codes found in [response codes](https://wiki.onap.org/).
28887       parameters:
28888         - name: vnfc-name
28889           in: path
28890           description: Unique ID of vnfc.
28891           required: true
28892           type: string
28893           example: __VNFC-NAME__
28894   /network/vnfcs/vnfc/{vnfc-name}:
28895     get:
28896       tags:
28897         - Network
28898       summary: returns vnfc
28899       description: returns vnfc
28900       operationId: getNetworkVnfcsVnfc
28901       produces:
28902         - application/json
28903         - application/xml
28904       responses:
28905         "200":
28906           description: successful operation
28907           schema:
28908               $ref: "#/getDefinitions/vnfc"
28909         "default":
28910           description: Response codes found in [response codes](https://wiki.onap.org/).
28911       parameters:
28912         - name: vnfc-name
28913           in: path
28914           description: Unique ID of vnfc.
28915           required: true
28916           type: string
28917           example: __VNFC-NAME__
28918         - name: vnfc-function-code
28919           in: query
28920           description: function code
28921           required: false
28922           type: string
28923         - name: vnfc-type
28924           in: query
28925           description: type
28926           required: false
28927           type: string
28928         - name: prov-status
28929           in: query
28930           description: prov status of this vnfc
28931           required: false
28932           type: string
28933         - name: ipaddress-v4-oam-vip
28934           in: query
28935           description: Oam V4 vip address of this vnfc
28936           required: false
28937           type: string
28938         - name: in-maint
28939           in: query
28940           required: false
28941           type: boolean
28942         - name: is-closed-loop-disabled
28943           in: query
28944           required: false
28945           type: boolean
28946         - name: group-notation
28947           in: query
28948           description: Group notation of VNFC
28949           required: false
28950           type: string
28951     put:
28952       tags:
28953         - Network
28954       summary: create or update an existing vnfc
28955       description: |
28956         Create or update an existing vnfc.
28957         #
28958         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
28959       operationId: createOrUpdateNetworkVnfcsVnfc
28960       consumes:
28961         - application/json
28962         - application/xml
28963       produces:
28964         - application/json
28965         - application/xml
28966       responses:
28967         "default":
28968           description: Response codes found in [response codes](https://wiki.onap.org/).
28969       parameters:
28970         - name: vnfc-name
28971           in: path
28972           description: Unique ID of vnfc.
28973           required: true
28974           type: string
28975           example: __VNFC-NAME__
28976         - name: body
28977           in: body
28978           description: vnfc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVnfcsVnfc.json)
28979           required: true
28980           schema:
28981             $ref: "#/definitions/vnfc"
28982     patch:
28983       tags:
28984         - Network
28985       summary: update an existing vnfc
28986       description: |
28987         Update an existing vnfc
28988         #
28989         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28990         The PUT operation will entirely replace an existing object.
28991         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
28992         #
28993         Other differences between PUT and PATCH are:
28994         #
28995         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
28996         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28997         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28998       operationId: UpdateNetworkVnfcsVnfc
28999       consumes:
29000         - application/json
29001         - application/xml
29002       produces:
29003         - application/json
29004         - application/xml
29005       responses:
29006         "default":
29007           description: Response codes found in [response codes](https://wiki.onap.org/).
29008       parameters:
29009         - name: vnfc-name
29010           in: path
29011           description: Unique ID of vnfc.
29012           required: true
29013           type: string
29014           example: __VNFC-NAME__
29015         - name: body
29016           in: body
29017           description: vnfc object that needs to be created or updated.
29018           required: true
29019           schema:
29020             $ref: "#/patchDefinitions/vnfc"
29021     delete:
29022       tags:
29023         - Network
29024       summary: delete an existing vnfc
29025       description: delete an existing vnfc
29026       operationId: deleteNetworkVnfcsVnfc
29027       consumes:
29028         - application/json
29029         - application/xml
29030       produces:
29031         - application/json
29032         - application/xml
29033       responses:
29034         "default":
29035           description: Response codes found in [response codes](https://wiki.onap.org/).
29036       parameters:
29037         - name: vnfc-name
29038           in: path
29039           description: Unique ID of vnfc.
29040           required: true
29041           type: string
29042           example: __VNFC-NAME__
29043         - name: resource-version
29044           in: query
29045           description: resource-version for concurrency
29046           required: true
29047           type: string
29048   /network/vnfcs:
29049     get:
29050       tags:
29051         - Network
29052       summary: returns vnfcs
29053       description: returns vnfcs
29054       operationId: getNetworkVnfcs
29055       produces:
29056         - application/json
29057         - application/xml
29058       responses:
29059         "200":
29060           description: successful operation
29061           schema:
29062               $ref: "#/getDefinitions/vnfcs"
29063         "default":
29064           description: Response codes found in [response codes](https://wiki.onap.org/).
29065   /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship:
29066     put:
29067       tags:
29068         - Network
29069       summary: see node definition for valid relationships
29070       operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
29071       consumes:
29072         - application/json
29073         - application/xml
29074       produces:
29075         - application/json
29076         - application/xml
29077       responses:
29078         "default":
29079           description: Response codes found in [response codes](https://wiki.onap.org/).
29080       parameters:
29081         - name: network-id
29082           in: path
29083           description: Network ID, should be uuid. Unique across A&AI.
29084           required: true
29085           type: string
29086           example: __NETWORK-ID__
29087         - name: subnet-id
29088           in: path
29089           description: Subnet ID, should be UUID.
29090           required: true
29091           type: string
29092           example: __SUBNET-ID__
29093         - name: body
29094           in: body
29095           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
29096           required: true
29097           schema:
29098             $ref: "#/definitions/relationship"
29099     delete:
29100       tags:
29101         - Network
29102       summary: delete an existing relationship
29103       description: delete an existing relationship
29104       operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
29105       consumes:
29106         - application/json
29107         - application/xml
29108       produces:
29109         - application/json
29110         - application/xml
29111       responses:
29112         "default":
29113           description: Response codes found in [response codes](https://wiki.onap.org/).
29114       parameters:
29115         - name: network-id
29116           in: path
29117           description: Network ID, should be uuid. Unique across A&AI.
29118           required: true
29119           type: string
29120           example: __NETWORK-ID__
29121         - name: subnet-id
29122           in: path
29123           description: Subnet ID, should be UUID.
29124           required: true
29125           type: string
29126           example: __SUBNET-ID__
29127   /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}:
29128     get:
29129       tags:
29130         - Network
29131       summary: returns subnet
29132       description: returns subnet
29133       operationId: getNetworkL3NetworksL3NetworkSubnetsSubnet
29134       produces:
29135         - application/json
29136         - application/xml
29137       responses:
29138         "200":
29139           description: successful operation
29140           schema:
29141               $ref: "#/getDefinitions/subnet"
29142         "default":
29143           description: Response codes found in [response codes](https://wiki.onap.org/).
29144       parameters:
29145         - name: network-id
29146           in: path
29147           description: Network ID, should be uuid. Unique across A&AI.
29148           required: true
29149           type: string
29150           example: __NETWORK-ID__
29151         - name: subnet-id
29152           in: path
29153           description: Subnet ID, should be UUID.
29154           required: true
29155           type: string
29156           example: __SUBNET-ID__
29157         - name: network-name
29158           in: query
29159           description: Name of the network, governed by some naming convention..
29160           required: false
29161           type: string
29162         - name: network-role
29163           in: query
29164           description: Role the network plans - who defines these values?
29165           required: false
29166           type: string
29167         - name: service-id
29168           in: query
29169           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
29170           required: false
29171           type: string
29172         - name: heat-stack-id
29173           in: query
29174           description: Heat stack id corresponding to this instance, managed by MSO
29175           required: false
29176           type: string
29177         - name: contrail-network-fqdn
29178           in: query
29179           description: Contrail FQDN for the network
29180           required: false
29181           type: string
29182         - name: persona-model-id
29183           in: query
29184           description: the ASDC model id for this resource or service model.
29185           required: false
29186           type: string
29187         - name: persona-model-version
29188           in: query
29189           description: the ASDC model version for this resource or service model.
29190           required: false
29191           type: string
29192         - name: widget-model-id
29193           in: query
29194           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
29195           required: false
29196           type: string
29197         - name: widget-model-version
29198           in: query
29199           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
29200           required: false
29201           type: string
29202         - name: subnet-name
29203           in: query
29204           description: Name associated with the subnet.
29205           required: false
29206           type: string
29207     put:
29208       tags:
29209         - Network
29210       summary: create or update an existing subnet
29211       description: |
29212         Create or update an existing subnet.
29213         #
29214         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
29215       operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnet
29216       consumes:
29217         - application/json
29218         - application/xml
29219       produces:
29220         - application/json
29221         - application/xml
29222       responses:
29223         "default":
29224           description: Response codes found in [response codes](https://wiki.onap.org/).
29225       parameters:
29226         - name: network-id
29227           in: path
29228           description: Network ID, should be uuid. Unique across A&AI.
29229           required: true
29230           type: string
29231           example: __NETWORK-ID__
29232         - name: subnet-id
29233           in: path
29234           description: Subnet ID, should be UUID.
29235           required: true
29236           type: string
29237           example: __SUBNET-ID__
29238         - name: body
29239           in: body
29240           description: subnet object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
29241           required: true
29242           schema:
29243             $ref: "#/definitions/subnet"
29244     patch:
29245       tags:
29246         - Network
29247       summary: update an existing subnet
29248       description: |
29249         Update an existing subnet
29250         #
29251         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29252         The PUT operation will entirely replace an existing object.
29253         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
29254         #
29255         Other differences between PUT and PATCH are:
29256         #
29257         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
29258         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29259         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29260       operationId: UpdateNetworkL3NetworksL3NetworkSubnetsSubnet
29261       consumes:
29262         - application/json
29263         - application/xml
29264       produces:
29265         - application/json
29266         - application/xml
29267       responses:
29268         "default":
29269           description: Response codes found in [response codes](https://wiki.onap.org/).
29270       parameters:
29271         - name: network-id
29272           in: path
29273           description: Network ID, should be uuid. Unique across A&AI.
29274           required: true
29275           type: string
29276           example: __NETWORK-ID__
29277         - name: subnet-id
29278           in: path
29279           description: Subnet ID, should be UUID.
29280           required: true
29281           type: string
29282           example: __SUBNET-ID__
29283         - name: body
29284           in: body
29285           description: subnet object that needs to be created or updated.
29286           required: true
29287           schema:
29288             $ref: "#/patchDefinitions/subnet"
29289     delete:
29290       tags:
29291         - Network
29292       summary: delete an existing subnet
29293       description: delete an existing subnet
29294       operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnet
29295       consumes:
29296         - application/json
29297         - application/xml
29298       produces:
29299         - application/json
29300         - application/xml
29301       responses:
29302         "default":
29303           description: Response codes found in [response codes](https://wiki.onap.org/).
29304       parameters:
29305         - name: network-id
29306           in: path
29307           description: Network ID, should be uuid. Unique across A&AI.
29308           required: true
29309           type: string
29310           example: __NETWORK-ID__
29311         - name: subnet-id
29312           in: path
29313           description: Subnet ID, should be UUID.
29314           required: true
29315           type: string
29316           example: __SUBNET-ID__
29317         - name: resource-version
29318           in: query
29319           description: resource-version for concurrency
29320           required: true
29321           type: string
29322   /network/l3-networks/l3-network/{network-id}/subnets:
29323     get:
29324       tags:
29325         - Network
29326       summary: returns subnets
29327       description: returns subnets
29328       operationId: getNetworkL3NetworksL3NetworkSubnets
29329       produces:
29330         - application/json
29331         - application/xml
29332       responses:
29333         "200":
29334           description: successful operation
29335           schema:
29336               $ref: "#/getDefinitions/subnets"
29337         "default":
29338           description: Response codes found in [response codes](https://wiki.onap.org/).
29339       parameters:
29340         - name: network-id
29341           in: path
29342           description: Network ID, should be uuid. Unique across A&AI.
29343           required: true
29344           type: string
29345           example: __NETWORK-ID__
29346         - name: network-name
29347           in: query
29348           description: Name of the network, governed by some naming convention..
29349           required: false
29350           type: string
29351         - name: network-role
29352           in: query
29353           description: Role the network plans - who defines these values?
29354           required: false
29355           type: string
29356         - name: service-id
29357           in: query
29358           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
29359           required: false
29360           type: string
29361         - name: heat-stack-id
29362           in: query
29363           description: Heat stack id corresponding to this instance, managed by MSO
29364           required: false
29365           type: string
29366         - name: contrail-network-fqdn
29367           in: query
29368           description: Contrail FQDN for the network
29369           required: false
29370           type: string
29371         - name: persona-model-id
29372           in: query
29373           description: the ASDC model id for this resource or service model.
29374           required: false
29375           type: string
29376         - name: persona-model-version
29377           in: query
29378           description: the ASDC model version for this resource or service model.
29379           required: false
29380           type: string
29381         - name: widget-model-id
29382           in: query
29383           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
29384           required: false
29385           type: string
29386         - name: widget-model-version
29387           in: query
29388           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
29389           required: false
29390           type: string
29391   /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship:
29392     put:
29393       tags:
29394         - Network
29395       summary: see node definition for valid relationships
29396       operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
29397       consumes:
29398         - application/json
29399         - application/xml
29400       produces:
29401         - application/json
29402         - application/xml
29403       responses:
29404         "default":
29405           description: Response codes found in [response codes](https://wiki.onap.org/).
29406       parameters:
29407         - name: network-id
29408           in: path
29409           description: Network ID, should be uuid. Unique across A&AI.
29410           required: true
29411           type: string
29412           example: __NETWORK-ID__
29413         - name: vlan-id-inner
29414           in: path
29415           description: id.
29416           required: true
29417           type: integer
29418           format: int64
29419           example: __VLAN-ID-INNER__
29420         - name: body
29421           in: body
29422           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
29423           required: true
29424           schema:
29425             $ref: "#/definitions/relationship"
29426     delete:
29427       tags:
29428         - Network
29429       summary: delete an existing relationship
29430       description: delete an existing relationship
29431       operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
29432       consumes:
29433         - application/json
29434         - application/xml
29435       produces:
29436         - application/json
29437         - application/xml
29438       responses:
29439         "default":
29440           description: Response codes found in [response codes](https://wiki.onap.org/).
29441       parameters:
29442         - name: network-id
29443           in: path
29444           description: Network ID, should be uuid. Unique across A&AI.
29445           required: true
29446           type: string
29447           example: __NETWORK-ID__
29448         - name: vlan-id-inner
29449           in: path
29450           description: id.
29451           required: true
29452           type: integer
29453           format: int64
29454           example: __VLAN-ID-INNER__
29455   /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}:
29456     get:
29457       tags:
29458         - Network
29459       summary: returns ctag-assignment
29460       description: returns ctag-assignment
29461       operationId: getNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
29462       produces:
29463         - application/json
29464         - application/xml
29465       responses:
29466         "200":
29467           description: successful operation
29468           schema:
29469               $ref: "#/getDefinitions/ctag-assignment"
29470         "default":
29471           description: Response codes found in [response codes](https://wiki.onap.org/).
29472       parameters:
29473         - name: network-id
29474           in: path
29475           description: Network ID, should be uuid. Unique across A&AI.
29476           required: true
29477           type: string
29478           example: __NETWORK-ID__
29479         - name: vlan-id-inner
29480           in: path
29481           description: id.
29482           required: true
29483           type: integer
29484           format: int64
29485           example: __VLAN-ID-INNER__
29486         - name: network-name
29487           in: query
29488           description: Name of the network, governed by some naming convention..
29489           required: false
29490           type: string
29491         - name: network-role
29492           in: query
29493           description: Role the network plans - who defines these values?
29494           required: false
29495           type: string
29496         - name: service-id
29497           in: query
29498           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
29499           required: false
29500           type: string
29501         - name: heat-stack-id
29502           in: query
29503           description: Heat stack id corresponding to this instance, managed by MSO
29504           required: false
29505           type: string
29506         - name: contrail-network-fqdn
29507           in: query
29508           description: Contrail FQDN for the network
29509           required: false
29510           type: string
29511         - name: persona-model-id
29512           in: query
29513           description: the ASDC model id for this resource or service model.
29514           required: false
29515           type: string
29516         - name: persona-model-version
29517           in: query
29518           description: the ASDC model version for this resource or service model.
29519           required: false
29520           type: string
29521         - name: widget-model-id
29522           in: query
29523           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
29524           required: false
29525           type: string
29526         - name: widget-model-version
29527           in: query
29528           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
29529           required: false
29530           type: string
29531     put:
29532       tags:
29533         - Network
29534       summary: create or update an existing ctag-assignment
29535       description: |
29536         Create or update an existing ctag-assignment.
29537         #
29538         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
29539       operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
29540       consumes:
29541         - application/json
29542         - application/xml
29543       produces:
29544         - application/json
29545         - application/xml
29546       responses:
29547         "default":
29548           description: Response codes found in [response codes](https://wiki.onap.org/).
29549       parameters:
29550         - name: network-id
29551           in: path
29552           description: Network ID, should be uuid. Unique across A&AI.
29553           required: true
29554           type: string
29555           example: __NETWORK-ID__
29556         - name: vlan-id-inner
29557           in: path
29558           description: id.
29559           required: true
29560           type: integer
29561           format: int64
29562           example: __VLAN-ID-INNER__
29563         - name: body
29564           in: body
29565           description: ctag-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
29566           required: true
29567           schema:
29568             $ref: "#/definitions/ctag-assignment"
29569     patch:
29570       tags:
29571         - Network
29572       summary: update an existing ctag-assignment
29573       description: |
29574         Update an existing ctag-assignment
29575         #
29576         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29577         The PUT operation will entirely replace an existing object.
29578         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
29579         #
29580         Other differences between PUT and PATCH are:
29581         #
29582         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
29583         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29584         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29585       operationId: UpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
29586       consumes:
29587         - application/json
29588         - application/xml
29589       produces:
29590         - application/json
29591         - application/xml
29592       responses:
29593         "default":
29594           description: Response codes found in [response codes](https://wiki.onap.org/).
29595       parameters:
29596         - name: network-id
29597           in: path
29598           description: Network ID, should be uuid. Unique across A&AI.
29599           required: true
29600           type: string
29601           example: __NETWORK-ID__
29602         - name: vlan-id-inner
29603           in: path
29604           description: id.
29605           required: true
29606           type: integer
29607           format: int64
29608           example: __VLAN-ID-INNER__
29609         - name: body
29610           in: body
29611           description: ctag-assignment object that needs to be created or updated.
29612           required: true
29613           schema:
29614             $ref: "#/patchDefinitions/ctag-assignment"
29615     delete:
29616       tags:
29617         - Network
29618       summary: delete an existing ctag-assignment
29619       description: delete an existing ctag-assignment
29620       operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
29621       consumes:
29622         - application/json
29623         - application/xml
29624       produces:
29625         - application/json
29626         - application/xml
29627       responses:
29628         "default":
29629           description: Response codes found in [response codes](https://wiki.onap.org/).
29630       parameters:
29631         - name: network-id
29632           in: path
29633           description: Network ID, should be uuid. Unique across A&AI.
29634           required: true
29635           type: string
29636           example: __NETWORK-ID__
29637         - name: vlan-id-inner
29638           in: path
29639           description: id.
29640           required: true
29641           type: integer
29642           format: int64
29643           example: __VLAN-ID-INNER__
29644         - name: resource-version
29645           in: query
29646           description: resource-version for concurrency
29647           required: true
29648           type: string
29649   /network/l3-networks/l3-network/{network-id}/ctag-assignments:
29650     get:
29651       tags:
29652         - Network
29653       summary: returns ctag-assignments
29654       description: returns ctag-assignments
29655       operationId: getNetworkL3NetworksL3NetworkCtagAssignments
29656       produces:
29657         - application/json
29658         - application/xml
29659       responses:
29660         "200":
29661           description: successful operation
29662           schema:
29663               $ref: "#/getDefinitions/ctag-assignments"
29664         "default":
29665           description: Response codes found in [response codes](https://wiki.onap.org/).
29666       parameters:
29667         - name: network-id
29668           in: path
29669           description: Network ID, should be uuid. Unique across A&AI.
29670           required: true
29671           type: string
29672           example: __NETWORK-ID__
29673         - name: network-name
29674           in: query
29675           description: Name of the network, governed by some naming convention..
29676           required: false
29677           type: string
29678         - name: network-role
29679           in: query
29680           description: Role the network plans - who defines these values?
29681           required: false
29682           type: string
29683         - name: service-id
29684           in: query
29685           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
29686           required: false
29687           type: string
29688         - name: heat-stack-id
29689           in: query
29690           description: Heat stack id corresponding to this instance, managed by MSO
29691           required: false
29692           type: string
29693         - name: contrail-network-fqdn
29694           in: query
29695           description: Contrail FQDN for the network
29696           required: false
29697           type: string
29698         - name: persona-model-id
29699           in: query
29700           description: the ASDC model id for this resource or service model.
29701           required: false
29702           type: string
29703         - name: persona-model-version
29704           in: query
29705           description: the ASDC model version for this resource or service model.
29706           required: false
29707           type: string
29708         - name: widget-model-id
29709           in: query
29710           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
29711           required: false
29712           type: string
29713         - name: widget-model-version
29714           in: query
29715           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
29716           required: false
29717           type: string
29718   /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship:
29719     put:
29720       tags:
29721         - Network
29722       summary: see node definition for valid relationships
29723       operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship
29724       consumes:
29725         - application/json
29726         - application/xml
29727       produces:
29728         - application/json
29729         - application/xml
29730       responses:
29731         "default":
29732           description: Response codes found in [response codes](https://wiki.onap.org/).
29733       parameters:
29734         - name: network-id
29735           in: path
29736           description: Network ID, should be uuid. Unique across A&AI.
29737           required: true
29738           type: string
29739           example: __NETWORK-ID__
29740         - name: segmentation-id
29741           in: path
29742           description: Route Table Reference id, UUID assigned to this instance.
29743           required: true
29744           type: string
29745           example: __SEGMENTATION-ID__
29746         - name: body
29747           in: body
29748           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
29749           required: true
29750           schema:
29751             $ref: "#/definitions/relationship"
29752     delete:
29753       tags:
29754         - Network
29755       summary: delete an existing relationship
29756       description: delete an existing relationship
29757       operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship
29758       consumes:
29759         - application/json
29760         - application/xml
29761       produces:
29762         - application/json
29763         - application/xml
29764       responses:
29765         "default":
29766           description: Response codes found in [response codes](https://wiki.onap.org/).
29767       parameters:
29768         - name: network-id
29769           in: path
29770           description: Network ID, should be uuid. Unique across A&AI.
29771           required: true
29772           type: string
29773           example: __NETWORK-ID__
29774         - name: segmentation-id
29775           in: path
29776           description: Route Table Reference id, UUID assigned to this instance.
29777           required: true
29778           type: string
29779           example: __SEGMENTATION-ID__
29780   /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}:
29781     get:
29782       tags:
29783         - Network
29784       summary: returns segmentation-assignment
29785       description: returns segmentation-assignment
29786       operationId: getNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
29787       produces:
29788         - application/json
29789         - application/xml
29790       responses:
29791         "200":
29792           description: successful operation
29793           schema:
29794               $ref: "#/getDefinitions/segmentation-assignment"
29795         "default":
29796           description: Response codes found in [response codes](https://wiki.onap.org/).
29797       parameters:
29798         - name: network-id
29799           in: path
29800           description: Network ID, should be uuid. Unique across A&AI.
29801           required: true
29802           type: string
29803           example: __NETWORK-ID__
29804         - name: segmentation-id
29805           in: path
29806           description: Route Table Reference id, UUID assigned to this instance.
29807           required: true
29808           type: string
29809           example: __SEGMENTATION-ID__
29810         - name: network-name
29811           in: query
29812           description: Name of the network, governed by some naming convention..
29813           required: false
29814           type: string
29815         - name: network-role
29816           in: query
29817           description: Role the network plans - who defines these values?
29818           required: false
29819           type: string
29820         - name: service-id
29821           in: query
29822           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
29823           required: false
29824           type: string
29825         - name: heat-stack-id
29826           in: query
29827           description: Heat stack id corresponding to this instance, managed by MSO
29828           required: false
29829           type: string
29830         - name: contrail-network-fqdn
29831           in: query
29832           description: Contrail FQDN for the network
29833           required: false
29834           type: string
29835         - name: persona-model-id
29836           in: query
29837           description: the ASDC model id for this resource or service model.
29838           required: false
29839           type: string
29840         - name: persona-model-version
29841           in: query
29842           description: the ASDC model version for this resource or service model.
29843           required: false
29844           type: string
29845         - name: widget-model-id
29846           in: query
29847           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
29848           required: false
29849           type: string
29850         - name: widget-model-version
29851           in: query
29852           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
29853           required: false
29854           type: string
29855     put:
29856       tags:
29857         - Network
29858       summary: create or update an existing segmentation-assignment
29859       description: |
29860         Create or update an existing segmentation-assignment.
29861         #
29862         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
29863       operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
29864       consumes:
29865         - application/json
29866         - application/xml
29867       produces:
29868         - application/json
29869         - application/xml
29870       responses:
29871         "default":
29872           description: Response codes found in [response codes](https://wiki.onap.org/).
29873       parameters:
29874         - name: network-id
29875           in: path
29876           description: Network ID, should be uuid. Unique across A&AI.
29877           required: true
29878           type: string
29879           example: __NETWORK-ID__
29880         - name: segmentation-id
29881           in: path
29882           description: Route Table Reference id, UUID assigned to this instance.
29883           required: true
29884           type: string
29885           example: __SEGMENTATION-ID__
29886         - name: body
29887           in: body
29888           description: segmentation-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
29889           required: true
29890           schema:
29891             $ref: "#/definitions/segmentation-assignment"
29892     patch:
29893       tags:
29894         - Network
29895       summary: update an existing segmentation-assignment
29896       description: |
29897         Update an existing segmentation-assignment
29898         #
29899         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29900         The PUT operation will entirely replace an existing object.
29901         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
29902         #
29903         Other differences between PUT and PATCH are:
29904         #
29905         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
29906         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29907         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29908       operationId: UpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
29909       consumes:
29910         - application/json
29911         - application/xml
29912       produces:
29913         - application/json
29914         - application/xml
29915       responses:
29916         "default":
29917           description: Response codes found in [response codes](https://wiki.onap.org/).
29918       parameters:
29919         - name: network-id
29920           in: path
29921           description: Network ID, should be uuid. Unique across A&AI.
29922           required: true
29923           type: string
29924           example: __NETWORK-ID__
29925         - name: segmentation-id
29926           in: path
29927           description: Route Table Reference id, UUID assigned to this instance.
29928           required: true
29929           type: string
29930           example: __SEGMENTATION-ID__
29931         - name: body
29932           in: body
29933           description: segmentation-assignment object that needs to be created or updated.
29934           required: true
29935           schema:
29936             $ref: "#/patchDefinitions/segmentation-assignment"
29937     delete:
29938       tags:
29939         - Network
29940       summary: delete an existing segmentation-assignment
29941       description: delete an existing segmentation-assignment
29942       operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
29943       consumes:
29944         - application/json
29945         - application/xml
29946       produces:
29947         - application/json
29948         - application/xml
29949       responses:
29950         "default":
29951           description: Response codes found in [response codes](https://wiki.onap.org/).
29952       parameters:
29953         - name: network-id
29954           in: path
29955           description: Network ID, should be uuid. Unique across A&AI.
29956           required: true
29957           type: string
29958           example: __NETWORK-ID__
29959         - name: segmentation-id
29960           in: path
29961           description: Route Table Reference id, UUID assigned to this instance.
29962           required: true
29963           type: string
29964           example: __SEGMENTATION-ID__
29965         - name: resource-version
29966           in: query
29967           description: resource-version for concurrency
29968           required: true
29969           type: string
29970   /network/l3-networks/l3-network/{network-id}/segmentation-assignments:
29971     get:
29972       tags:
29973         - Network
29974       summary: returns segmentation-assignments
29975       description: returns segmentation-assignments
29976       operationId: getNetworkL3NetworksL3NetworkSegmentationAssignments
29977       produces:
29978         - application/json
29979         - application/xml
29980       responses:
29981         "200":
29982           description: successful operation
29983           schema:
29984               $ref: "#/getDefinitions/segmentation-assignments"
29985         "default":
29986           description: Response codes found in [response codes](https://wiki.onap.org/).
29987       parameters:
29988         - name: network-id
29989           in: path
29990           description: Network ID, should be uuid. Unique across A&AI.
29991           required: true
29992           type: string
29993           example: __NETWORK-ID__
29994         - name: network-name
29995           in: query
29996           description: Name of the network, governed by some naming convention..
29997           required: false
29998           type: string
29999         - name: network-role
30000           in: query
30001           description: Role the network plans - who defines these values?
30002           required: false
30003           type: string
30004         - name: service-id
30005           in: query
30006           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
30007           required: false
30008           type: string
30009         - name: heat-stack-id
30010           in: query
30011           description: Heat stack id corresponding to this instance, managed by MSO
30012           required: false
30013           type: string
30014         - name: contrail-network-fqdn
30015           in: query
30016           description: Contrail FQDN for the network
30017           required: false
30018           type: string
30019         - name: persona-model-id
30020           in: query
30021           description: the ASDC model id for this resource or service model.
30022           required: false
30023           type: string
30024         - name: persona-model-version
30025           in: query
30026           description: the ASDC model version for this resource or service model.
30027           required: false
30028           type: string
30029         - name: widget-model-id
30030           in: query
30031           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
30032           required: false
30033           type: string
30034         - name: widget-model-version
30035           in: query
30036           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
30037           required: false
30038           type: string
30039   /network/l3-networks/l3-network/{network-id}/relationship-list/relationship:
30040     put:
30041       tags:
30042         - Network
30043       summary: see node definition for valid relationships
30044       operationId: createOrUpdateNetworkL3NetworksL3NetworkRelationshipListRelationship
30045       consumes:
30046         - application/json
30047         - application/xml
30048       produces:
30049         - application/json
30050         - application/xml
30051       responses:
30052         "default":
30053           description: Response codes found in [response codes](https://wiki.onap.org/).
30054       parameters:
30055         - name: network-id
30056           in: path
30057           description: Network ID, should be uuid. Unique across A&AI.
30058           required: true
30059           type: string
30060           example: __NETWORK-ID__
30061         - name: body
30062           in: body
30063           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkL3NetworksL3Network.json)
30064           required: true
30065           schema:
30066             $ref: "#/definitions/relationship"
30067     delete:
30068       tags:
30069         - Network
30070       summary: delete an existing relationship
30071       description: delete an existing relationship
30072       operationId: deleteNetworkL3NetworksL3NetworkRelationshipListRelationship
30073       consumes:
30074         - application/json
30075         - application/xml
30076       produces:
30077         - application/json
30078         - application/xml
30079       responses:
30080         "default":
30081           description: Response codes found in [response codes](https://wiki.onap.org/).
30082       parameters:
30083         - name: network-id
30084           in: path
30085           description: Network ID, should be uuid. Unique across A&AI.
30086           required: true
30087           type: string
30088           example: __NETWORK-ID__
30089   /network/l3-networks/l3-network/{network-id}:
30090     get:
30091       tags:
30092         - Network
30093       summary: returns l3-network
30094       description: returns l3-network
30095       operationId: getNetworkL3NetworksL3Network
30096       produces:
30097         - application/json
30098         - application/xml
30099       responses:
30100         "200":
30101           description: successful operation
30102           schema:
30103               $ref: "#/getDefinitions/l3-network"
30104         "default":
30105           description: Response codes found in [response codes](https://wiki.onap.org/).
30106       parameters:
30107         - name: network-id
30108           in: path
30109           description: Network ID, should be uuid. Unique across A&AI.
30110           required: true
30111           type: string
30112           example: __NETWORK-ID__
30113         - name: network-name
30114           in: query
30115           description: Name of the network, governed by some naming convention..
30116           required: false
30117           type: string
30118         - name: network-role
30119           in: query
30120           description: Role the network plans - who defines these values?
30121           required: false
30122           type: string
30123         - name: service-id
30124           in: query
30125           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
30126           required: false
30127           type: string
30128         - name: heat-stack-id
30129           in: query
30130           description: Heat stack id corresponding to this instance, managed by MSO
30131           required: false
30132           type: string
30133         - name: contrail-network-fqdn
30134           in: query
30135           description: Contrail FQDN for the network
30136           required: false
30137           type: string
30138         - name: persona-model-id
30139           in: query
30140           description: the ASDC model id for this resource or service model.
30141           required: false
30142           type: string
30143         - name: persona-model-version
30144           in: query
30145           description: the ASDC model version for this resource or service model.
30146           required: false
30147           type: string
30148         - name: widget-model-id
30149           in: query
30150           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
30151           required: false
30152           type: string
30153         - name: widget-model-version
30154           in: query
30155           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
30156           required: false
30157           type: string
30158     put:
30159       tags:
30160         - Network
30161       summary: create or update an existing l3-network
30162       description: |
30163         Create or update an existing l3-network.
30164         #
30165         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
30166       operationId: createOrUpdateNetworkL3NetworksL3Network
30167       consumes:
30168         - application/json
30169         - application/xml
30170       produces:
30171         - application/json
30172         - application/xml
30173       responses:
30174         "default":
30175           description: Response codes found in [response codes](https://wiki.onap.org/).
30176       parameters:
30177         - name: network-id
30178           in: path
30179           description: Network ID, should be uuid. Unique across A&AI.
30180           required: true
30181           type: string
30182           example: __NETWORK-ID__
30183         - name: body
30184           in: body
30185           description: l3-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkL3NetworksL3Network.json)
30186           required: true
30187           schema:
30188             $ref: "#/definitions/l3-network"
30189     patch:
30190       tags:
30191         - Network
30192       summary: update an existing l3-network
30193       description: |
30194         Update an existing l3-network
30195         #
30196         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30197         The PUT operation will entirely replace an existing object.
30198         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
30199         #
30200         Other differences between PUT and PATCH are:
30201         #
30202         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
30203         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30204         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30205       operationId: UpdateNetworkL3NetworksL3Network
30206       consumes:
30207         - application/json
30208         - application/xml
30209       produces:
30210         - application/json
30211         - application/xml
30212       responses:
30213         "default":
30214           description: Response codes found in [response codes](https://wiki.onap.org/).
30215       parameters:
30216         - name: network-id
30217           in: path
30218           description: Network ID, should be uuid. Unique across A&AI.
30219           required: true
30220           type: string
30221           example: __NETWORK-ID__
30222         - name: body
30223           in: body
30224           description: l3-network object that needs to be created or updated.
30225           required: true
30226           schema:
30227             $ref: "#/patchDefinitions/l3-network"
30228     delete:
30229       tags:
30230         - Network
30231       summary: delete an existing l3-network
30232       description: delete an existing l3-network
30233       operationId: deleteNetworkL3NetworksL3Network
30234       consumes:
30235         - application/json
30236         - application/xml
30237       produces:
30238         - application/json
30239         - application/xml
30240       responses:
30241         "default":
30242           description: Response codes found in [response codes](https://wiki.onap.org/).
30243       parameters:
30244         - name: network-id
30245           in: path
30246           description: Network ID, should be uuid. Unique across A&AI.
30247           required: true
30248           type: string
30249           example: __NETWORK-ID__
30250         - name: resource-version
30251           in: query
30252           description: resource-version for concurrency
30253           required: true
30254           type: string
30255   /network/l3-networks:
30256     get:
30257       tags:
30258         - Network
30259       summary: returns l3-networks
30260       description: returns l3-networks
30261       operationId: getNetworkL3Networks
30262       produces:
30263         - application/json
30264         - application/xml
30265       responses:
30266         "200":
30267           description: successful operation
30268           schema:
30269               $ref: "#/getDefinitions/l3-networks"
30270         "default":
30271           description: Response codes found in [response codes](https://wiki.onap.org/).
30272   /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship:
30273     put:
30274       tags:
30275         - Network
30276       summary: see node definition for valid relationships
30277       operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship
30278       consumes:
30279         - application/json
30280         - application/xml
30281       produces:
30282         - application/json
30283         - application/xml
30284       responses:
30285         "default":
30286           description: Response codes found in [response codes](https://wiki.onap.org/).
30287       parameters:
30288         - name: network-policy-id
30289           in: path
30290           description: UUID representing unique key to this instance
30291           required: true
30292           type: string
30293           example: __NETWORK-POLICY-ID__
30294         - name: body
30295           in: body
30296           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNetworkPoliciesNetworkPolicy.json)
30297           required: true
30298           schema:
30299             $ref: "#/definitions/relationship"
30300     delete:
30301       tags:
30302         - Network
30303       summary: delete an existing relationship
30304       description: delete an existing relationship
30305       operationId: deleteNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship
30306       consumes:
30307         - application/json
30308         - application/xml
30309       produces:
30310         - application/json
30311         - application/xml
30312       responses:
30313         "default":
30314           description: Response codes found in [response codes](https://wiki.onap.org/).
30315       parameters:
30316         - name: network-policy-id
30317           in: path
30318           description: UUID representing unique key to this instance
30319           required: true
30320           type: string
30321           example: __NETWORK-POLICY-ID__
30322   /network/network-policies/network-policy/{network-policy-id}:
30323     get:
30324       tags:
30325         - Network
30326       summary: returns network-policy
30327       description: returns network-policy
30328       operationId: getNetworkNetworkPoliciesNetworkPolicy
30329       produces:
30330         - application/json
30331         - application/xml
30332       responses:
30333         "200":
30334           description: successful operation
30335           schema:
30336               $ref: "#/getDefinitions/network-policy"
30337         "default":
30338           description: Response codes found in [response codes](https://wiki.onap.org/).
30339       parameters:
30340         - name: network-policy-id
30341           in: path
30342           description: UUID representing unique key to this instance
30343           required: true
30344           type: string
30345           example: __NETWORK-POLICY-ID__
30346         - name: network-policy-fqdn
30347           in: query
30348           description: Contrail FQDN for the policy
30349           required: false
30350           type: string
30351     put:
30352       tags:
30353         - Network
30354       summary: create or update an existing network-policy
30355       description: |
30356         Create or update an existing network-policy.
30357         #
30358         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
30359       operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicy
30360       consumes:
30361         - application/json
30362         - application/xml
30363       produces:
30364         - application/json
30365         - application/xml
30366       responses:
30367         "default":
30368           description: Response codes found in [response codes](https://wiki.onap.org/).
30369       parameters:
30370         - name: network-policy-id
30371           in: path
30372           description: UUID representing unique key to this instance
30373           required: true
30374           type: string
30375           example: __NETWORK-POLICY-ID__
30376         - name: body
30377           in: body
30378           description: network-policy object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNetworkPoliciesNetworkPolicy.json)
30379           required: true
30380           schema:
30381             $ref: "#/definitions/network-policy"
30382     patch:
30383       tags:
30384         - Network
30385       summary: update an existing network-policy
30386       description: |
30387         Update an existing network-policy
30388         #
30389         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30390         The PUT operation will entirely replace an existing object.
30391         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
30392         #
30393         Other differences between PUT and PATCH are:
30394         #
30395         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
30396         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30397         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30398       operationId: UpdateNetworkNetworkPoliciesNetworkPolicy
30399       consumes:
30400         - application/json
30401         - application/xml
30402       produces:
30403         - application/json
30404         - application/xml
30405       responses:
30406         "default":
30407           description: Response codes found in [response codes](https://wiki.onap.org/).
30408       parameters:
30409         - name: network-policy-id
30410           in: path
30411           description: UUID representing unique key to this instance
30412           required: true
30413           type: string
30414           example: __NETWORK-POLICY-ID__
30415         - name: body
30416           in: body
30417           description: network-policy object that needs to be created or updated.
30418           required: true
30419           schema:
30420             $ref: "#/patchDefinitions/network-policy"
30421     delete:
30422       tags:
30423         - Network
30424       summary: delete an existing network-policy
30425       description: delete an existing network-policy
30426       operationId: deleteNetworkNetworkPoliciesNetworkPolicy
30427       consumes:
30428         - application/json
30429         - application/xml
30430       produces:
30431         - application/json
30432         - application/xml
30433       responses:
30434         "default":
30435           description: Response codes found in [response codes](https://wiki.onap.org/).
30436       parameters:
30437         - name: network-policy-id
30438           in: path
30439           description: UUID representing unique key to this instance
30440           required: true
30441           type: string
30442           example: __NETWORK-POLICY-ID__
30443         - name: resource-version
30444           in: query
30445           description: resource-version for concurrency
30446           required: true
30447           type: string
30448   /network/network-policies:
30449     get:
30450       tags:
30451         - Network
30452       summary: returns network-policies
30453       description: returns network-policies
30454       operationId: getNetworkNetworkPolicies
30455       produces:
30456         - application/json
30457         - application/xml
30458       responses:
30459         "200":
30460           description: successful operation
30461           schema:
30462               $ref: "#/getDefinitions/network-policies"
30463         "default":
30464           description: Response codes found in [response codes](https://wiki.onap.org/).
30465   /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship:
30466     put:
30467       tags:
30468         - Network
30469       summary: see node definition for valid relationships
30470       operationId: createOrUpdateNetworkGenericVnfsGenericVnfRelationshipListRelationship
30471       consumes:
30472         - application/json
30473         - application/xml
30474       produces:
30475         - application/json
30476         - application/xml
30477       responses:
30478         "default":
30479           description: Response codes found in [response codes](https://wiki.onap.org/).
30480       parameters:
30481         - name: vnf-id
30482           in: path
30483           description: Unique id of VNF.  This is unique across the graph.
30484           required: true
30485           type: string
30486           example: __VNF-ID__
30487         - name: body
30488           in: body
30489           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnf.json)
30490           required: true
30491           schema:
30492             $ref: "#/definitions/relationship"
30493     delete:
30494       tags:
30495         - Network
30496       summary: delete an existing relationship
30497       description: delete an existing relationship
30498       operationId: deleteNetworkGenericVnfsGenericVnfRelationshipListRelationship
30499       consumes:
30500         - application/json
30501         - application/xml
30502       produces:
30503         - application/json
30504         - application/xml
30505       responses:
30506         "default":
30507           description: Response codes found in [response codes](https://wiki.onap.org/).
30508       parameters:
30509         - name: vnf-id
30510           in: path
30511           description: Unique id of VNF.  This is unique across the graph.
30512           required: true
30513           type: string
30514           example: __VNF-ID__
30515   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
30516     put:
30517       tags:
30518         - Network
30519       summary: see node definition for valid relationships
30520       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship
30521       consumes:
30522         - application/json
30523         - application/xml
30524       produces:
30525         - application/json
30526         - application/xml
30527       responses:
30528         "default":
30529           description: Response codes found in [response codes](https://wiki.onap.org/).
30530       parameters:
30531         - name: vnf-id
30532           in: path
30533           description: Unique id of VNF.  This is unique across the graph.
30534           required: true
30535           type: string
30536           example: __VNF-ID__
30537         - name: interface-name
30538           in: path
30539           description: Name given to the interface
30540           required: true
30541           type: string
30542           example: __INTERFACE-NAME__
30543         - name: vlan-interface
30544           in: path
30545           description: String that identifies the interface
30546           required: true
30547           type: string
30548           example: __VLAN-INTERFACE__
30549         - name: body
30550           in: body
30551           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
30552           required: true
30553           schema:
30554             $ref: "#/definitions/relationship"
30555     delete:
30556       tags:
30557         - Network
30558       summary: delete an existing relationship
30559       description: delete an existing relationship
30560       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship
30561       consumes:
30562         - application/json
30563         - application/xml
30564       produces:
30565         - application/json
30566         - application/xml
30567       responses:
30568         "default":
30569           description: Response codes found in [response codes](https://wiki.onap.org/).
30570       parameters:
30571         - name: vnf-id
30572           in: path
30573           description: Unique id of VNF.  This is unique across the graph.
30574           required: true
30575           type: string
30576           example: __VNF-ID__
30577         - name: interface-name
30578           in: path
30579           description: Name given to the interface
30580           required: true
30581           type: string
30582           example: __INTERFACE-NAME__
30583         - name: vlan-interface
30584           in: path
30585           description: String that identifies the interface
30586           required: true
30587           type: string
30588           example: __VLAN-INTERFACE__
30589   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
30590     put:
30591       tags:
30592         - Network
30593       summary: see node definition for valid relationships
30594       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
30595       consumes:
30596         - application/json
30597         - application/xml
30598       produces:
30599         - application/json
30600         - application/xml
30601       responses:
30602         "default":
30603           description: Response codes found in [response codes](https://wiki.onap.org/).
30604       parameters:
30605         - name: vnf-id
30606           in: path
30607           description: Unique id of VNF.  This is unique across the graph.
30608           required: true
30609           type: string
30610           example: __VNF-ID__
30611         - name: interface-name
30612           in: path
30613           description: Name given to the interface
30614           required: true
30615           type: string
30616           example: __INTERFACE-NAME__
30617         - name: vlan-interface
30618           in: path
30619           description: String that identifies the interface
30620           required: true
30621           type: string
30622           example: __VLAN-INTERFACE__
30623         - name: l3-interface-ipv4-address
30624           in: path
30625           description: IP address
30626           required: true
30627           type: string
30628           example: __L3-INTERFACE-IPV4-ADDRESS__
30629         - name: body
30630           in: body
30631           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
30632           required: true
30633           schema:
30634             $ref: "#/definitions/relationship"
30635     delete:
30636       tags:
30637         - Network
30638       summary: delete an existing relationship
30639       description: delete an existing relationship
30640       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
30641       consumes:
30642         - application/json
30643         - application/xml
30644       produces:
30645         - application/json
30646         - application/xml
30647       responses:
30648         "default":
30649           description: Response codes found in [response codes](https://wiki.onap.org/).
30650       parameters:
30651         - name: vnf-id
30652           in: path
30653           description: Unique id of VNF.  This is unique across the graph.
30654           required: true
30655           type: string
30656           example: __VNF-ID__
30657         - name: interface-name
30658           in: path
30659           description: Name given to the interface
30660           required: true
30661           type: string
30662           example: __INTERFACE-NAME__
30663         - name: vlan-interface
30664           in: path
30665           description: String that identifies the interface
30666           required: true
30667           type: string
30668           example: __VLAN-INTERFACE__
30669         - name: l3-interface-ipv4-address
30670           in: path
30671           description: IP address
30672           required: true
30673           type: string
30674           example: __L3-INTERFACE-IPV4-ADDRESS__
30675   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
30676     get:
30677       tags:
30678         - Network
30679       summary: returns l3-interface-ipv4-address-list
30680       description: returns l3-interface-ipv4-address-list
30681       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
30682       produces:
30683         - application/json
30684         - application/xml
30685       responses:
30686         "200":
30687           description: successful operation
30688           schema:
30689               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
30690         "default":
30691           description: Response codes found in [response codes](https://wiki.onap.org/).
30692       parameters:
30693         - name: vnf-id
30694           in: path
30695           description: Unique id of VNF.  This is unique across the graph.
30696           required: true
30697           type: string
30698           example: __VNF-ID__
30699         - name: interface-name
30700           in: path
30701           description: Name given to the interface
30702           required: true
30703           type: string
30704           example: __INTERFACE-NAME__
30705         - name: vlan-interface
30706           in: path
30707           description: String that identifies the interface
30708           required: true
30709           type: string
30710           example: __VLAN-INTERFACE__
30711         - name: l3-interface-ipv4-address
30712           in: path
30713           description: IP address
30714           required: true
30715           type: string
30716           example: __L3-INTERFACE-IPV4-ADDRESS__
30717         - name: vnf-name
30718           in: query
30719           description: Name of VNF.
30720           required: false
30721           type: string
30722         - name: vnf-name2
30723           in: query
30724           description: Alternate name of VNF.
30725           required: false
30726           type: string
30727         - name: vnf-type
30728           in: query
30729           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
30730           required: false
30731           type: string
30732         - name: service-id
30733           in: query
30734           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
30735           required: false
30736           type: string
30737         - name: regional-resource-zone
30738           in: query
30739           description: Regional way of organizing pservers, source of truth should define values
30740           required: false
30741           type: string
30742         - name: prov-status
30743           in: query
30744           description: Trigger for operational monitoring of this resource by Service Assurance systems.
30745           required: false
30746           type: string
30747         - name: heat-stack-id
30748           in: query
30749           description: Heat stack id corresponding to this instance, managed by MSO
30750           required: false
30751           type: string
30752         - name: in-maint
30753           in: query
30754           required: false
30755           type: boolean
30756         - name: is-closed-loop-disabled
30757           in: query
30758           required: false
30759           type: boolean
30760         - name: persona-model-id
30761           in: query
30762           description: the ASDC model id for this resource or service model.
30763           required: false
30764           type: string
30765         - name: persona-model-version
30766           in: query
30767           description: the ASDC model version for this resource or service model.
30768           required: false
30769           type: string
30770         - name: widget-model-id
30771           in: query
30772           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
30773           required: false
30774           type: string
30775         - name: widget-model-version
30776           in: query
30777           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
30778           required: false
30779           type: string
30780         - name: interface-id
30781           in: query
30782           description: ID of interface
30783           required: false
30784           type: string
30785         - name: macaddr
30786           in: query
30787           description: MAC address for the interface
30788           required: false
30789           type: string
30790         - name: network-name
30791           in: query
30792           description: Name of the network
30793           required: false
30794           type: string
30795         - name: vlan-id-inner
30796           in: query
30797           description: Inner VLAN tag
30798           required: false
30799           type: integer
30800           format: int64
30801         - name: vpn-id
30802           in: query
30803           description: This indicates the customers VPN ID associated with this vlan
30804           required: false
30805           type: string
30806         - name: vlan-id-inner
30807           in: query
30808           description: Inner VLAN tag
30809           required: false
30810           type: integer
30811           format: int64
30812         - name: neutron-network-id
30813           in: query
30814           description: Neutron network id of the interface that address belongs to
30815           required: false
30816           type: string
30817         - name: neutron-subnet-id
30818           in: query
30819           description: Neutron id of subnet that address belongs to
30820           required: false
30821           type: string
30822     put:
30823       tags:
30824         - Network
30825       summary: create or update an existing l3-interface-ipv4-address-list
30826       description: |
30827         Create or update an existing l3-interface-ipv4-address-list.
30828         #
30829         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
30830       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
30831       consumes:
30832         - application/json
30833         - application/xml
30834       produces:
30835         - application/json
30836         - application/xml
30837       responses:
30838         "default":
30839           description: Response codes found in [response codes](https://wiki.onap.org/).
30840       parameters:
30841         - name: vnf-id
30842           in: path
30843           description: Unique id of VNF.  This is unique across the graph.
30844           required: true
30845           type: string
30846           example: __VNF-ID__
30847         - name: interface-name
30848           in: path
30849           description: Name given to the interface
30850           required: true
30851           type: string
30852           example: __INTERFACE-NAME__
30853         - name: vlan-interface
30854           in: path
30855           description: String that identifies the interface
30856           required: true
30857           type: string
30858           example: __VLAN-INTERFACE__
30859         - name: l3-interface-ipv4-address
30860           in: path
30861           description: IP address
30862           required: true
30863           type: string
30864           example: __L3-INTERFACE-IPV4-ADDRESS__
30865         - name: body
30866           in: body
30867           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
30868           required: true
30869           schema:
30870             $ref: "#/definitions/l3-interface-ipv4-address-list"
30871     patch:
30872       tags:
30873         - Network
30874       summary: update an existing l3-interface-ipv4-address-list
30875       description: |
30876         Update an existing l3-interface-ipv4-address-list
30877         #
30878         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30879         The PUT operation will entirely replace an existing object.
30880         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
30881         #
30882         Other differences between PUT and PATCH are:
30883         #
30884         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
30885         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30886         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30887       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
30888       consumes:
30889         - application/json
30890         - application/xml
30891       produces:
30892         - application/json
30893         - application/xml
30894       responses:
30895         "default":
30896           description: Response codes found in [response codes](https://wiki.onap.org/).
30897       parameters:
30898         - name: vnf-id
30899           in: path
30900           description: Unique id of VNF.  This is unique across the graph.
30901           required: true
30902           type: string
30903           example: __VNF-ID__
30904         - name: interface-name
30905           in: path
30906           description: Name given to the interface
30907           required: true
30908           type: string
30909           example: __INTERFACE-NAME__
30910         - name: vlan-interface
30911           in: path
30912           description: String that identifies the interface
30913           required: true
30914           type: string
30915           example: __VLAN-INTERFACE__
30916         - name: l3-interface-ipv4-address
30917           in: path
30918           description: IP address
30919           required: true
30920           type: string
30921           example: __L3-INTERFACE-IPV4-ADDRESS__
30922         - name: body
30923           in: body
30924           description: l3-interface-ipv4-address-list object that needs to be created or updated.
30925           required: true
30926           schema:
30927             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
30928     delete:
30929       tags:
30930         - Network
30931       summary: delete an existing l3-interface-ipv4-address-list
30932       description: delete an existing l3-interface-ipv4-address-list
30933       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
30934       consumes:
30935         - application/json
30936         - application/xml
30937       produces:
30938         - application/json
30939         - application/xml
30940       responses:
30941         "default":
30942           description: Response codes found in [response codes](https://wiki.onap.org/).
30943       parameters:
30944         - name: vnf-id
30945           in: path
30946           description: Unique id of VNF.  This is unique across the graph.
30947           required: true
30948           type: string
30949           example: __VNF-ID__
30950         - name: interface-name
30951           in: path
30952           description: Name given to the interface
30953           required: true
30954           type: string
30955           example: __INTERFACE-NAME__
30956         - name: vlan-interface
30957           in: path
30958           description: String that identifies the interface
30959           required: true
30960           type: string
30961           example: __VLAN-INTERFACE__
30962         - name: l3-interface-ipv4-address
30963           in: path
30964           description: IP address
30965           required: true
30966           type: string
30967           example: __L3-INTERFACE-IPV4-ADDRESS__
30968         - name: resource-version
30969           in: query
30970           description: resource-version for concurrency
30971           required: true
30972           type: string
30973   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
30974     put:
30975       tags:
30976         - Network
30977       summary: see node definition for valid relationships
30978       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
30979       consumes:
30980         - application/json
30981         - application/xml
30982       produces:
30983         - application/json
30984         - application/xml
30985       responses:
30986         "default":
30987           description: Response codes found in [response codes](https://wiki.onap.org/).
30988       parameters:
30989         - name: vnf-id
30990           in: path
30991           description: Unique id of VNF.  This is unique across the graph.
30992           required: true
30993           type: string
30994           example: __VNF-ID__
30995         - name: interface-name
30996           in: path
30997           description: Name given to the interface
30998           required: true
30999           type: string
31000           example: __INTERFACE-NAME__
31001         - name: vlan-interface
31002           in: path
31003           description: String that identifies the interface
31004           required: true
31005           type: string
31006           example: __VLAN-INTERFACE__
31007         - name: l3-interface-ipv6-address
31008           in: path
31009           description: IP address
31010           required: true
31011           type: string
31012           example: __L3-INTERFACE-IPV6-ADDRESS__
31013         - name: body
31014           in: body
31015           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
31016           required: true
31017           schema:
31018             $ref: "#/definitions/relationship"
31019     delete:
31020       tags:
31021         - Network
31022       summary: delete an existing relationship
31023       description: delete an existing relationship
31024       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
31025       consumes:
31026         - application/json
31027         - application/xml
31028       produces:
31029         - application/json
31030         - application/xml
31031       responses:
31032         "default":
31033           description: Response codes found in [response codes](https://wiki.onap.org/).
31034       parameters:
31035         - name: vnf-id
31036           in: path
31037           description: Unique id of VNF.  This is unique across the graph.
31038           required: true
31039           type: string
31040           example: __VNF-ID__
31041         - name: interface-name
31042           in: path
31043           description: Name given to the interface
31044           required: true
31045           type: string
31046           example: __INTERFACE-NAME__
31047         - name: vlan-interface
31048           in: path
31049           description: String that identifies the interface
31050           required: true
31051           type: string
31052           example: __VLAN-INTERFACE__
31053         - name: l3-interface-ipv6-address
31054           in: path
31055           description: IP address
31056           required: true
31057           type: string
31058           example: __L3-INTERFACE-IPV6-ADDRESS__
31059   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
31060     get:
31061       tags:
31062         - Network
31063       summary: returns l3-interface-ipv6-address-list
31064       description: returns l3-interface-ipv6-address-list
31065       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
31066       produces:
31067         - application/json
31068         - application/xml
31069       responses:
31070         "200":
31071           description: successful operation
31072           schema:
31073               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
31074         "default":
31075           description: Response codes found in [response codes](https://wiki.onap.org/).
31076       parameters:
31077         - name: vnf-id
31078           in: path
31079           description: Unique id of VNF.  This is unique across the graph.
31080           required: true
31081           type: string
31082           example: __VNF-ID__
31083         - name: interface-name
31084           in: path
31085           description: Name given to the interface
31086           required: true
31087           type: string
31088           example: __INTERFACE-NAME__
31089         - name: vlan-interface
31090           in: path
31091           description: String that identifies the interface
31092           required: true
31093           type: string
31094           example: __VLAN-INTERFACE__
31095         - name: l3-interface-ipv6-address
31096           in: path
31097           description: IP address
31098           required: true
31099           type: string
31100           example: __L3-INTERFACE-IPV6-ADDRESS__
31101         - name: vnf-name
31102           in: query
31103           description: Name of VNF.
31104           required: false
31105           type: string
31106         - name: vnf-name2
31107           in: query
31108           description: Alternate name of VNF.
31109           required: false
31110           type: string
31111         - name: vnf-type
31112           in: query
31113           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
31114           required: false
31115           type: string
31116         - name: service-id
31117           in: query
31118           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
31119           required: false
31120           type: string
31121         - name: regional-resource-zone
31122           in: query
31123           description: Regional way of organizing pservers, source of truth should define values
31124           required: false
31125           type: string
31126         - name: prov-status
31127           in: query
31128           description: Trigger for operational monitoring of this resource by Service Assurance systems.
31129           required: false
31130           type: string
31131         - name: heat-stack-id
31132           in: query
31133           description: Heat stack id corresponding to this instance, managed by MSO
31134           required: false
31135           type: string
31136         - name: in-maint
31137           in: query
31138           required: false
31139           type: boolean
31140         - name: is-closed-loop-disabled
31141           in: query
31142           required: false
31143           type: boolean
31144         - name: persona-model-id
31145           in: query
31146           description: the ASDC model id for this resource or service model.
31147           required: false
31148           type: string
31149         - name: persona-model-version
31150           in: query
31151           description: the ASDC model version for this resource or service model.
31152           required: false
31153           type: string
31154         - name: widget-model-id
31155           in: query
31156           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
31157           required: false
31158           type: string
31159         - name: widget-model-version
31160           in: query
31161           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
31162           required: false
31163           type: string
31164         - name: interface-id
31165           in: query
31166           description: ID of interface
31167           required: false
31168           type: string
31169         - name: macaddr
31170           in: query
31171           description: MAC address for the interface
31172           required: false
31173           type: string
31174         - name: network-name
31175           in: query
31176           description: Name of the network
31177           required: false
31178           type: string
31179         - name: vlan-id-inner
31180           in: query
31181           description: Inner VLAN tag
31182           required: false
31183           type: integer
31184           format: int64
31185         - name: vpn-id
31186           in: query
31187           description: This indicates the customers VPN ID associated with this vlan
31188           required: false
31189           type: string
31190         - name: vlan-id-inner
31191           in: query
31192           description: Inner VLAN tag
31193           required: false
31194           type: integer
31195           format: int64
31196         - name: neutron-network-id
31197           in: query
31198           description: Neutron network id of the interface that address belongs to
31199           required: false
31200           type: string
31201         - name: neutron-subnet-id
31202           in: query
31203           description: Neutron id of subnet that address belongs to
31204           required: false
31205           type: string
31206     put:
31207       tags:
31208         - Network
31209       summary: create or update an existing l3-interface-ipv6-address-list
31210       description: |
31211         Create or update an existing l3-interface-ipv6-address-list.
31212         #
31213         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
31214       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
31215       consumes:
31216         - application/json
31217         - application/xml
31218       produces:
31219         - application/json
31220         - application/xml
31221       responses:
31222         "default":
31223           description: Response codes found in [response codes](https://wiki.onap.org/).
31224       parameters:
31225         - name: vnf-id
31226           in: path
31227           description: Unique id of VNF.  This is unique across the graph.
31228           required: true
31229           type: string
31230           example: __VNF-ID__
31231         - name: interface-name
31232           in: path
31233           description: Name given to the interface
31234           required: true
31235           type: string
31236           example: __INTERFACE-NAME__
31237         - name: vlan-interface
31238           in: path
31239           description: String that identifies the interface
31240           required: true
31241           type: string
31242           example: __VLAN-INTERFACE__
31243         - name: l3-interface-ipv6-address
31244           in: path
31245           description: IP address
31246           required: true
31247           type: string
31248           example: __L3-INTERFACE-IPV6-ADDRESS__
31249         - name: body
31250           in: body
31251           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
31252           required: true
31253           schema:
31254             $ref: "#/definitions/l3-interface-ipv6-address-list"
31255     patch:
31256       tags:
31257         - Network
31258       summary: update an existing l3-interface-ipv6-address-list
31259       description: |
31260         Update an existing l3-interface-ipv6-address-list
31261         #
31262         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31263         The PUT operation will entirely replace an existing object.
31264         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
31265         #
31266         Other differences between PUT and PATCH are:
31267         #
31268         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
31269         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31270         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31271       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
31272       consumes:
31273         - application/json
31274         - application/xml
31275       produces:
31276         - application/json
31277         - application/xml
31278       responses:
31279         "default":
31280           description: Response codes found in [response codes](https://wiki.onap.org/).
31281       parameters:
31282         - name: vnf-id
31283           in: path
31284           description: Unique id of VNF.  This is unique across the graph.
31285           required: true
31286           type: string
31287           example: __VNF-ID__
31288         - name: interface-name
31289           in: path
31290           description: Name given to the interface
31291           required: true
31292           type: string
31293           example: __INTERFACE-NAME__
31294         - name: vlan-interface
31295           in: path
31296           description: String that identifies the interface
31297           required: true
31298           type: string
31299           example: __VLAN-INTERFACE__
31300         - name: l3-interface-ipv6-address
31301           in: path
31302           description: IP address
31303           required: true
31304           type: string
31305           example: __L3-INTERFACE-IPV6-ADDRESS__
31306         - name: body
31307           in: body
31308           description: l3-interface-ipv6-address-list object that needs to be created or updated.
31309           required: true
31310           schema:
31311             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
31312     delete:
31313       tags:
31314         - Network
31315       summary: delete an existing l3-interface-ipv6-address-list
31316       description: delete an existing l3-interface-ipv6-address-list
31317       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
31318       consumes:
31319         - application/json
31320         - application/xml
31321       produces:
31322         - application/json
31323         - application/xml
31324       responses:
31325         "default":
31326           description: Response codes found in [response codes](https://wiki.onap.org/).
31327       parameters:
31328         - name: vnf-id
31329           in: path
31330           description: Unique id of VNF.  This is unique across the graph.
31331           required: true
31332           type: string
31333           example: __VNF-ID__
31334         - name: interface-name
31335           in: path
31336           description: Name given to the interface
31337           required: true
31338           type: string
31339           example: __INTERFACE-NAME__
31340         - name: vlan-interface
31341           in: path
31342           description: String that identifies the interface
31343           required: true
31344           type: string
31345           example: __VLAN-INTERFACE__
31346         - name: l3-interface-ipv6-address
31347           in: path
31348           description: IP address
31349           required: true
31350           type: string
31351           example: __L3-INTERFACE-IPV6-ADDRESS__
31352         - name: resource-version
31353           in: query
31354           description: resource-version for concurrency
31355           required: true
31356           type: string
31357   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
31358     get:
31359       tags:
31360         - Network
31361       summary: returns vlan
31362       description: returns vlan
31363       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
31364       produces:
31365         - application/json
31366         - application/xml
31367       responses:
31368         "200":
31369           description: successful operation
31370           schema:
31371               $ref: "#/getDefinitions/vlan"
31372         "default":
31373           description: Response codes found in [response codes](https://wiki.onap.org/).
31374       parameters:
31375         - name: vnf-id
31376           in: path
31377           description: Unique id of VNF.  This is unique across the graph.
31378           required: true
31379           type: string
31380           example: __VNF-ID__
31381         - name: interface-name
31382           in: path
31383           description: Name given to the interface
31384           required: true
31385           type: string
31386           example: __INTERFACE-NAME__
31387         - name: vlan-interface
31388           in: path
31389           description: String that identifies the interface
31390           required: true
31391           type: string
31392           example: __VLAN-INTERFACE__
31393         - name: vnf-name
31394           in: query
31395           description: Name of VNF.
31396           required: false
31397           type: string
31398         - name: vnf-name2
31399           in: query
31400           description: Alternate name of VNF.
31401           required: false
31402           type: string
31403         - name: vnf-type
31404           in: query
31405           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
31406           required: false
31407           type: string
31408         - name: service-id
31409           in: query
31410           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
31411           required: false
31412           type: string
31413         - name: regional-resource-zone
31414           in: query
31415           description: Regional way of organizing pservers, source of truth should define values
31416           required: false
31417           type: string
31418         - name: prov-status
31419           in: query
31420           description: Trigger for operational monitoring of this resource by Service Assurance systems.
31421           required: false
31422           type: string
31423         - name: heat-stack-id
31424           in: query
31425           description: Heat stack id corresponding to this instance, managed by MSO
31426           required: false
31427           type: string
31428         - name: in-maint
31429           in: query
31430           required: false
31431           type: boolean
31432         - name: is-closed-loop-disabled
31433           in: query
31434           required: false
31435           type: boolean
31436         - name: persona-model-id
31437           in: query
31438           description: the ASDC model id for this resource or service model.
31439           required: false
31440           type: string
31441         - name: persona-model-version
31442           in: query
31443           description: the ASDC model version for this resource or service model.
31444           required: false
31445           type: string
31446         - name: widget-model-id
31447           in: query
31448           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
31449           required: false
31450           type: string
31451         - name: widget-model-version
31452           in: query
31453           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
31454           required: false
31455           type: string
31456         - name: interface-id
31457           in: query
31458           description: ID of interface
31459           required: false
31460           type: string
31461         - name: macaddr
31462           in: query
31463           description: MAC address for the interface
31464           required: false
31465           type: string
31466         - name: network-name
31467           in: query
31468           description: Name of the network
31469           required: false
31470           type: string
31471         - name: vlan-id-inner
31472           in: query
31473           description: Inner VLAN tag
31474           required: false
31475           type: integer
31476           format: int64
31477         - name: vpn-id
31478           in: query
31479           description: This indicates the customers VPN ID associated with this vlan
31480           required: false
31481           type: string
31482     put:
31483       tags:
31484         - Network
31485       summary: create or update an existing vlan
31486       description: |
31487         Create or update an existing vlan.
31488         #
31489         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
31490       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
31491       consumes:
31492         - application/json
31493         - application/xml
31494       produces:
31495         - application/json
31496         - application/xml
31497       responses:
31498         "default":
31499           description: Response codes found in [response codes](https://wiki.onap.org/).
31500       parameters:
31501         - name: vnf-id
31502           in: path
31503           description: Unique id of VNF.  This is unique across the graph.
31504           required: true
31505           type: string
31506           example: __VNF-ID__
31507         - name: interface-name
31508           in: path
31509           description: Name given to the interface
31510           required: true
31511           type: string
31512           example: __INTERFACE-NAME__
31513         - name: vlan-interface
31514           in: path
31515           description: String that identifies the interface
31516           required: true
31517           type: string
31518           example: __VLAN-INTERFACE__
31519         - name: body
31520           in: body
31521           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
31522           required: true
31523           schema:
31524             $ref: "#/definitions/vlan"
31525     patch:
31526       tags:
31527         - Network
31528       summary: update an existing vlan
31529       description: |
31530         Update an existing vlan
31531         #
31532         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31533         The PUT operation will entirely replace an existing object.
31534         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
31535         #
31536         Other differences between PUT and PATCH are:
31537         #
31538         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
31539         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31540         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31541       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
31542       consumes:
31543         - application/json
31544         - application/xml
31545       produces:
31546         - application/json
31547         - application/xml
31548       responses:
31549         "default":
31550           description: Response codes found in [response codes](https://wiki.onap.org/).
31551       parameters:
31552         - name: vnf-id
31553           in: path
31554           description: Unique id of VNF.  This is unique across the graph.
31555           required: true
31556           type: string
31557           example: __VNF-ID__
31558         - name: interface-name
31559           in: path
31560           description: Name given to the interface
31561           required: true
31562           type: string
31563           example: __INTERFACE-NAME__
31564         - name: vlan-interface
31565           in: path
31566           description: String that identifies the interface
31567           required: true
31568           type: string
31569           example: __VLAN-INTERFACE__
31570         - name: body
31571           in: body
31572           description: vlan object that needs to be created or updated.
31573           required: true
31574           schema:
31575             $ref: "#/patchDefinitions/vlan"
31576     delete:
31577       tags:
31578         - Network
31579       summary: delete an existing vlan
31580       description: delete an existing vlan
31581       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
31582       consumes:
31583         - application/json
31584         - application/xml
31585       produces:
31586         - application/json
31587         - application/xml
31588       responses:
31589         "default":
31590           description: Response codes found in [response codes](https://wiki.onap.org/).
31591       parameters:
31592         - name: vnf-id
31593           in: path
31594           description: Unique id of VNF.  This is unique across the graph.
31595           required: true
31596           type: string
31597           example: __VNF-ID__
31598         - name: interface-name
31599           in: path
31600           description: Name given to the interface
31601           required: true
31602           type: string
31603           example: __INTERFACE-NAME__
31604         - name: vlan-interface
31605           in: path
31606           description: String that identifies the interface
31607           required: true
31608           type: string
31609           example: __VLAN-INTERFACE__
31610         - name: resource-version
31611           in: query
31612           description: resource-version for concurrency
31613           required: true
31614           type: string
31615   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans:
31616     get:
31617       tags:
31618         - Network
31619       summary: returns vlans
31620       description: returns vlans
31621       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlans
31622       produces:
31623         - application/json
31624         - application/xml
31625       responses:
31626         "200":
31627           description: successful operation
31628           schema:
31629               $ref: "#/getDefinitions/vlans"
31630         "default":
31631           description: Response codes found in [response codes](https://wiki.onap.org/).
31632       parameters:
31633         - name: vnf-id
31634           in: path
31635           description: Unique id of VNF.  This is unique across the graph.
31636           required: true
31637           type: string
31638           example: __VNF-ID__
31639         - name: interface-name
31640           in: path
31641           description: Name given to the interface
31642           required: true
31643           type: string
31644           example: __INTERFACE-NAME__
31645         - name: vnf-name
31646           in: query
31647           description: Name of VNF.
31648           required: false
31649           type: string
31650         - name: vnf-name2
31651           in: query
31652           description: Alternate name of VNF.
31653           required: false
31654           type: string
31655         - name: vnf-type
31656           in: query
31657           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
31658           required: false
31659           type: string
31660         - name: service-id
31661           in: query
31662           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
31663           required: false
31664           type: string
31665         - name: regional-resource-zone
31666           in: query
31667           description: Regional way of organizing pservers, source of truth should define values
31668           required: false
31669           type: string
31670         - name: prov-status
31671           in: query
31672           description: Trigger for operational monitoring of this resource by Service Assurance systems.
31673           required: false
31674           type: string
31675         - name: heat-stack-id
31676           in: query
31677           description: Heat stack id corresponding to this instance, managed by MSO
31678           required: false
31679           type: string
31680         - name: in-maint
31681           in: query
31682           required: false
31683           type: boolean
31684         - name: is-closed-loop-disabled
31685           in: query
31686           required: false
31687           type: boolean
31688         - name: persona-model-id
31689           in: query
31690           description: the ASDC model id for this resource or service model.
31691           required: false
31692           type: string
31693         - name: persona-model-version
31694           in: query
31695           description: the ASDC model version for this resource or service model.
31696           required: false
31697           type: string
31698         - name: widget-model-id
31699           in: query
31700           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
31701           required: false
31702           type: string
31703         - name: widget-model-version
31704           in: query
31705           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
31706           required: false
31707           type: string
31708         - name: interface-id
31709           in: query
31710           description: ID of interface
31711           required: false
31712           type: string
31713         - name: macaddr
31714           in: query
31715           description: MAC address for the interface
31716           required: false
31717           type: string
31718         - name: network-name
31719           in: query
31720           description: Name of the network
31721           required: false
31722           type: string
31723   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
31724     put:
31725       tags:
31726         - Network
31727       summary: see node definition for valid relationships
31728       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
31729       consumes:
31730         - application/json
31731         - application/xml
31732       produces:
31733         - application/json
31734         - application/xml
31735       responses:
31736         "default":
31737           description: Response codes found in [response codes](https://wiki.onap.org/).
31738       parameters:
31739         - name: vnf-id
31740           in: path
31741           description: Unique id of VNF.  This is unique across the graph.
31742           required: true
31743           type: string
31744           example: __VNF-ID__
31745         - name: interface-name
31746           in: path
31747           description: Name given to the interface
31748           required: true
31749           type: string
31750           example: __INTERFACE-NAME__
31751         - name: pci-id
31752           in: path
31753           description: PCI ID used to identify the sriov-vf
31754           required: true
31755           type: string
31756           example: __PCI-ID__
31757         - name: body
31758           in: body
31759           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
31760           required: true
31761           schema:
31762             $ref: "#/definitions/relationship"
31763     delete:
31764       tags:
31765         - Network
31766       summary: delete an existing relationship
31767       description: delete an existing relationship
31768       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
31769       consumes:
31770         - application/json
31771         - application/xml
31772       produces:
31773         - application/json
31774         - application/xml
31775       responses:
31776         "default":
31777           description: Response codes found in [response codes](https://wiki.onap.org/).
31778       parameters:
31779         - name: vnf-id
31780           in: path
31781           description: Unique id of VNF.  This is unique across the graph.
31782           required: true
31783           type: string
31784           example: __VNF-ID__
31785         - name: interface-name
31786           in: path
31787           description: Name given to the interface
31788           required: true
31789           type: string
31790           example: __INTERFACE-NAME__
31791         - name: pci-id
31792           in: path
31793           description: PCI ID used to identify the sriov-vf
31794           required: true
31795           type: string
31796           example: __PCI-ID__
31797   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
31798     get:
31799       tags:
31800         - Network
31801       summary: returns sriov-vf
31802       description: returns sriov-vf
31803       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
31804       produces:
31805         - application/json
31806         - application/xml
31807       responses:
31808         "200":
31809           description: successful operation
31810           schema:
31811               $ref: "#/getDefinitions/sriov-vf"
31812         "default":
31813           description: Response codes found in [response codes](https://wiki.onap.org/).
31814       parameters:
31815         - name: vnf-id
31816           in: path
31817           description: Unique id of VNF.  This is unique across the graph.
31818           required: true
31819           type: string
31820           example: __VNF-ID__
31821         - name: interface-name
31822           in: path
31823           description: Name given to the interface
31824           required: true
31825           type: string
31826           example: __INTERFACE-NAME__
31827         - name: pci-id
31828           in: path
31829           description: PCI ID used to identify the sriov-vf
31830           required: true
31831           type: string
31832           example: __PCI-ID__
31833         - name: vnf-name
31834           in: query
31835           description: Name of VNF.
31836           required: false
31837           type: string
31838         - name: vnf-name2
31839           in: query
31840           description: Alternate name of VNF.
31841           required: false
31842           type: string
31843         - name: vnf-type
31844           in: query
31845           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
31846           required: false
31847           type: string
31848         - name: service-id
31849           in: query
31850           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
31851           required: false
31852           type: string
31853         - name: regional-resource-zone
31854           in: query
31855           description: Regional way of organizing pservers, source of truth should define values
31856           required: false
31857           type: string
31858         - name: prov-status
31859           in: query
31860           description: Trigger for operational monitoring of this resource by Service Assurance systems.
31861           required: false
31862           type: string
31863         - name: heat-stack-id
31864           in: query
31865           description: Heat stack id corresponding to this instance, managed by MSO
31866           required: false
31867           type: string
31868         - name: in-maint
31869           in: query
31870           required: false
31871           type: boolean
31872         - name: is-closed-loop-disabled
31873           in: query
31874           required: false
31875           type: boolean
31876         - name: persona-model-id
31877           in: query
31878           description: the ASDC model id for this resource or service model.
31879           required: false
31880           type: string
31881         - name: persona-model-version
31882           in: query
31883           description: the ASDC model version for this resource or service model.
31884           required: false
31885           type: string
31886         - name: widget-model-id
31887           in: query
31888           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
31889           required: false
31890           type: string
31891         - name: widget-model-version
31892           in: query
31893           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
31894           required: false
31895           type: string
31896         - name: interface-id
31897           in: query
31898           description: ID of interface
31899           required: false
31900           type: string
31901         - name: macaddr
31902           in: query
31903           description: MAC address for the interface
31904           required: false
31905           type: string
31906         - name: network-name
31907           in: query
31908           description: Name of the network
31909           required: false
31910           type: string
31911         - name: vf-vlan-filter
31912           in: query
31913           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
31914           required: false
31915           type: string
31916         - name: vf-mac-filter
31917           in: query
31918           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
31919           required: false
31920           type: string
31921         - name: vf-vlan-strip
31922           in: query
31923           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
31924           required: false
31925           type: boolean
31926         - name: neutron-network-id
31927           in: query
31928           description: Neutron network id of the interface
31929           required: false
31930           type: string
31931     put:
31932       tags:
31933         - Network
31934       summary: create or update an existing sriov-vf
31935       description: |
31936         Create or update an existing sriov-vf.
31937         #
31938         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
31939       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
31940       consumes:
31941         - application/json
31942         - application/xml
31943       produces:
31944         - application/json
31945         - application/xml
31946       responses:
31947         "default":
31948           description: Response codes found in [response codes](https://wiki.onap.org/).
31949       parameters:
31950         - name: vnf-id
31951           in: path
31952           description: Unique id of VNF.  This is unique across the graph.
31953           required: true
31954           type: string
31955           example: __VNF-ID__
31956         - name: interface-name
31957           in: path
31958           description: Name given to the interface
31959           required: true
31960           type: string
31961           example: __INTERFACE-NAME__
31962         - name: pci-id
31963           in: path
31964           description: PCI ID used to identify the sriov-vf
31965           required: true
31966           type: string
31967           example: __PCI-ID__
31968         - name: body
31969           in: body
31970           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
31971           required: true
31972           schema:
31973             $ref: "#/definitions/sriov-vf"
31974     patch:
31975       tags:
31976         - Network
31977       summary: update an existing sriov-vf
31978       description: |
31979         Update an existing sriov-vf
31980         #
31981         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31982         The PUT operation will entirely replace an existing object.
31983         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
31984         #
31985         Other differences between PUT and PATCH are:
31986         #
31987         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
31988         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31989         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31990       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
31991       consumes:
31992         - application/json
31993         - application/xml
31994       produces:
31995         - application/json
31996         - application/xml
31997       responses:
31998         "default":
31999           description: Response codes found in [response codes](https://wiki.onap.org/).
32000       parameters:
32001         - name: vnf-id
32002           in: path
32003           description: Unique id of VNF.  This is unique across the graph.
32004           required: true
32005           type: string
32006           example: __VNF-ID__
32007         - name: interface-name
32008           in: path
32009           description: Name given to the interface
32010           required: true
32011           type: string
32012           example: __INTERFACE-NAME__
32013         - name: pci-id
32014           in: path
32015           description: PCI ID used to identify the sriov-vf
32016           required: true
32017           type: string
32018           example: __PCI-ID__
32019         - name: body
32020           in: body
32021           description: sriov-vf object that needs to be created or updated.
32022           required: true
32023           schema:
32024             $ref: "#/patchDefinitions/sriov-vf"
32025     delete:
32026       tags:
32027         - Network
32028       summary: delete an existing sriov-vf
32029       description: delete an existing sriov-vf
32030       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
32031       consumes:
32032         - application/json
32033         - application/xml
32034       produces:
32035         - application/json
32036         - application/xml
32037       responses:
32038         "default":
32039           description: Response codes found in [response codes](https://wiki.onap.org/).
32040       parameters:
32041         - name: vnf-id
32042           in: path
32043           description: Unique id of VNF.  This is unique across the graph.
32044           required: true
32045           type: string
32046           example: __VNF-ID__
32047         - name: interface-name
32048           in: path
32049           description: Name given to the interface
32050           required: true
32051           type: string
32052           example: __INTERFACE-NAME__
32053         - name: pci-id
32054           in: path
32055           description: PCI ID used to identify the sriov-vf
32056           required: true
32057           type: string
32058           example: __PCI-ID__
32059         - name: resource-version
32060           in: query
32061           description: resource-version for concurrency
32062           required: true
32063           type: string
32064   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
32065     get:
32066       tags:
32067         - Network
32068       summary: returns sriov-vfs
32069       description: returns sriov-vfs
32070       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfs
32071       produces:
32072         - application/json
32073         - application/xml
32074       responses:
32075         "200":
32076           description: successful operation
32077           schema:
32078               $ref: "#/getDefinitions/sriov-vfs"
32079         "default":
32080           description: Response codes found in [response codes](https://wiki.onap.org/).
32081       parameters:
32082         - name: vnf-id
32083           in: path
32084           description: Unique id of VNF.  This is unique across the graph.
32085           required: true
32086           type: string
32087           example: __VNF-ID__
32088         - name: interface-name
32089           in: path
32090           description: Name given to the interface
32091           required: true
32092           type: string
32093           example: __INTERFACE-NAME__
32094         - name: vnf-name
32095           in: query
32096           description: Name of VNF.
32097           required: false
32098           type: string
32099         - name: vnf-name2
32100           in: query
32101           description: Alternate name of VNF.
32102           required: false
32103           type: string
32104         - name: vnf-type
32105           in: query
32106           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
32107           required: false
32108           type: string
32109         - name: service-id
32110           in: query
32111           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
32112           required: false
32113           type: string
32114         - name: regional-resource-zone
32115           in: query
32116           description: Regional way of organizing pservers, source of truth should define values
32117           required: false
32118           type: string
32119         - name: prov-status
32120           in: query
32121           description: Trigger for operational monitoring of this resource by Service Assurance systems.
32122           required: false
32123           type: string
32124         - name: heat-stack-id
32125           in: query
32126           description: Heat stack id corresponding to this instance, managed by MSO
32127           required: false
32128           type: string
32129         - name: in-maint
32130           in: query
32131           required: false
32132           type: boolean
32133         - name: is-closed-loop-disabled
32134           in: query
32135           required: false
32136           type: boolean
32137         - name: persona-model-id
32138           in: query
32139           description: the ASDC model id for this resource or service model.
32140           required: false
32141           type: string
32142         - name: persona-model-version
32143           in: query
32144           description: the ASDC model version for this resource or service model.
32145           required: false
32146           type: string
32147         - name: widget-model-id
32148           in: query
32149           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
32150           required: false
32151           type: string
32152         - name: widget-model-version
32153           in: query
32154           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
32155           required: false
32156           type: string
32157         - name: interface-id
32158           in: query
32159           description: ID of interface
32160           required: false
32161           type: string
32162         - name: macaddr
32163           in: query
32164           description: MAC address for the interface
32165           required: false
32166           type: string
32167         - name: network-name
32168           in: query
32169           description: Name of the network
32170           required: false
32171           type: string
32172   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
32173     put:
32174       tags:
32175         - Network
32176       summary: see node definition for valid relationships
32177       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship
32178       consumes:
32179         - application/json
32180         - application/xml
32181       produces:
32182         - application/json
32183         - application/xml
32184       responses:
32185         "default":
32186           description: Response codes found in [response codes](https://wiki.onap.org/).
32187       parameters:
32188         - name: vnf-id
32189           in: path
32190           description: Unique id of VNF.  This is unique across the graph.
32191           required: true
32192           type: string
32193           example: __VNF-ID__
32194         - name: interface-name
32195           in: path
32196           description: Name given to the interface
32197           required: true
32198           type: string
32199           example: __INTERFACE-NAME__
32200         - name: body
32201           in: body
32202           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
32203           required: true
32204           schema:
32205             $ref: "#/definitions/relationship"
32206     delete:
32207       tags:
32208         - Network
32209       summary: delete an existing relationship
32210       description: delete an existing relationship
32211       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship
32212       consumes:
32213         - application/json
32214         - application/xml
32215       produces:
32216         - application/json
32217         - application/xml
32218       responses:
32219         "default":
32220           description: Response codes found in [response codes](https://wiki.onap.org/).
32221       parameters:
32222         - name: vnf-id
32223           in: path
32224           description: Unique id of VNF.  This is unique across the graph.
32225           required: true
32226           type: string
32227           example: __VNF-ID__
32228         - name: interface-name
32229           in: path
32230           description: Name given to the interface
32231           required: true
32232           type: string
32233           example: __INTERFACE-NAME__
32234   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
32235     put:
32236       tags:
32237         - Network
32238       summary: see node definition for valid relationships
32239       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
32240       consumes:
32241         - application/json
32242         - application/xml
32243       produces:
32244         - application/json
32245         - application/xml
32246       responses:
32247         "default":
32248           description: Response codes found in [response codes](https://wiki.onap.org/).
32249       parameters:
32250         - name: vnf-id
32251           in: path
32252           description: Unique id of VNF.  This is unique across the graph.
32253           required: true
32254           type: string
32255           example: __VNF-ID__
32256         - name: interface-name
32257           in: path
32258           description: Name given to the interface
32259           required: true
32260           type: string
32261           example: __INTERFACE-NAME__
32262         - name: l3-interface-ipv4-address
32263           in: path
32264           description: IP address
32265           required: true
32266           type: string
32267           example: __L3-INTERFACE-IPV4-ADDRESS__
32268         - name: body
32269           in: body
32270           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
32271           required: true
32272           schema:
32273             $ref: "#/definitions/relationship"
32274     delete:
32275       tags:
32276         - Network
32277       summary: delete an existing relationship
32278       description: delete an existing relationship
32279       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
32280       consumes:
32281         - application/json
32282         - application/xml
32283       produces:
32284         - application/json
32285         - application/xml
32286       responses:
32287         "default":
32288           description: Response codes found in [response codes](https://wiki.onap.org/).
32289       parameters:
32290         - name: vnf-id
32291           in: path
32292           description: Unique id of VNF.  This is unique across the graph.
32293           required: true
32294           type: string
32295           example: __VNF-ID__
32296         - name: interface-name
32297           in: path
32298           description: Name given to the interface
32299           required: true
32300           type: string
32301           example: __INTERFACE-NAME__
32302         - name: l3-interface-ipv4-address
32303           in: path
32304           description: IP address
32305           required: true
32306           type: string
32307           example: __L3-INTERFACE-IPV4-ADDRESS__
32308   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
32309     get:
32310       tags:
32311         - Network
32312       summary: returns l3-interface-ipv4-address-list
32313       description: returns l3-interface-ipv4-address-list
32314       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
32315       produces:
32316         - application/json
32317         - application/xml
32318       responses:
32319         "200":
32320           description: successful operation
32321           schema:
32322               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
32323         "default":
32324           description: Response codes found in [response codes](https://wiki.onap.org/).
32325       parameters:
32326         - name: vnf-id
32327           in: path
32328           description: Unique id of VNF.  This is unique across the graph.
32329           required: true
32330           type: string
32331           example: __VNF-ID__
32332         - name: interface-name
32333           in: path
32334           description: Name given to the interface
32335           required: true
32336           type: string
32337           example: __INTERFACE-NAME__
32338         - name: l3-interface-ipv4-address
32339           in: path
32340           description: IP address
32341           required: true
32342           type: string
32343           example: __L3-INTERFACE-IPV4-ADDRESS__
32344         - name: vnf-name
32345           in: query
32346           description: Name of VNF.
32347           required: false
32348           type: string
32349         - name: vnf-name2
32350           in: query
32351           description: Alternate name of VNF.
32352           required: false
32353           type: string
32354         - name: vnf-type
32355           in: query
32356           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
32357           required: false
32358           type: string
32359         - name: service-id
32360           in: query
32361           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
32362           required: false
32363           type: string
32364         - name: regional-resource-zone
32365           in: query
32366           description: Regional way of organizing pservers, source of truth should define values
32367           required: false
32368           type: string
32369         - name: prov-status
32370           in: query
32371           description: Trigger for operational monitoring of this resource by Service Assurance systems.
32372           required: false
32373           type: string
32374         - name: heat-stack-id
32375           in: query
32376           description: Heat stack id corresponding to this instance, managed by MSO
32377           required: false
32378           type: string
32379         - name: in-maint
32380           in: query
32381           required: false
32382           type: boolean
32383         - name: is-closed-loop-disabled
32384           in: query
32385           required: false
32386           type: boolean
32387         - name: persona-model-id
32388           in: query
32389           description: the ASDC model id for this resource or service model.
32390           required: false
32391           type: string
32392         - name: persona-model-version
32393           in: query
32394           description: the ASDC model version for this resource or service model.
32395           required: false
32396           type: string
32397         - name: widget-model-id
32398           in: query
32399           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
32400           required: false
32401           type: string
32402         - name: widget-model-version
32403           in: query
32404           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
32405           required: false
32406           type: string
32407         - name: interface-id
32408           in: query
32409           description: ID of interface
32410           required: false
32411           type: string
32412         - name: macaddr
32413           in: query
32414           description: MAC address for the interface
32415           required: false
32416           type: string
32417         - name: network-name
32418           in: query
32419           description: Name of the network
32420           required: false
32421           type: string
32422         - name: vlan-id-inner
32423           in: query
32424           description: Inner VLAN tag
32425           required: false
32426           type: integer
32427           format: int64
32428         - name: neutron-network-id
32429           in: query
32430           description: Neutron network id of the interface that address belongs to
32431           required: false
32432           type: string
32433         - name: neutron-subnet-id
32434           in: query
32435           description: Neutron id of subnet that address belongs to
32436           required: false
32437           type: string
32438     put:
32439       tags:
32440         - Network
32441       summary: create or update an existing l3-interface-ipv4-address-list
32442       description: |
32443         Create or update an existing l3-interface-ipv4-address-list.
32444         #
32445         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
32446       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
32447       consumes:
32448         - application/json
32449         - application/xml
32450       produces:
32451         - application/json
32452         - application/xml
32453       responses:
32454         "default":
32455           description: Response codes found in [response codes](https://wiki.onap.org/).
32456       parameters:
32457         - name: vnf-id
32458           in: path
32459           description: Unique id of VNF.  This is unique across the graph.
32460           required: true
32461           type: string
32462           example: __VNF-ID__
32463         - name: interface-name
32464           in: path
32465           description: Name given to the interface
32466           required: true
32467           type: string
32468           example: __INTERFACE-NAME__
32469         - name: l3-interface-ipv4-address
32470           in: path
32471           description: IP address
32472           required: true
32473           type: string
32474           example: __L3-INTERFACE-IPV4-ADDRESS__
32475         - name: body
32476           in: body
32477           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
32478           required: true
32479           schema:
32480             $ref: "#/definitions/l3-interface-ipv4-address-list"
32481     patch:
32482       tags:
32483         - Network
32484       summary: update an existing l3-interface-ipv4-address-list
32485       description: |
32486         Update an existing l3-interface-ipv4-address-list
32487         #
32488         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32489         The PUT operation will entirely replace an existing object.
32490         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
32491         #
32492         Other differences between PUT and PATCH are:
32493         #
32494         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
32495         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32496         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32497       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
32498       consumes:
32499         - application/json
32500         - application/xml
32501       produces:
32502         - application/json
32503         - application/xml
32504       responses:
32505         "default":
32506           description: Response codes found in [response codes](https://wiki.onap.org/).
32507       parameters:
32508         - name: vnf-id
32509           in: path
32510           description: Unique id of VNF.  This is unique across the graph.
32511           required: true
32512           type: string
32513           example: __VNF-ID__
32514         - name: interface-name
32515           in: path
32516           description: Name given to the interface
32517           required: true
32518           type: string
32519           example: __INTERFACE-NAME__
32520         - name: l3-interface-ipv4-address
32521           in: path
32522           description: IP address
32523           required: true
32524           type: string
32525           example: __L3-INTERFACE-IPV4-ADDRESS__
32526         - name: body
32527           in: body
32528           description: l3-interface-ipv4-address-list object that needs to be created or updated.
32529           required: true
32530           schema:
32531             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
32532     delete:
32533       tags:
32534         - Network
32535       summary: delete an existing l3-interface-ipv4-address-list
32536       description: delete an existing l3-interface-ipv4-address-list
32537       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
32538       consumes:
32539         - application/json
32540         - application/xml
32541       produces:
32542         - application/json
32543         - application/xml
32544       responses:
32545         "default":
32546           description: Response codes found in [response codes](https://wiki.onap.org/).
32547       parameters:
32548         - name: vnf-id
32549           in: path
32550           description: Unique id of VNF.  This is unique across the graph.
32551           required: true
32552           type: string
32553           example: __VNF-ID__
32554         - name: interface-name
32555           in: path
32556           description: Name given to the interface
32557           required: true
32558           type: string
32559           example: __INTERFACE-NAME__
32560         - name: l3-interface-ipv4-address
32561           in: path
32562           description: IP address
32563           required: true
32564           type: string
32565           example: __L3-INTERFACE-IPV4-ADDRESS__
32566         - name: resource-version
32567           in: query
32568           description: resource-version for concurrency
32569           required: true
32570           type: string
32571   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
32572     put:
32573       tags:
32574         - Network
32575       summary: see node definition for valid relationships
32576       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
32577       consumes:
32578         - application/json
32579         - application/xml
32580       produces:
32581         - application/json
32582         - application/xml
32583       responses:
32584         "default":
32585           description: Response codes found in [response codes](https://wiki.onap.org/).
32586       parameters:
32587         - name: vnf-id
32588           in: path
32589           description: Unique id of VNF.  This is unique across the graph.
32590           required: true
32591           type: string
32592           example: __VNF-ID__
32593         - name: interface-name
32594           in: path
32595           description: Name given to the interface
32596           required: true
32597           type: string
32598           example: __INTERFACE-NAME__
32599         - name: l3-interface-ipv6-address
32600           in: path
32601           description: IP address
32602           required: true
32603           type: string
32604           example: __L3-INTERFACE-IPV6-ADDRESS__
32605         - name: body
32606           in: body
32607           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
32608           required: true
32609           schema:
32610             $ref: "#/definitions/relationship"
32611     delete:
32612       tags:
32613         - Network
32614       summary: delete an existing relationship
32615       description: delete an existing relationship
32616       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
32617       consumes:
32618         - application/json
32619         - application/xml
32620       produces:
32621         - application/json
32622         - application/xml
32623       responses:
32624         "default":
32625           description: Response codes found in [response codes](https://wiki.onap.org/).
32626       parameters:
32627         - name: vnf-id
32628           in: path
32629           description: Unique id of VNF.  This is unique across the graph.
32630           required: true
32631           type: string
32632           example: __VNF-ID__
32633         - name: interface-name
32634           in: path
32635           description: Name given to the interface
32636           required: true
32637           type: string
32638           example: __INTERFACE-NAME__
32639         - name: l3-interface-ipv6-address
32640           in: path
32641           description: IP address
32642           required: true
32643           type: string
32644           example: __L3-INTERFACE-IPV6-ADDRESS__
32645   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
32646     get:
32647       tags:
32648         - Network
32649       summary: returns l3-interface-ipv6-address-list
32650       description: returns l3-interface-ipv6-address-list
32651       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
32652       produces:
32653         - application/json
32654         - application/xml
32655       responses:
32656         "200":
32657           description: successful operation
32658           schema:
32659               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
32660         "default":
32661           description: Response codes found in [response codes](https://wiki.onap.org/).
32662       parameters:
32663         - name: vnf-id
32664           in: path
32665           description: Unique id of VNF.  This is unique across the graph.
32666           required: true
32667           type: string
32668           example: __VNF-ID__
32669         - name: interface-name
32670           in: path
32671           description: Name given to the interface
32672           required: true
32673           type: string
32674           example: __INTERFACE-NAME__
32675         - name: l3-interface-ipv6-address
32676           in: path
32677           description: IP address
32678           required: true
32679           type: string
32680           example: __L3-INTERFACE-IPV6-ADDRESS__
32681         - name: vnf-name
32682           in: query
32683           description: Name of VNF.
32684           required: false
32685           type: string
32686         - name: vnf-name2
32687           in: query
32688           description: Alternate name of VNF.
32689           required: false
32690           type: string
32691         - name: vnf-type
32692           in: query
32693           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
32694           required: false
32695           type: string
32696         - name: service-id
32697           in: query
32698           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
32699           required: false
32700           type: string
32701         - name: regional-resource-zone
32702           in: query
32703           description: Regional way of organizing pservers, source of truth should define values
32704           required: false
32705           type: string
32706         - name: prov-status
32707           in: query
32708           description: Trigger for operational monitoring of this resource by Service Assurance systems.
32709           required: false
32710           type: string
32711         - name: heat-stack-id
32712           in: query
32713           description: Heat stack id corresponding to this instance, managed by MSO
32714           required: false
32715           type: string
32716         - name: in-maint
32717           in: query
32718           required: false
32719           type: boolean
32720         - name: is-closed-loop-disabled
32721           in: query
32722           required: false
32723           type: boolean
32724         - name: persona-model-id
32725           in: query
32726           description: the ASDC model id for this resource or service model.
32727           required: false
32728           type: string
32729         - name: persona-model-version
32730           in: query
32731           description: the ASDC model version for this resource or service model.
32732           required: false
32733           type: string
32734         - name: widget-model-id
32735           in: query
32736           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
32737           required: false
32738           type: string
32739         - name: widget-model-version
32740           in: query
32741           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
32742           required: false
32743           type: string
32744         - name: interface-id
32745           in: query
32746           description: ID of interface
32747           required: false
32748           type: string
32749         - name: macaddr
32750           in: query
32751           description: MAC address for the interface
32752           required: false
32753           type: string
32754         - name: network-name
32755           in: query
32756           description: Name of the network
32757           required: false
32758           type: string
32759         - name: vlan-id-inner
32760           in: query
32761           description: Inner VLAN tag
32762           required: false
32763           type: integer
32764           format: int64
32765         - name: neutron-network-id
32766           in: query
32767           description: Neutron network id of the interface that address belongs to
32768           required: false
32769           type: string
32770         - name: neutron-subnet-id
32771           in: query
32772           description: Neutron id of subnet that address belongs to
32773           required: false
32774           type: string
32775     put:
32776       tags:
32777         - Network
32778       summary: create or update an existing l3-interface-ipv6-address-list
32779       description: |
32780         Create or update an existing l3-interface-ipv6-address-list.
32781         #
32782         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
32783       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
32784       consumes:
32785         - application/json
32786         - application/xml
32787       produces:
32788         - application/json
32789         - application/xml
32790       responses:
32791         "default":
32792           description: Response codes found in [response codes](https://wiki.onap.org/).
32793       parameters:
32794         - name: vnf-id
32795           in: path
32796           description: Unique id of VNF.  This is unique across the graph.
32797           required: true
32798           type: string
32799           example: __VNF-ID__
32800         - name: interface-name
32801           in: path
32802           description: Name given to the interface
32803           required: true
32804           type: string
32805           example: __INTERFACE-NAME__
32806         - name: l3-interface-ipv6-address
32807           in: path
32808           description: IP address
32809           required: true
32810           type: string
32811           example: __L3-INTERFACE-IPV6-ADDRESS__
32812         - name: body
32813           in: body
32814           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
32815           required: true
32816           schema:
32817             $ref: "#/definitions/l3-interface-ipv6-address-list"
32818     patch:
32819       tags:
32820         - Network
32821       summary: update an existing l3-interface-ipv6-address-list
32822       description: |
32823         Update an existing l3-interface-ipv6-address-list
32824         #
32825         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32826         The PUT operation will entirely replace an existing object.
32827         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
32828         #
32829         Other differences between PUT and PATCH are:
32830         #
32831         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
32832         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32833         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32834       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
32835       consumes:
32836         - application/json
32837         - application/xml
32838       produces:
32839         - application/json
32840         - application/xml
32841       responses:
32842         "default":
32843           description: Response codes found in [response codes](https://wiki.onap.org/).
32844       parameters:
32845         - name: vnf-id
32846           in: path
32847           description: Unique id of VNF.  This is unique across the graph.
32848           required: true
32849           type: string
32850           example: __VNF-ID__
32851         - name: interface-name
32852           in: path
32853           description: Name given to the interface
32854           required: true
32855           type: string
32856           example: __INTERFACE-NAME__
32857         - name: l3-interface-ipv6-address
32858           in: path
32859           description: IP address
32860           required: true
32861           type: string
32862           example: __L3-INTERFACE-IPV6-ADDRESS__
32863         - name: body
32864           in: body
32865           description: l3-interface-ipv6-address-list object that needs to be created or updated.
32866           required: true
32867           schema:
32868             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
32869     delete:
32870       tags:
32871         - Network
32872       summary: delete an existing l3-interface-ipv6-address-list
32873       description: delete an existing l3-interface-ipv6-address-list
32874       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
32875       consumes:
32876         - application/json
32877         - application/xml
32878       produces:
32879         - application/json
32880         - application/xml
32881       responses:
32882         "default":
32883           description: Response codes found in [response codes](https://wiki.onap.org/).
32884       parameters:
32885         - name: vnf-id
32886           in: path
32887           description: Unique id of VNF.  This is unique across the graph.
32888           required: true
32889           type: string
32890           example: __VNF-ID__
32891         - name: interface-name
32892           in: path
32893           description: Name given to the interface
32894           required: true
32895           type: string
32896           example: __INTERFACE-NAME__
32897         - name: l3-interface-ipv6-address
32898           in: path
32899           description: IP address
32900           required: true
32901           type: string
32902           example: __L3-INTERFACE-IPV6-ADDRESS__
32903         - name: resource-version
32904           in: query
32905           description: resource-version for concurrency
32906           required: true
32907           type: string
32908   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}:
32909     get:
32910       tags:
32911         - Network
32912       summary: returns l-interface
32913       description: returns l-interface
32914       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterface
32915       produces:
32916         - application/json
32917         - application/xml
32918       responses:
32919         "200":
32920           description: successful operation
32921           schema:
32922               $ref: "#/getDefinitions/l-interface"
32923         "default":
32924           description: Response codes found in [response codes](https://wiki.onap.org/).
32925       parameters:
32926         - name: vnf-id
32927           in: path
32928           description: Unique id of VNF.  This is unique across the graph.
32929           required: true
32930           type: string
32931           example: __VNF-ID__
32932         - name: interface-name
32933           in: path
32934           description: Name given to the interface
32935           required: true
32936           type: string
32937           example: __INTERFACE-NAME__
32938         - name: vnf-name
32939           in: query
32940           description: Name of VNF.
32941           required: false
32942           type: string
32943         - name: vnf-name2
32944           in: query
32945           description: Alternate name of VNF.
32946           required: false
32947           type: string
32948         - name: vnf-type
32949           in: query
32950           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
32951           required: false
32952           type: string
32953         - name: service-id
32954           in: query
32955           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
32956           required: false
32957           type: string
32958         - name: regional-resource-zone
32959           in: query
32960           description: Regional way of organizing pservers, source of truth should define values
32961           required: false
32962           type: string
32963         - name: prov-status
32964           in: query
32965           description: Trigger for operational monitoring of this resource by Service Assurance systems.
32966           required: false
32967           type: string
32968         - name: heat-stack-id
32969           in: query
32970           description: Heat stack id corresponding to this instance, managed by MSO
32971           required: false
32972           type: string
32973         - name: in-maint
32974           in: query
32975           required: false
32976           type: boolean
32977         - name: is-closed-loop-disabled
32978           in: query
32979           required: false
32980           type: boolean
32981         - name: persona-model-id
32982           in: query
32983           description: the ASDC model id for this resource or service model.
32984           required: false
32985           type: string
32986         - name: persona-model-version
32987           in: query
32988           description: the ASDC model version for this resource or service model.
32989           required: false
32990           type: string
32991         - name: widget-model-id
32992           in: query
32993           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
32994           required: false
32995           type: string
32996         - name: widget-model-version
32997           in: query
32998           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
32999           required: false
33000           type: string
33001         - name: interface-id
33002           in: query
33003           description: ID of interface
33004           required: false
33005           type: string
33006         - name: macaddr
33007           in: query
33008           description: MAC address for the interface
33009           required: false
33010           type: string
33011         - name: network-name
33012           in: query
33013           description: Name of the network
33014           required: false
33015           type: string
33016     put:
33017       tags:
33018         - Network
33019       summary: create or update an existing l-interface
33020       description: |
33021         Create or update an existing l-interface.
33022         #
33023         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
33024       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface
33025       consumes:
33026         - application/json
33027         - application/xml
33028       produces:
33029         - application/json
33030         - application/xml
33031       responses:
33032         "default":
33033           description: Response codes found in [response codes](https://wiki.onap.org/).
33034       parameters:
33035         - name: vnf-id
33036           in: path
33037           description: Unique id of VNF.  This is unique across the graph.
33038           required: true
33039           type: string
33040           example: __VNF-ID__
33041         - name: interface-name
33042           in: path
33043           description: Name given to the interface
33044           required: true
33045           type: string
33046           example: __INTERFACE-NAME__
33047         - name: body
33048           in: body
33049           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
33050           required: true
33051           schema:
33052             $ref: "#/definitions/l-interface"
33053     patch:
33054       tags:
33055         - Network
33056       summary: update an existing l-interface
33057       description: |
33058         Update an existing l-interface
33059         #
33060         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33061         The PUT operation will entirely replace an existing object.
33062         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
33063         #
33064         Other differences between PUT and PATCH are:
33065         #
33066         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
33067         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33068         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33069       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface
33070       consumes:
33071         - application/json
33072         - application/xml
33073       produces:
33074         - application/json
33075         - application/xml
33076       responses:
33077         "default":
33078           description: Response codes found in [response codes](https://wiki.onap.org/).
33079       parameters:
33080         - name: vnf-id
33081           in: path
33082           description: Unique id of VNF.  This is unique across the graph.
33083           required: true
33084           type: string
33085           example: __VNF-ID__
33086         - name: interface-name
33087           in: path
33088           description: Name given to the interface
33089           required: true
33090           type: string
33091           example: __INTERFACE-NAME__
33092         - name: body
33093           in: body
33094           description: l-interface object that needs to be created or updated.
33095           required: true
33096           schema:
33097             $ref: "#/patchDefinitions/l-interface"
33098     delete:
33099       tags:
33100         - Network
33101       summary: delete an existing l-interface
33102       description: delete an existing l-interface
33103       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterface
33104       consumes:
33105         - application/json
33106         - application/xml
33107       produces:
33108         - application/json
33109         - application/xml
33110       responses:
33111         "default":
33112           description: Response codes found in [response codes](https://wiki.onap.org/).
33113       parameters:
33114         - name: vnf-id
33115           in: path
33116           description: Unique id of VNF.  This is unique across the graph.
33117           required: true
33118           type: string
33119           example: __VNF-ID__
33120         - name: interface-name
33121           in: path
33122           description: Name given to the interface
33123           required: true
33124           type: string
33125           example: __INTERFACE-NAME__
33126         - name: resource-version
33127           in: query
33128           description: resource-version for concurrency
33129           required: true
33130           type: string
33131   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces:
33132     get:
33133       tags:
33134         - Network
33135       summary: returns l-interfaces
33136       description: returns l-interfaces
33137       operationId: getNetworkGenericVnfsGenericVnfLInterfaces
33138       produces:
33139         - application/json
33140         - application/xml
33141       responses:
33142         "200":
33143           description: successful operation
33144           schema:
33145               $ref: "#/getDefinitions/l-interfaces"
33146         "default":
33147           description: Response codes found in [response codes](https://wiki.onap.org/).
33148       parameters:
33149         - name: vnf-id
33150           in: path
33151           description: Unique id of VNF.  This is unique across the graph.
33152           required: true
33153           type: string
33154           example: __VNF-ID__
33155         - name: vnf-name
33156           in: query
33157           description: Name of VNF.
33158           required: false
33159           type: string
33160         - name: vnf-name2
33161           in: query
33162           description: Alternate name of VNF.
33163           required: false
33164           type: string
33165         - name: vnf-type
33166           in: query
33167           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
33168           required: false
33169           type: string
33170         - name: service-id
33171           in: query
33172           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
33173           required: false
33174           type: string
33175         - name: regional-resource-zone
33176           in: query
33177           description: Regional way of organizing pservers, source of truth should define values
33178           required: false
33179           type: string
33180         - name: prov-status
33181           in: query
33182           description: Trigger for operational monitoring of this resource by Service Assurance systems.
33183           required: false
33184           type: string
33185         - name: heat-stack-id
33186           in: query
33187           description: Heat stack id corresponding to this instance, managed by MSO
33188           required: false
33189           type: string
33190         - name: in-maint
33191           in: query
33192           required: false
33193           type: boolean
33194         - name: is-closed-loop-disabled
33195           in: query
33196           required: false
33197           type: boolean
33198         - name: persona-model-id
33199           in: query
33200           description: the ASDC model id for this resource or service model.
33201           required: false
33202           type: string
33203         - name: persona-model-version
33204           in: query
33205           description: the ASDC model version for this resource or service model.
33206           required: false
33207           type: string
33208         - name: widget-model-id
33209           in: query
33210           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
33211           required: false
33212           type: string
33213         - name: widget-model-version
33214           in: query
33215           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
33216           required: false
33217           type: string
33218   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
33219     put:
33220       tags:
33221         - Network
33222       summary: see node definition for valid relationships
33223       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship
33224       consumes:
33225         - application/json
33226         - application/xml
33227       produces:
33228         - application/json
33229         - application/xml
33230       responses:
33231         "default":
33232           description: Response codes found in [response codes](https://wiki.onap.org/).
33233       parameters:
33234         - name: vnf-id
33235           in: path
33236           description: Unique id of VNF.  This is unique across the graph.
33237           required: true
33238           type: string
33239           example: __VNF-ID__
33240         - name: interface-name
33241           in: path
33242           description: Name that identifies the link aggregate interface
33243           required: true
33244           type: string
33245           example: __INTERFACE-NAME__
33246         - name: body
33247           in: body
33248           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
33249           required: true
33250           schema:
33251             $ref: "#/definitions/relationship"
33252     delete:
33253       tags:
33254         - Network
33255       summary: delete an existing relationship
33256       description: delete an existing relationship
33257       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship
33258       consumes:
33259         - application/json
33260         - application/xml
33261       produces:
33262         - application/json
33263         - application/xml
33264       responses:
33265         "default":
33266           description: Response codes found in [response codes](https://wiki.onap.org/).
33267       parameters:
33268         - name: vnf-id
33269           in: path
33270           description: Unique id of VNF.  This is unique across the graph.
33271           required: true
33272           type: string
33273           example: __VNF-ID__
33274         - name: interface-name
33275           in: path
33276           description: Name that identifies the link aggregate interface
33277           required: true
33278           type: string
33279           example: __INTERFACE-NAME__
33280   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
33281     put:
33282       tags:
33283         - Network
33284       summary: see node definition for valid relationships
33285       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
33286       consumes:
33287         - application/json
33288         - application/xml
33289       produces:
33290         - application/json
33291         - application/xml
33292       responses:
33293         "default":
33294           description: Response codes found in [response codes](https://wiki.onap.org/).
33295       parameters:
33296         - name: vnf-id
33297           in: path
33298           description: Unique id of VNF.  This is unique across the graph.
33299           required: true
33300           type: string
33301           example: __VNF-ID__
33302         - name: interface-name
33303           in: path
33304           description: Name that identifies the link aggregate interface
33305           required: true
33306           type: string
33307           example: __INTERFACE-NAME__
33308         - name: interface-name
33309           in: path
33310           description: Name given to the interface
33311           required: true
33312           type: string
33313           example: __INTERFACE-NAME__
33314         - name: vlan-interface
33315           in: path
33316           description: String that identifies the interface
33317           required: true
33318           type: string
33319           example: __VLAN-INTERFACE__
33320         - name: body
33321           in: body
33322           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
33323           required: true
33324           schema:
33325             $ref: "#/definitions/relationship"
33326     delete:
33327       tags:
33328         - Network
33329       summary: delete an existing relationship
33330       description: delete an existing relationship
33331       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
33332       consumes:
33333         - application/json
33334         - application/xml
33335       produces:
33336         - application/json
33337         - application/xml
33338       responses:
33339         "default":
33340           description: Response codes found in [response codes](https://wiki.onap.org/).
33341       parameters:
33342         - name: vnf-id
33343           in: path
33344           description: Unique id of VNF.  This is unique across the graph.
33345           required: true
33346           type: string
33347           example: __VNF-ID__
33348         - name: interface-name
33349           in: path
33350           description: Name that identifies the link aggregate interface
33351           required: true
33352           type: string
33353           example: __INTERFACE-NAME__
33354         - name: interface-name
33355           in: path
33356           description: Name given to the interface
33357           required: true
33358           type: string
33359           example: __INTERFACE-NAME__
33360         - name: vlan-interface
33361           in: path
33362           description: String that identifies the interface
33363           required: true
33364           type: string
33365           example: __VLAN-INTERFACE__
33366   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
33367     put:
33368       tags:
33369         - Network
33370       summary: see node definition for valid relationships
33371       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
33372       consumes:
33373         - application/json
33374         - application/xml
33375       produces:
33376         - application/json
33377         - application/xml
33378       responses:
33379         "default":
33380           description: Response codes found in [response codes](https://wiki.onap.org/).
33381       parameters:
33382         - name: vnf-id
33383           in: path
33384           description: Unique id of VNF.  This is unique across the graph.
33385           required: true
33386           type: string
33387           example: __VNF-ID__
33388         - name: interface-name
33389           in: path
33390           description: Name that identifies the link aggregate interface
33391           required: true
33392           type: string
33393           example: __INTERFACE-NAME__
33394         - name: interface-name
33395           in: path
33396           description: Name given to the interface
33397           required: true
33398           type: string
33399           example: __INTERFACE-NAME__
33400         - name: vlan-interface
33401           in: path
33402           description: String that identifies the interface
33403           required: true
33404           type: string
33405           example: __VLAN-INTERFACE__
33406         - name: l3-interface-ipv4-address
33407           in: path
33408           description: IP address
33409           required: true
33410           type: string
33411           example: __L3-INTERFACE-IPV4-ADDRESS__
33412         - name: body
33413           in: body
33414           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
33415           required: true
33416           schema:
33417             $ref: "#/definitions/relationship"
33418     delete:
33419       tags:
33420         - Network
33421       summary: delete an existing relationship
33422       description: delete an existing relationship
33423       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
33424       consumes:
33425         - application/json
33426         - application/xml
33427       produces:
33428         - application/json
33429         - application/xml
33430       responses:
33431         "default":
33432           description: Response codes found in [response codes](https://wiki.onap.org/).
33433       parameters:
33434         - name: vnf-id
33435           in: path
33436           description: Unique id of VNF.  This is unique across the graph.
33437           required: true
33438           type: string
33439           example: __VNF-ID__
33440         - name: interface-name
33441           in: path
33442           description: Name that identifies the link aggregate interface
33443           required: true
33444           type: string
33445           example: __INTERFACE-NAME__
33446         - name: interface-name
33447           in: path
33448           description: Name given to the interface
33449           required: true
33450           type: string
33451           example: __INTERFACE-NAME__
33452         - name: vlan-interface
33453           in: path
33454           description: String that identifies the interface
33455           required: true
33456           type: string
33457           example: __VLAN-INTERFACE__
33458         - name: l3-interface-ipv4-address
33459           in: path
33460           description: IP address
33461           required: true
33462           type: string
33463           example: __L3-INTERFACE-IPV4-ADDRESS__
33464   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
33465     get:
33466       tags:
33467         - Network
33468       summary: returns l3-interface-ipv4-address-list
33469       description: returns l3-interface-ipv4-address-list
33470       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
33471       produces:
33472         - application/json
33473         - application/xml
33474       responses:
33475         "200":
33476           description: successful operation
33477           schema:
33478               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
33479         "default":
33480           description: Response codes found in [response codes](https://wiki.onap.org/).
33481       parameters:
33482         - name: vnf-id
33483           in: path
33484           description: Unique id of VNF.  This is unique across the graph.
33485           required: true
33486           type: string
33487           example: __VNF-ID__
33488         - name: interface-name
33489           in: path
33490           description: Name that identifies the link aggregate interface
33491           required: true
33492           type: string
33493           example: __INTERFACE-NAME__
33494         - name: interface-name
33495           in: path
33496           description: Name given to the interface
33497           required: true
33498           type: string
33499           example: __INTERFACE-NAME__
33500         - name: vlan-interface
33501           in: path
33502           description: String that identifies the interface
33503           required: true
33504           type: string
33505           example: __VLAN-INTERFACE__
33506         - name: l3-interface-ipv4-address
33507           in: path
33508           description: IP address
33509           required: true
33510           type: string
33511           example: __L3-INTERFACE-IPV4-ADDRESS__
33512         - name: vnf-name
33513           in: query
33514           description: Name of VNF.
33515           required: false
33516           type: string
33517         - name: vnf-name2
33518           in: query
33519           description: Alternate name of VNF.
33520           required: false
33521           type: string
33522         - name: vnf-type
33523           in: query
33524           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
33525           required: false
33526           type: string
33527         - name: service-id
33528           in: query
33529           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
33530           required: false
33531           type: string
33532         - name: regional-resource-zone
33533           in: query
33534           description: Regional way of organizing pservers, source of truth should define values
33535           required: false
33536           type: string
33537         - name: prov-status
33538           in: query
33539           description: Trigger for operational monitoring of this resource by Service Assurance systems.
33540           required: false
33541           type: string
33542         - name: heat-stack-id
33543           in: query
33544           description: Heat stack id corresponding to this instance, managed by MSO
33545           required: false
33546           type: string
33547         - name: in-maint
33548           in: query
33549           required: false
33550           type: boolean
33551         - name: is-closed-loop-disabled
33552           in: query
33553           required: false
33554           type: boolean
33555         - name: persona-model-id
33556           in: query
33557           description: the ASDC model id for this resource or service model.
33558           required: false
33559           type: string
33560         - name: persona-model-version
33561           in: query
33562           description: the ASDC model version for this resource or service model.
33563           required: false
33564           type: string
33565         - name: widget-model-id
33566           in: query
33567           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
33568           required: false
33569           type: string
33570         - name: widget-model-version
33571           in: query
33572           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
33573           required: false
33574           type: string
33575         - name: interface-id
33576           in: query
33577           description: ID of interface
33578           required: false
33579           type: string
33580         - name: interface-role
33581           in: query
33582           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
33583           required: false
33584           type: string
33585         - name: interface-id
33586           in: query
33587           description: ID of interface
33588           required: false
33589           type: string
33590         - name: macaddr
33591           in: query
33592           description: MAC address for the interface
33593           required: false
33594           type: string
33595         - name: network-name
33596           in: query
33597           description: Name of the network
33598           required: false
33599           type: string
33600         - name: vlan-id-inner
33601           in: query
33602           description: Inner VLAN tag
33603           required: false
33604           type: integer
33605           format: int64
33606         - name: vpn-id
33607           in: query
33608           description: This indicates the customers VPN ID associated with this vlan
33609           required: false
33610           type: string
33611         - name: vlan-id-inner
33612           in: query
33613           description: Inner VLAN tag
33614           required: false
33615           type: integer
33616           format: int64
33617         - name: neutron-network-id
33618           in: query
33619           description: Neutron network id of the interface that address belongs to
33620           required: false
33621           type: string
33622         - name: neutron-subnet-id
33623           in: query
33624           description: Neutron id of subnet that address belongs to
33625           required: false
33626           type: string
33627     put:
33628       tags:
33629         - Network
33630       summary: create or update an existing l3-interface-ipv4-address-list
33631       description: |
33632         Create or update an existing l3-interface-ipv4-address-list.
33633         #
33634         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
33635       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
33636       consumes:
33637         - application/json
33638         - application/xml
33639       produces:
33640         - application/json
33641         - application/xml
33642       responses:
33643         "default":
33644           description: Response codes found in [response codes](https://wiki.onap.org/).
33645       parameters:
33646         - name: vnf-id
33647           in: path
33648           description: Unique id of VNF.  This is unique across the graph.
33649           required: true
33650           type: string
33651           example: __VNF-ID__
33652         - name: interface-name
33653           in: path
33654           description: Name that identifies the link aggregate interface
33655           required: true
33656           type: string
33657           example: __INTERFACE-NAME__
33658         - name: interface-name
33659           in: path
33660           description: Name given to the interface
33661           required: true
33662           type: string
33663           example: __INTERFACE-NAME__
33664         - name: vlan-interface
33665           in: path
33666           description: String that identifies the interface
33667           required: true
33668           type: string
33669           example: __VLAN-INTERFACE__
33670         - name: l3-interface-ipv4-address
33671           in: path
33672           description: IP address
33673           required: true
33674           type: string
33675           example: __L3-INTERFACE-IPV4-ADDRESS__
33676         - name: body
33677           in: body
33678           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
33679           required: true
33680           schema:
33681             $ref: "#/definitions/l3-interface-ipv4-address-list"
33682     patch:
33683       tags:
33684         - Network
33685       summary: update an existing l3-interface-ipv4-address-list
33686       description: |
33687         Update an existing l3-interface-ipv4-address-list
33688         #
33689         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33690         The PUT operation will entirely replace an existing object.
33691         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
33692         #
33693         Other differences between PUT and PATCH are:
33694         #
33695         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
33696         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33697         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33698       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
33699       consumes:
33700         - application/json
33701         - application/xml
33702       produces:
33703         - application/json
33704         - application/xml
33705       responses:
33706         "default":
33707           description: Response codes found in [response codes](https://wiki.onap.org/).
33708       parameters:
33709         - name: vnf-id
33710           in: path
33711           description: Unique id of VNF.  This is unique across the graph.
33712           required: true
33713           type: string
33714           example: __VNF-ID__
33715         - name: interface-name
33716           in: path
33717           description: Name that identifies the link aggregate interface
33718           required: true
33719           type: string
33720           example: __INTERFACE-NAME__
33721         - name: interface-name
33722           in: path
33723           description: Name given to the interface
33724           required: true
33725           type: string
33726           example: __INTERFACE-NAME__
33727         - name: vlan-interface
33728           in: path
33729           description: String that identifies the interface
33730           required: true
33731           type: string
33732           example: __VLAN-INTERFACE__
33733         - name: l3-interface-ipv4-address
33734           in: path
33735           description: IP address
33736           required: true
33737           type: string
33738           example: __L3-INTERFACE-IPV4-ADDRESS__
33739         - name: body
33740           in: body
33741           description: l3-interface-ipv4-address-list object that needs to be created or updated.
33742           required: true
33743           schema:
33744             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
33745     delete:
33746       tags:
33747         - Network
33748       summary: delete an existing l3-interface-ipv4-address-list
33749       description: delete an existing l3-interface-ipv4-address-list
33750       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
33751       consumes:
33752         - application/json
33753         - application/xml
33754       produces:
33755         - application/json
33756         - application/xml
33757       responses:
33758         "default":
33759           description: Response codes found in [response codes](https://wiki.onap.org/).
33760       parameters:
33761         - name: vnf-id
33762           in: path
33763           description: Unique id of VNF.  This is unique across the graph.
33764           required: true
33765           type: string
33766           example: __VNF-ID__
33767         - name: interface-name
33768           in: path
33769           description: Name that identifies the link aggregate interface
33770           required: true
33771           type: string
33772           example: __INTERFACE-NAME__
33773         - name: interface-name
33774           in: path
33775           description: Name given to the interface
33776           required: true
33777           type: string
33778           example: __INTERFACE-NAME__
33779         - name: vlan-interface
33780           in: path
33781           description: String that identifies the interface
33782           required: true
33783           type: string
33784           example: __VLAN-INTERFACE__
33785         - name: l3-interface-ipv4-address
33786           in: path
33787           description: IP address
33788           required: true
33789           type: string
33790           example: __L3-INTERFACE-IPV4-ADDRESS__
33791         - name: resource-version
33792           in: query
33793           description: resource-version for concurrency
33794           required: true
33795           type: string
33796   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
33797     put:
33798       tags:
33799         - Network
33800       summary: see node definition for valid relationships
33801       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
33802       consumes:
33803         - application/json
33804         - application/xml
33805       produces:
33806         - application/json
33807         - application/xml
33808       responses:
33809         "default":
33810           description: Response codes found in [response codes](https://wiki.onap.org/).
33811       parameters:
33812         - name: vnf-id
33813           in: path
33814           description: Unique id of VNF.  This is unique across the graph.
33815           required: true
33816           type: string
33817           example: __VNF-ID__
33818         - name: interface-name
33819           in: path
33820           description: Name that identifies the link aggregate interface
33821           required: true
33822           type: string
33823           example: __INTERFACE-NAME__
33824         - name: interface-name
33825           in: path
33826           description: Name given to the interface
33827           required: true
33828           type: string
33829           example: __INTERFACE-NAME__
33830         - name: vlan-interface
33831           in: path
33832           description: String that identifies the interface
33833           required: true
33834           type: string
33835           example: __VLAN-INTERFACE__
33836         - name: l3-interface-ipv6-address
33837           in: path
33838           description: IP address
33839           required: true
33840           type: string
33841           example: __L3-INTERFACE-IPV6-ADDRESS__
33842         - name: body
33843           in: body
33844           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
33845           required: true
33846           schema:
33847             $ref: "#/definitions/relationship"
33848     delete:
33849       tags:
33850         - Network
33851       summary: delete an existing relationship
33852       description: delete an existing relationship
33853       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
33854       consumes:
33855         - application/json
33856         - application/xml
33857       produces:
33858         - application/json
33859         - application/xml
33860       responses:
33861         "default":
33862           description: Response codes found in [response codes](https://wiki.onap.org/).
33863       parameters:
33864         - name: vnf-id
33865           in: path
33866           description: Unique id of VNF.  This is unique across the graph.
33867           required: true
33868           type: string
33869           example: __VNF-ID__
33870         - name: interface-name
33871           in: path
33872           description: Name that identifies the link aggregate interface
33873           required: true
33874           type: string
33875           example: __INTERFACE-NAME__
33876         - name: interface-name
33877           in: path
33878           description: Name given to the interface
33879           required: true
33880           type: string
33881           example: __INTERFACE-NAME__
33882         - name: vlan-interface
33883           in: path
33884           description: String that identifies the interface
33885           required: true
33886           type: string
33887           example: __VLAN-INTERFACE__
33888         - name: l3-interface-ipv6-address
33889           in: path
33890           description: IP address
33891           required: true
33892           type: string
33893           example: __L3-INTERFACE-IPV6-ADDRESS__
33894   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
33895     get:
33896       tags:
33897         - Network
33898       summary: returns l3-interface-ipv6-address-list
33899       description: returns l3-interface-ipv6-address-list
33900       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
33901       produces:
33902         - application/json
33903         - application/xml
33904       responses:
33905         "200":
33906           description: successful operation
33907           schema:
33908               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
33909         "default":
33910           description: Response codes found in [response codes](https://wiki.onap.org/).
33911       parameters:
33912         - name: vnf-id
33913           in: path
33914           description: Unique id of VNF.  This is unique across the graph.
33915           required: true
33916           type: string
33917           example: __VNF-ID__
33918         - name: interface-name
33919           in: path
33920           description: Name that identifies the link aggregate interface
33921           required: true
33922           type: string
33923           example: __INTERFACE-NAME__
33924         - name: interface-name
33925           in: path
33926           description: Name given to the interface
33927           required: true
33928           type: string
33929           example: __INTERFACE-NAME__
33930         - name: vlan-interface
33931           in: path
33932           description: String that identifies the interface
33933           required: true
33934           type: string
33935           example: __VLAN-INTERFACE__
33936         - name: l3-interface-ipv6-address
33937           in: path
33938           description: IP address
33939           required: true
33940           type: string
33941           example: __L3-INTERFACE-IPV6-ADDRESS__
33942         - name: vnf-name
33943           in: query
33944           description: Name of VNF.
33945           required: false
33946           type: string
33947         - name: vnf-name2
33948           in: query
33949           description: Alternate name of VNF.
33950           required: false
33951           type: string
33952         - name: vnf-type
33953           in: query
33954           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
33955           required: false
33956           type: string
33957         - name: service-id
33958           in: query
33959           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
33960           required: false
33961           type: string
33962         - name: regional-resource-zone
33963           in: query
33964           description: Regional way of organizing pservers, source of truth should define values
33965           required: false
33966           type: string
33967         - name: prov-status
33968           in: query
33969           description: Trigger for operational monitoring of this resource by Service Assurance systems.
33970           required: false
33971           type: string
33972         - name: heat-stack-id
33973           in: query
33974           description: Heat stack id corresponding to this instance, managed by MSO
33975           required: false
33976           type: string
33977         - name: in-maint
33978           in: query
33979           required: false
33980           type: boolean
33981         - name: is-closed-loop-disabled
33982           in: query
33983           required: false
33984           type: boolean
33985         - name: persona-model-id
33986           in: query
33987           description: the ASDC model id for this resource or service model.
33988           required: false
33989           type: string
33990         - name: persona-model-version
33991           in: query
33992           description: the ASDC model version for this resource or service model.
33993           required: false
33994           type: string
33995         - name: widget-model-id
33996           in: query
33997           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
33998           required: false
33999           type: string
34000         - name: widget-model-version
34001           in: query
34002           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
34003           required: false
34004           type: string
34005         - name: interface-id
34006           in: query
34007           description: ID of interface
34008           required: false
34009           type: string
34010         - name: interface-role
34011           in: query
34012           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
34013           required: false
34014           type: string
34015         - name: interface-id
34016           in: query
34017           description: ID of interface
34018           required: false
34019           type: string
34020         - name: macaddr
34021           in: query
34022           description: MAC address for the interface
34023           required: false
34024           type: string
34025         - name: network-name
34026           in: query
34027           description: Name of the network
34028           required: false
34029           type: string
34030         - name: vlan-id-inner
34031           in: query
34032           description: Inner VLAN tag
34033           required: false
34034           type: integer
34035           format: int64
34036         - name: vpn-id
34037           in: query
34038           description: This indicates the customers VPN ID associated with this vlan
34039           required: false
34040           type: string
34041         - name: vlan-id-inner
34042           in: query
34043           description: Inner VLAN tag
34044           required: false
34045           type: integer
34046           format: int64
34047         - name: neutron-network-id
34048           in: query
34049           description: Neutron network id of the interface that address belongs to
34050           required: false
34051           type: string
34052         - name: neutron-subnet-id
34053           in: query
34054           description: Neutron id of subnet that address belongs to
34055           required: false
34056           type: string
34057     put:
34058       tags:
34059         - Network
34060       summary: create or update an existing l3-interface-ipv6-address-list
34061       description: |
34062         Create or update an existing l3-interface-ipv6-address-list.
34063         #
34064         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
34065       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
34066       consumes:
34067         - application/json
34068         - application/xml
34069       produces:
34070         - application/json
34071         - application/xml
34072       responses:
34073         "default":
34074           description: Response codes found in [response codes](https://wiki.onap.org/).
34075       parameters:
34076         - name: vnf-id
34077           in: path
34078           description: Unique id of VNF.  This is unique across the graph.
34079           required: true
34080           type: string
34081           example: __VNF-ID__
34082         - name: interface-name
34083           in: path
34084           description: Name that identifies the link aggregate interface
34085           required: true
34086           type: string
34087           example: __INTERFACE-NAME__
34088         - name: interface-name
34089           in: path
34090           description: Name given to the interface
34091           required: true
34092           type: string
34093           example: __INTERFACE-NAME__
34094         - name: vlan-interface
34095           in: path
34096           description: String that identifies the interface
34097           required: true
34098           type: string
34099           example: __VLAN-INTERFACE__
34100         - name: l3-interface-ipv6-address
34101           in: path
34102           description: IP address
34103           required: true
34104           type: string
34105           example: __L3-INTERFACE-IPV6-ADDRESS__
34106         - name: body
34107           in: body
34108           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
34109           required: true
34110           schema:
34111             $ref: "#/definitions/l3-interface-ipv6-address-list"
34112     patch:
34113       tags:
34114         - Network
34115       summary: update an existing l3-interface-ipv6-address-list
34116       description: |
34117         Update an existing l3-interface-ipv6-address-list
34118         #
34119         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34120         The PUT operation will entirely replace an existing object.
34121         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
34122         #
34123         Other differences between PUT and PATCH are:
34124         #
34125         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
34126         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34127         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34128       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
34129       consumes:
34130         - application/json
34131         - application/xml
34132       produces:
34133         - application/json
34134         - application/xml
34135       responses:
34136         "default":
34137           description: Response codes found in [response codes](https://wiki.onap.org/).
34138       parameters:
34139         - name: vnf-id
34140           in: path
34141           description: Unique id of VNF.  This is unique across the graph.
34142           required: true
34143           type: string
34144           example: __VNF-ID__
34145         - name: interface-name
34146           in: path
34147           description: Name that identifies the link aggregate interface
34148           required: true
34149           type: string
34150           example: __INTERFACE-NAME__
34151         - name: interface-name
34152           in: path
34153           description: Name given to the interface
34154           required: true
34155           type: string
34156           example: __INTERFACE-NAME__
34157         - name: vlan-interface
34158           in: path
34159           description: String that identifies the interface
34160           required: true
34161           type: string
34162           example: __VLAN-INTERFACE__
34163         - name: l3-interface-ipv6-address
34164           in: path
34165           description: IP address
34166           required: true
34167           type: string
34168           example: __L3-INTERFACE-IPV6-ADDRESS__
34169         - name: body
34170           in: body
34171           description: l3-interface-ipv6-address-list object that needs to be created or updated.
34172           required: true
34173           schema:
34174             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
34175     delete:
34176       tags:
34177         - Network
34178       summary: delete an existing l3-interface-ipv6-address-list
34179       description: delete an existing l3-interface-ipv6-address-list
34180       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
34181       consumes:
34182         - application/json
34183         - application/xml
34184       produces:
34185         - application/json
34186         - application/xml
34187       responses:
34188         "default":
34189           description: Response codes found in [response codes](https://wiki.onap.org/).
34190       parameters:
34191         - name: vnf-id
34192           in: path
34193           description: Unique id of VNF.  This is unique across the graph.
34194           required: true
34195           type: string
34196           example: __VNF-ID__
34197         - name: interface-name
34198           in: path
34199           description: Name that identifies the link aggregate interface
34200           required: true
34201           type: string
34202           example: __INTERFACE-NAME__
34203         - name: interface-name
34204           in: path
34205           description: Name given to the interface
34206           required: true
34207           type: string
34208           example: __INTERFACE-NAME__
34209         - name: vlan-interface
34210           in: path
34211           description: String that identifies the interface
34212           required: true
34213           type: string
34214           example: __VLAN-INTERFACE__
34215         - name: l3-interface-ipv6-address
34216           in: path
34217           description: IP address
34218           required: true
34219           type: string
34220           example: __L3-INTERFACE-IPV6-ADDRESS__
34221         - name: resource-version
34222           in: query
34223           description: resource-version for concurrency
34224           required: true
34225           type: string
34226   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
34227     get:
34228       tags:
34229         - Network
34230       summary: returns vlan
34231       description: returns vlan
34232       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
34233       produces:
34234         - application/json
34235         - application/xml
34236       responses:
34237         "200":
34238           description: successful operation
34239           schema:
34240               $ref: "#/getDefinitions/vlan"
34241         "default":
34242           description: Response codes found in [response codes](https://wiki.onap.org/).
34243       parameters:
34244         - name: vnf-id
34245           in: path
34246           description: Unique id of VNF.  This is unique across the graph.
34247           required: true
34248           type: string
34249           example: __VNF-ID__
34250         - name: interface-name
34251           in: path
34252           description: Name that identifies the link aggregate interface
34253           required: true
34254           type: string
34255           example: __INTERFACE-NAME__
34256         - name: interface-name
34257           in: path
34258           description: Name given to the interface
34259           required: true
34260           type: string
34261           example: __INTERFACE-NAME__
34262         - name: vlan-interface
34263           in: path
34264           description: String that identifies the interface
34265           required: true
34266           type: string
34267           example: __VLAN-INTERFACE__
34268         - name: vnf-name
34269           in: query
34270           description: Name of VNF.
34271           required: false
34272           type: string
34273         - name: vnf-name2
34274           in: query
34275           description: Alternate name of VNF.
34276           required: false
34277           type: string
34278         - name: vnf-type
34279           in: query
34280           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
34281           required: false
34282           type: string
34283         - name: service-id
34284           in: query
34285           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
34286           required: false
34287           type: string
34288         - name: regional-resource-zone
34289           in: query
34290           description: Regional way of organizing pservers, source of truth should define values
34291           required: false
34292           type: string
34293         - name: prov-status
34294           in: query
34295           description: Trigger for operational monitoring of this resource by Service Assurance systems.
34296           required: false
34297           type: string
34298         - name: heat-stack-id
34299           in: query
34300           description: Heat stack id corresponding to this instance, managed by MSO
34301           required: false
34302           type: string
34303         - name: in-maint
34304           in: query
34305           required: false
34306           type: boolean
34307         - name: is-closed-loop-disabled
34308           in: query
34309           required: false
34310           type: boolean
34311         - name: persona-model-id
34312           in: query
34313           description: the ASDC model id for this resource or service model.
34314           required: false
34315           type: string
34316         - name: persona-model-version
34317           in: query
34318           description: the ASDC model version for this resource or service model.
34319           required: false
34320           type: string
34321         - name: widget-model-id
34322           in: query
34323           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
34324           required: false
34325           type: string
34326         - name: widget-model-version
34327           in: query
34328           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
34329           required: false
34330           type: string
34331         - name: interface-id
34332           in: query
34333           description: ID of interface
34334           required: false
34335           type: string
34336         - name: interface-role
34337           in: query
34338           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
34339           required: false
34340           type: string
34341         - name: interface-id
34342           in: query
34343           description: ID of interface
34344           required: false
34345           type: string
34346         - name: macaddr
34347           in: query
34348           description: MAC address for the interface
34349           required: false
34350           type: string
34351         - name: network-name
34352           in: query
34353           description: Name of the network
34354           required: false
34355           type: string
34356         - name: vlan-id-inner
34357           in: query
34358           description: Inner VLAN tag
34359           required: false
34360           type: integer
34361           format: int64
34362         - name: vpn-id
34363           in: query
34364           description: This indicates the customers VPN ID associated with this vlan
34365           required: false
34366           type: string
34367     put:
34368       tags:
34369         - Network
34370       summary: create or update an existing vlan
34371       description: |
34372         Create or update an existing vlan.
34373         #
34374         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
34375       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
34376       consumes:
34377         - application/json
34378         - application/xml
34379       produces:
34380         - application/json
34381         - application/xml
34382       responses:
34383         "default":
34384           description: Response codes found in [response codes](https://wiki.onap.org/).
34385       parameters:
34386         - name: vnf-id
34387           in: path
34388           description: Unique id of VNF.  This is unique across the graph.
34389           required: true
34390           type: string
34391           example: __VNF-ID__
34392         - name: interface-name
34393           in: path
34394           description: Name that identifies the link aggregate interface
34395           required: true
34396           type: string
34397           example: __INTERFACE-NAME__
34398         - name: interface-name
34399           in: path
34400           description: Name given to the interface
34401           required: true
34402           type: string
34403           example: __INTERFACE-NAME__
34404         - name: vlan-interface
34405           in: path
34406           description: String that identifies the interface
34407           required: true
34408           type: string
34409           example: __VLAN-INTERFACE__
34410         - name: body
34411           in: body
34412           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
34413           required: true
34414           schema:
34415             $ref: "#/definitions/vlan"
34416     patch:
34417       tags:
34418         - Network
34419       summary: update an existing vlan
34420       description: |
34421         Update an existing vlan
34422         #
34423         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34424         The PUT operation will entirely replace an existing object.
34425         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
34426         #
34427         Other differences between PUT and PATCH are:
34428         #
34429         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
34430         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34431         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34432       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
34433       consumes:
34434         - application/json
34435         - application/xml
34436       produces:
34437         - application/json
34438         - application/xml
34439       responses:
34440         "default":
34441           description: Response codes found in [response codes](https://wiki.onap.org/).
34442       parameters:
34443         - name: vnf-id
34444           in: path
34445           description: Unique id of VNF.  This is unique across the graph.
34446           required: true
34447           type: string
34448           example: __VNF-ID__
34449         - name: interface-name
34450           in: path
34451           description: Name that identifies the link aggregate interface
34452           required: true
34453           type: string
34454           example: __INTERFACE-NAME__
34455         - name: interface-name
34456           in: path
34457           description: Name given to the interface
34458           required: true
34459           type: string
34460           example: __INTERFACE-NAME__
34461         - name: vlan-interface
34462           in: path
34463           description: String that identifies the interface
34464           required: true
34465           type: string
34466           example: __VLAN-INTERFACE__
34467         - name: body
34468           in: body
34469           description: vlan object that needs to be created or updated.
34470           required: true
34471           schema:
34472             $ref: "#/patchDefinitions/vlan"
34473     delete:
34474       tags:
34475         - Network
34476       summary: delete an existing vlan
34477       description: delete an existing vlan
34478       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
34479       consumes:
34480         - application/json
34481         - application/xml
34482       produces:
34483         - application/json
34484         - application/xml
34485       responses:
34486         "default":
34487           description: Response codes found in [response codes](https://wiki.onap.org/).
34488       parameters:
34489         - name: vnf-id
34490           in: path
34491           description: Unique id of VNF.  This is unique across the graph.
34492           required: true
34493           type: string
34494           example: __VNF-ID__
34495         - name: interface-name
34496           in: path
34497           description: Name that identifies the link aggregate interface
34498           required: true
34499           type: string
34500           example: __INTERFACE-NAME__
34501         - name: interface-name
34502           in: path
34503           description: Name given to the interface
34504           required: true
34505           type: string
34506           example: __INTERFACE-NAME__
34507         - name: vlan-interface
34508           in: path
34509           description: String that identifies the interface
34510           required: true
34511           type: string
34512           example: __VLAN-INTERFACE__
34513         - name: resource-version
34514           in: query
34515           description: resource-version for concurrency
34516           required: true
34517           type: string
34518   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
34519     get:
34520       tags:
34521         - Network
34522       summary: returns vlans
34523       description: returns vlans
34524       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
34525       produces:
34526         - application/json
34527         - application/xml
34528       responses:
34529         "200":
34530           description: successful operation
34531           schema:
34532               $ref: "#/getDefinitions/vlans"
34533         "default":
34534           description: Response codes found in [response codes](https://wiki.onap.org/).
34535       parameters:
34536         - name: vnf-id
34537           in: path
34538           description: Unique id of VNF.  This is unique across the graph.
34539           required: true
34540           type: string
34541           example: __VNF-ID__
34542         - name: interface-name
34543           in: path
34544           description: Name that identifies the link aggregate interface
34545           required: true
34546           type: string
34547           example: __INTERFACE-NAME__
34548         - name: interface-name
34549           in: path
34550           description: Name given to the interface
34551           required: true
34552           type: string
34553           example: __INTERFACE-NAME__
34554         - name: vnf-name
34555           in: query
34556           description: Name of VNF.
34557           required: false
34558           type: string
34559         - name: vnf-name2
34560           in: query
34561           description: Alternate name of VNF.
34562           required: false
34563           type: string
34564         - name: vnf-type
34565           in: query
34566           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
34567           required: false
34568           type: string
34569         - name: service-id
34570           in: query
34571           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
34572           required: false
34573           type: string
34574         - name: regional-resource-zone
34575           in: query
34576           description: Regional way of organizing pservers, source of truth should define values
34577           required: false
34578           type: string
34579         - name: prov-status
34580           in: query
34581           description: Trigger for operational monitoring of this resource by Service Assurance systems.
34582           required: false
34583           type: string
34584         - name: heat-stack-id
34585           in: query
34586           description: Heat stack id corresponding to this instance, managed by MSO
34587           required: false
34588           type: string
34589         - name: in-maint
34590           in: query
34591           required: false
34592           type: boolean
34593         - name: is-closed-loop-disabled
34594           in: query
34595           required: false
34596           type: boolean
34597         - name: persona-model-id
34598           in: query
34599           description: the ASDC model id for this resource or service model.
34600           required: false
34601           type: string
34602         - name: persona-model-version
34603           in: query
34604           description: the ASDC model version for this resource or service model.
34605           required: false
34606           type: string
34607         - name: widget-model-id
34608           in: query
34609           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
34610           required: false
34611           type: string
34612         - name: widget-model-version
34613           in: query
34614           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
34615           required: false
34616           type: string
34617         - name: interface-id
34618           in: query
34619           description: ID of interface
34620           required: false
34621           type: string
34622         - name: interface-role
34623           in: query
34624           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
34625           required: false
34626           type: string
34627         - name: interface-id
34628           in: query
34629           description: ID of interface
34630           required: false
34631           type: string
34632         - name: macaddr
34633           in: query
34634           description: MAC address for the interface
34635           required: false
34636           type: string
34637         - name: network-name
34638           in: query
34639           description: Name of the network
34640           required: false
34641           type: string
34642   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
34643     put:
34644       tags:
34645         - Network
34646       summary: see node definition for valid relationships
34647       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
34648       consumes:
34649         - application/json
34650         - application/xml
34651       produces:
34652         - application/json
34653         - application/xml
34654       responses:
34655         "default":
34656           description: Response codes found in [response codes](https://wiki.onap.org/).
34657       parameters:
34658         - name: vnf-id
34659           in: path
34660           description: Unique id of VNF.  This is unique across the graph.
34661           required: true
34662           type: string
34663           example: __VNF-ID__
34664         - name: interface-name
34665           in: path
34666           description: Name that identifies the link aggregate interface
34667           required: true
34668           type: string
34669           example: __INTERFACE-NAME__
34670         - name: interface-name
34671           in: path
34672           description: Name given to the interface
34673           required: true
34674           type: string
34675           example: __INTERFACE-NAME__
34676         - name: pci-id
34677           in: path
34678           description: PCI ID used to identify the sriov-vf
34679           required: true
34680           type: string
34681           example: __PCI-ID__
34682         - name: body
34683           in: body
34684           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
34685           required: true
34686           schema:
34687             $ref: "#/definitions/relationship"
34688     delete:
34689       tags:
34690         - Network
34691       summary: delete an existing relationship
34692       description: delete an existing relationship
34693       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
34694       consumes:
34695         - application/json
34696         - application/xml
34697       produces:
34698         - application/json
34699         - application/xml
34700       responses:
34701         "default":
34702           description: Response codes found in [response codes](https://wiki.onap.org/).
34703       parameters:
34704         - name: vnf-id
34705           in: path
34706           description: Unique id of VNF.  This is unique across the graph.
34707           required: true
34708           type: string
34709           example: __VNF-ID__
34710         - name: interface-name
34711           in: path
34712           description: Name that identifies the link aggregate interface
34713           required: true
34714           type: string
34715           example: __INTERFACE-NAME__
34716         - name: interface-name
34717           in: path
34718           description: Name given to the interface
34719           required: true
34720           type: string
34721           example: __INTERFACE-NAME__
34722         - name: pci-id
34723           in: path
34724           description: PCI ID used to identify the sriov-vf
34725           required: true
34726           type: string
34727           example: __PCI-ID__
34728   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
34729     get:
34730       tags:
34731         - Network
34732       summary: returns sriov-vf
34733       description: returns sriov-vf
34734       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
34735       produces:
34736         - application/json
34737         - application/xml
34738       responses:
34739         "200":
34740           description: successful operation
34741           schema:
34742               $ref: "#/getDefinitions/sriov-vf"
34743         "default":
34744           description: Response codes found in [response codes](https://wiki.onap.org/).
34745       parameters:
34746         - name: vnf-id
34747           in: path
34748           description: Unique id of VNF.  This is unique across the graph.
34749           required: true
34750           type: string
34751           example: __VNF-ID__
34752         - name: interface-name
34753           in: path
34754           description: Name that identifies the link aggregate interface
34755           required: true
34756           type: string
34757           example: __INTERFACE-NAME__
34758         - name: interface-name
34759           in: path
34760           description: Name given to the interface
34761           required: true
34762           type: string
34763           example: __INTERFACE-NAME__
34764         - name: pci-id
34765           in: path
34766           description: PCI ID used to identify the sriov-vf
34767           required: true
34768           type: string
34769           example: __PCI-ID__
34770         - name: vnf-name
34771           in: query
34772           description: Name of VNF.
34773           required: false
34774           type: string
34775         - name: vnf-name2
34776           in: query
34777           description: Alternate name of VNF.
34778           required: false
34779           type: string
34780         - name: vnf-type
34781           in: query
34782           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
34783           required: false
34784           type: string
34785         - name: service-id
34786           in: query
34787           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
34788           required: false
34789           type: string
34790         - name: regional-resource-zone
34791           in: query
34792           description: Regional way of organizing pservers, source of truth should define values
34793           required: false
34794           type: string
34795         - name: prov-status
34796           in: query
34797           description: Trigger for operational monitoring of this resource by Service Assurance systems.
34798           required: false
34799           type: string
34800         - name: heat-stack-id
34801           in: query
34802           description: Heat stack id corresponding to this instance, managed by MSO
34803           required: false
34804           type: string
34805         - name: in-maint
34806           in: query
34807           required: false
34808           type: boolean
34809         - name: is-closed-loop-disabled
34810           in: query
34811           required: false
34812           type: boolean
34813         - name: persona-model-id
34814           in: query
34815           description: the ASDC model id for this resource or service model.
34816           required: false
34817           type: string
34818         - name: persona-model-version
34819           in: query
34820           description: the ASDC model version for this resource or service model.
34821           required: false
34822           type: string
34823         - name: widget-model-id
34824           in: query
34825           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
34826           required: false
34827           type: string
34828         - name: widget-model-version
34829           in: query
34830           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
34831           required: false
34832           type: string
34833         - name: interface-id
34834           in: query
34835           description: ID of interface
34836           required: false
34837           type: string
34838         - name: interface-role
34839           in: query
34840           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
34841           required: false
34842           type: string
34843         - name: interface-id
34844           in: query
34845           description: ID of interface
34846           required: false
34847           type: string
34848         - name: macaddr
34849           in: query
34850           description: MAC address for the interface
34851           required: false
34852           type: string
34853         - name: network-name
34854           in: query
34855           description: Name of the network
34856           required: false
34857           type: string
34858         - name: vf-vlan-filter
34859           in: query
34860           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
34861           required: false
34862           type: string
34863         - name: vf-mac-filter
34864           in: query
34865           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
34866           required: false
34867           type: string
34868         - name: vf-vlan-strip
34869           in: query
34870           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
34871           required: false
34872           type: boolean
34873         - name: neutron-network-id
34874           in: query
34875           description: Neutron network id of the interface
34876           required: false
34877           type: string
34878     put:
34879       tags:
34880         - Network
34881       summary: create or update an existing sriov-vf
34882       description: |
34883         Create or update an existing sriov-vf.
34884         #
34885         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
34886       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
34887       consumes:
34888         - application/json
34889         - application/xml
34890       produces:
34891         - application/json
34892         - application/xml
34893       responses:
34894         "default":
34895           description: Response codes found in [response codes](https://wiki.onap.org/).
34896       parameters:
34897         - name: vnf-id
34898           in: path
34899           description: Unique id of VNF.  This is unique across the graph.
34900           required: true
34901           type: string
34902           example: __VNF-ID__
34903         - name: interface-name
34904           in: path
34905           description: Name that identifies the link aggregate interface
34906           required: true
34907           type: string
34908           example: __INTERFACE-NAME__
34909         - name: interface-name
34910           in: path
34911           description: Name given to the interface
34912           required: true
34913           type: string
34914           example: __INTERFACE-NAME__
34915         - name: pci-id
34916           in: path
34917           description: PCI ID used to identify the sriov-vf
34918           required: true
34919           type: string
34920           example: __PCI-ID__
34921         - name: body
34922           in: body
34923           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
34924           required: true
34925           schema:
34926             $ref: "#/definitions/sriov-vf"
34927     patch:
34928       tags:
34929         - Network
34930       summary: update an existing sriov-vf
34931       description: |
34932         Update an existing sriov-vf
34933         #
34934         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34935         The PUT operation will entirely replace an existing object.
34936         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
34937         #
34938         Other differences between PUT and PATCH are:
34939         #
34940         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
34941         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34942         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34943       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
34944       consumes:
34945         - application/json
34946         - application/xml
34947       produces:
34948         - application/json
34949         - application/xml
34950       responses:
34951         "default":
34952           description: Response codes found in [response codes](https://wiki.onap.org/).
34953       parameters:
34954         - name: vnf-id
34955           in: path
34956           description: Unique id of VNF.  This is unique across the graph.
34957           required: true
34958           type: string
34959           example: __VNF-ID__
34960         - name: interface-name
34961           in: path
34962           description: Name that identifies the link aggregate interface
34963           required: true
34964           type: string
34965           example: __INTERFACE-NAME__
34966         - name: interface-name
34967           in: path
34968           description: Name given to the interface
34969           required: true
34970           type: string
34971           example: __INTERFACE-NAME__
34972         - name: pci-id
34973           in: path
34974           description: PCI ID used to identify the sriov-vf
34975           required: true
34976           type: string
34977           example: __PCI-ID__
34978         - name: body
34979           in: body
34980           description: sriov-vf object that needs to be created or updated.
34981           required: true
34982           schema:
34983             $ref: "#/patchDefinitions/sriov-vf"
34984     delete:
34985       tags:
34986         - Network
34987       summary: delete an existing sriov-vf
34988       description: delete an existing sriov-vf
34989       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
34990       consumes:
34991         - application/json
34992         - application/xml
34993       produces:
34994         - application/json
34995         - application/xml
34996       responses:
34997         "default":
34998           description: Response codes found in [response codes](https://wiki.onap.org/).
34999       parameters:
35000         - name: vnf-id
35001           in: path
35002           description: Unique id of VNF.  This is unique across the graph.
35003           required: true
35004           type: string
35005           example: __VNF-ID__
35006         - name: interface-name
35007           in: path
35008           description: Name that identifies the link aggregate interface
35009           required: true
35010           type: string
35011           example: __INTERFACE-NAME__
35012         - name: interface-name
35013           in: path
35014           description: Name given to the interface
35015           required: true
35016           type: string
35017           example: __INTERFACE-NAME__
35018         - name: pci-id
35019           in: path
35020           description: PCI ID used to identify the sriov-vf
35021           required: true
35022           type: string
35023           example: __PCI-ID__
35024         - name: resource-version
35025           in: query
35026           description: resource-version for concurrency
35027           required: true
35028           type: string
35029   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
35030     get:
35031       tags:
35032         - Network
35033       summary: returns sriov-vfs
35034       description: returns sriov-vfs
35035       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
35036       produces:
35037         - application/json
35038         - application/xml
35039       responses:
35040         "200":
35041           description: successful operation
35042           schema:
35043               $ref: "#/getDefinitions/sriov-vfs"
35044         "default":
35045           description: Response codes found in [response codes](https://wiki.onap.org/).
35046       parameters:
35047         - name: vnf-id
35048           in: path
35049           description: Unique id of VNF.  This is unique across the graph.
35050           required: true
35051           type: string
35052           example: __VNF-ID__
35053         - name: interface-name
35054           in: path
35055           description: Name that identifies the link aggregate interface
35056           required: true
35057           type: string
35058           example: __INTERFACE-NAME__
35059         - name: interface-name
35060           in: path
35061           description: Name given to the interface
35062           required: true
35063           type: string
35064           example: __INTERFACE-NAME__
35065         - name: vnf-name
35066           in: query
35067           description: Name of VNF.
35068           required: false
35069           type: string
35070         - name: vnf-name2
35071           in: query
35072           description: Alternate name of VNF.
35073           required: false
35074           type: string
35075         - name: vnf-type
35076           in: query
35077           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
35078           required: false
35079           type: string
35080         - name: service-id
35081           in: query
35082           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
35083           required: false
35084           type: string
35085         - name: regional-resource-zone
35086           in: query
35087           description: Regional way of organizing pservers, source of truth should define values
35088           required: false
35089           type: string
35090         - name: prov-status
35091           in: query
35092           description: Trigger for operational monitoring of this resource by Service Assurance systems.
35093           required: false
35094           type: string
35095         - name: heat-stack-id
35096           in: query
35097           description: Heat stack id corresponding to this instance, managed by MSO
35098           required: false
35099           type: string
35100         - name: in-maint
35101           in: query
35102           required: false
35103           type: boolean
35104         - name: is-closed-loop-disabled
35105           in: query
35106           required: false
35107           type: boolean
35108         - name: persona-model-id
35109           in: query
35110           description: the ASDC model id for this resource or service model.
35111           required: false
35112           type: string
35113         - name: persona-model-version
35114           in: query
35115           description: the ASDC model version for this resource or service model.
35116           required: false
35117           type: string
35118         - name: widget-model-id
35119           in: query
35120           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
35121           required: false
35122           type: string
35123         - name: widget-model-version
35124           in: query
35125           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
35126           required: false
35127           type: string
35128         - name: interface-id
35129           in: query
35130           description: ID of interface
35131           required: false
35132           type: string
35133         - name: interface-role
35134           in: query
35135           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
35136           required: false
35137           type: string
35138         - name: interface-id
35139           in: query
35140           description: ID of interface
35141           required: false
35142           type: string
35143         - name: macaddr
35144           in: query
35145           description: MAC address for the interface
35146           required: false
35147           type: string
35148         - name: network-name
35149           in: query
35150           description: Name of the network
35151           required: false
35152           type: string
35153   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
35154     put:
35155       tags:
35156         - Network
35157       summary: see node definition for valid relationships
35158       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
35159       consumes:
35160         - application/json
35161         - application/xml
35162       produces:
35163         - application/json
35164         - application/xml
35165       responses:
35166         "default":
35167           description: Response codes found in [response codes](https://wiki.onap.org/).
35168       parameters:
35169         - name: vnf-id
35170           in: path
35171           description: Unique id of VNF.  This is unique across the graph.
35172           required: true
35173           type: string
35174           example: __VNF-ID__
35175         - name: interface-name
35176           in: path
35177           description: Name that identifies the link aggregate interface
35178           required: true
35179           type: string
35180           example: __INTERFACE-NAME__
35181         - name: interface-name
35182           in: path
35183           description: Name given to the interface
35184           required: true
35185           type: string
35186           example: __INTERFACE-NAME__
35187         - name: body
35188           in: body
35189           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
35190           required: true
35191           schema:
35192             $ref: "#/definitions/relationship"
35193     delete:
35194       tags:
35195         - Network
35196       summary: delete an existing relationship
35197       description: delete an existing relationship
35198       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
35199       consumes:
35200         - application/json
35201         - application/xml
35202       produces:
35203         - application/json
35204         - application/xml
35205       responses:
35206         "default":
35207           description: Response codes found in [response codes](https://wiki.onap.org/).
35208       parameters:
35209         - name: vnf-id
35210           in: path
35211           description: Unique id of VNF.  This is unique across the graph.
35212           required: true
35213           type: string
35214           example: __VNF-ID__
35215         - name: interface-name
35216           in: path
35217           description: Name that identifies the link aggregate interface
35218           required: true
35219           type: string
35220           example: __INTERFACE-NAME__
35221         - name: interface-name
35222           in: path
35223           description: Name given to the interface
35224           required: true
35225           type: string
35226           example: __INTERFACE-NAME__
35227   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
35228     put:
35229       tags:
35230         - Network
35231       summary: see node definition for valid relationships
35232       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
35233       consumes:
35234         - application/json
35235         - application/xml
35236       produces:
35237         - application/json
35238         - application/xml
35239       responses:
35240         "default":
35241           description: Response codes found in [response codes](https://wiki.onap.org/).
35242       parameters:
35243         - name: vnf-id
35244           in: path
35245           description: Unique id of VNF.  This is unique across the graph.
35246           required: true
35247           type: string
35248           example: __VNF-ID__
35249         - name: interface-name
35250           in: path
35251           description: Name that identifies the link aggregate interface
35252           required: true
35253           type: string
35254           example: __INTERFACE-NAME__
35255         - name: interface-name
35256           in: path
35257           description: Name given to the interface
35258           required: true
35259           type: string
35260           example: __INTERFACE-NAME__
35261         - name: l3-interface-ipv4-address
35262           in: path
35263           description: IP address
35264           required: true
35265           type: string
35266           example: __L3-INTERFACE-IPV4-ADDRESS__
35267         - name: body
35268           in: body
35269           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
35270           required: true
35271           schema:
35272             $ref: "#/definitions/relationship"
35273     delete:
35274       tags:
35275         - Network
35276       summary: delete an existing relationship
35277       description: delete an existing relationship
35278       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
35279       consumes:
35280         - application/json
35281         - application/xml
35282       produces:
35283         - application/json
35284         - application/xml
35285       responses:
35286         "default":
35287           description: Response codes found in [response codes](https://wiki.onap.org/).
35288       parameters:
35289         - name: vnf-id
35290           in: path
35291           description: Unique id of VNF.  This is unique across the graph.
35292           required: true
35293           type: string
35294           example: __VNF-ID__
35295         - name: interface-name
35296           in: path
35297           description: Name that identifies the link aggregate interface
35298           required: true
35299           type: string
35300           example: __INTERFACE-NAME__
35301         - name: interface-name
35302           in: path
35303           description: Name given to the interface
35304           required: true
35305           type: string
35306           example: __INTERFACE-NAME__
35307         - name: l3-interface-ipv4-address
35308           in: path
35309           description: IP address
35310           required: true
35311           type: string
35312           example: __L3-INTERFACE-IPV4-ADDRESS__
35313   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
35314     get:
35315       tags:
35316         - Network
35317       summary: returns l3-interface-ipv4-address-list
35318       description: returns l3-interface-ipv4-address-list
35319       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
35320       produces:
35321         - application/json
35322         - application/xml
35323       responses:
35324         "200":
35325           description: successful operation
35326           schema:
35327               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
35328         "default":
35329           description: Response codes found in [response codes](https://wiki.onap.org/).
35330       parameters:
35331         - name: vnf-id
35332           in: path
35333           description: Unique id of VNF.  This is unique across the graph.
35334           required: true
35335           type: string
35336           example: __VNF-ID__
35337         - name: interface-name
35338           in: path
35339           description: Name that identifies the link aggregate interface
35340           required: true
35341           type: string
35342           example: __INTERFACE-NAME__
35343         - name: interface-name
35344           in: path
35345           description: Name given to the interface
35346           required: true
35347           type: string
35348           example: __INTERFACE-NAME__
35349         - name: l3-interface-ipv4-address
35350           in: path
35351           description: IP address
35352           required: true
35353           type: string
35354           example: __L3-INTERFACE-IPV4-ADDRESS__
35355         - name: vnf-name
35356           in: query
35357           description: Name of VNF.
35358           required: false
35359           type: string
35360         - name: vnf-name2
35361           in: query
35362           description: Alternate name of VNF.
35363           required: false
35364           type: string
35365         - name: vnf-type
35366           in: query
35367           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
35368           required: false
35369           type: string
35370         - name: service-id
35371           in: query
35372           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
35373           required: false
35374           type: string
35375         - name: regional-resource-zone
35376           in: query
35377           description: Regional way of organizing pservers, source of truth should define values
35378           required: false
35379           type: string
35380         - name: prov-status
35381           in: query
35382           description: Trigger for operational monitoring of this resource by Service Assurance systems.
35383           required: false
35384           type: string
35385         - name: heat-stack-id
35386           in: query
35387           description: Heat stack id corresponding to this instance, managed by MSO
35388           required: false
35389           type: string
35390         - name: in-maint
35391           in: query
35392           required: false
35393           type: boolean
35394         - name: is-closed-loop-disabled
35395           in: query
35396           required: false
35397           type: boolean
35398         - name: persona-model-id
35399           in: query
35400           description: the ASDC model id for this resource or service model.
35401           required: false
35402           type: string
35403         - name: persona-model-version
35404           in: query
35405           description: the ASDC model version for this resource or service model.
35406           required: false
35407           type: string
35408         - name: widget-model-id
35409           in: query
35410           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
35411           required: false
35412           type: string
35413         - name: widget-model-version
35414           in: query
35415           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
35416           required: false
35417           type: string
35418         - name: interface-id
35419           in: query
35420           description: ID of interface
35421           required: false
35422           type: string
35423         - name: interface-role
35424           in: query
35425           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
35426           required: false
35427           type: string
35428         - name: interface-id
35429           in: query
35430           description: ID of interface
35431           required: false
35432           type: string
35433         - name: macaddr
35434           in: query
35435           description: MAC address for the interface
35436           required: false
35437           type: string
35438         - name: network-name
35439           in: query
35440           description: Name of the network
35441           required: false
35442           type: string
35443         - name: vlan-id-inner
35444           in: query
35445           description: Inner VLAN tag
35446           required: false
35447           type: integer
35448           format: int64
35449         - name: neutron-network-id
35450           in: query
35451           description: Neutron network id of the interface that address belongs to
35452           required: false
35453           type: string
35454         - name: neutron-subnet-id
35455           in: query
35456           description: Neutron id of subnet that address belongs to
35457           required: false
35458           type: string
35459     put:
35460       tags:
35461         - Network
35462       summary: create or update an existing l3-interface-ipv4-address-list
35463       description: |
35464         Create or update an existing l3-interface-ipv4-address-list.
35465         #
35466         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
35467       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
35468       consumes:
35469         - application/json
35470         - application/xml
35471       produces:
35472         - application/json
35473         - application/xml
35474       responses:
35475         "default":
35476           description: Response codes found in [response codes](https://wiki.onap.org/).
35477       parameters:
35478         - name: vnf-id
35479           in: path
35480           description: Unique id of VNF.  This is unique across the graph.
35481           required: true
35482           type: string
35483           example: __VNF-ID__
35484         - name: interface-name
35485           in: path
35486           description: Name that identifies the link aggregate interface
35487           required: true
35488           type: string
35489           example: __INTERFACE-NAME__
35490         - name: interface-name
35491           in: path
35492           description: Name given to the interface
35493           required: true
35494           type: string
35495           example: __INTERFACE-NAME__
35496         - name: l3-interface-ipv4-address
35497           in: path
35498           description: IP address
35499           required: true
35500           type: string
35501           example: __L3-INTERFACE-IPV4-ADDRESS__
35502         - name: body
35503           in: body
35504           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
35505           required: true
35506           schema:
35507             $ref: "#/definitions/l3-interface-ipv4-address-list"
35508     patch:
35509       tags:
35510         - Network
35511       summary: update an existing l3-interface-ipv4-address-list
35512       description: |
35513         Update an existing l3-interface-ipv4-address-list
35514         #
35515         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35516         The PUT operation will entirely replace an existing object.
35517         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
35518         #
35519         Other differences between PUT and PATCH are:
35520         #
35521         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
35522         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35523         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35524       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
35525       consumes:
35526         - application/json
35527         - application/xml
35528       produces:
35529         - application/json
35530         - application/xml
35531       responses:
35532         "default":
35533           description: Response codes found in [response codes](https://wiki.onap.org/).
35534       parameters:
35535         - name: vnf-id
35536           in: path
35537           description: Unique id of VNF.  This is unique across the graph.
35538           required: true
35539           type: string
35540           example: __VNF-ID__
35541         - name: interface-name
35542           in: path
35543           description: Name that identifies the link aggregate interface
35544           required: true
35545           type: string
35546           example: __INTERFACE-NAME__
35547         - name: interface-name
35548           in: path
35549           description: Name given to the interface
35550           required: true
35551           type: string
35552           example: __INTERFACE-NAME__
35553         - name: l3-interface-ipv4-address
35554           in: path
35555           description: IP address
35556           required: true
35557           type: string
35558           example: __L3-INTERFACE-IPV4-ADDRESS__
35559         - name: body
35560           in: body
35561           description: l3-interface-ipv4-address-list object that needs to be created or updated.
35562           required: true
35563           schema:
35564             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
35565     delete:
35566       tags:
35567         - Network
35568       summary: delete an existing l3-interface-ipv4-address-list
35569       description: delete an existing l3-interface-ipv4-address-list
35570       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
35571       consumes:
35572         - application/json
35573         - application/xml
35574       produces:
35575         - application/json
35576         - application/xml
35577       responses:
35578         "default":
35579           description: Response codes found in [response codes](https://wiki.onap.org/).
35580       parameters:
35581         - name: vnf-id
35582           in: path
35583           description: Unique id of VNF.  This is unique across the graph.
35584           required: true
35585           type: string
35586           example: __VNF-ID__
35587         - name: interface-name
35588           in: path
35589           description: Name that identifies the link aggregate interface
35590           required: true
35591           type: string
35592           example: __INTERFACE-NAME__
35593         - name: interface-name
35594           in: path
35595           description: Name given to the interface
35596           required: true
35597           type: string
35598           example: __INTERFACE-NAME__
35599         - name: l3-interface-ipv4-address
35600           in: path
35601           description: IP address
35602           required: true
35603           type: string
35604           example: __L3-INTERFACE-IPV4-ADDRESS__
35605         - name: resource-version
35606           in: query
35607           description: resource-version for concurrency
35608           required: true
35609           type: string
35610   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
35611     put:
35612       tags:
35613         - Network
35614       summary: see node definition for valid relationships
35615       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
35616       consumes:
35617         - application/json
35618         - application/xml
35619       produces:
35620         - application/json
35621         - application/xml
35622       responses:
35623         "default":
35624           description: Response codes found in [response codes](https://wiki.onap.org/).
35625       parameters:
35626         - name: vnf-id
35627           in: path
35628           description: Unique id of VNF.  This is unique across the graph.
35629           required: true
35630           type: string
35631           example: __VNF-ID__
35632         - name: interface-name
35633           in: path
35634           description: Name that identifies the link aggregate interface
35635           required: true
35636           type: string
35637           example: __INTERFACE-NAME__
35638         - name: interface-name
35639           in: path
35640           description: Name given to the interface
35641           required: true
35642           type: string
35643           example: __INTERFACE-NAME__
35644         - name: l3-interface-ipv6-address
35645           in: path
35646           description: IP address
35647           required: true
35648           type: string
35649           example: __L3-INTERFACE-IPV6-ADDRESS__
35650         - name: body
35651           in: body
35652           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
35653           required: true
35654           schema:
35655             $ref: "#/definitions/relationship"
35656     delete:
35657       tags:
35658         - Network
35659       summary: delete an existing relationship
35660       description: delete an existing relationship
35661       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
35662       consumes:
35663         - application/json
35664         - application/xml
35665       produces:
35666         - application/json
35667         - application/xml
35668       responses:
35669         "default":
35670           description: Response codes found in [response codes](https://wiki.onap.org/).
35671       parameters:
35672         - name: vnf-id
35673           in: path
35674           description: Unique id of VNF.  This is unique across the graph.
35675           required: true
35676           type: string
35677           example: __VNF-ID__
35678         - name: interface-name
35679           in: path
35680           description: Name that identifies the link aggregate interface
35681           required: true
35682           type: string
35683           example: __INTERFACE-NAME__
35684         - name: interface-name
35685           in: path
35686           description: Name given to the interface
35687           required: true
35688           type: string
35689           example: __INTERFACE-NAME__
35690         - name: l3-interface-ipv6-address
35691           in: path
35692           description: IP address
35693           required: true
35694           type: string
35695           example: __L3-INTERFACE-IPV6-ADDRESS__
35696   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
35697     get:
35698       tags:
35699         - Network
35700       summary: returns l3-interface-ipv6-address-list
35701       description: returns l3-interface-ipv6-address-list
35702       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
35703       produces:
35704         - application/json
35705         - application/xml
35706       responses:
35707         "200":
35708           description: successful operation
35709           schema:
35710               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
35711         "default":
35712           description: Response codes found in [response codes](https://wiki.onap.org/).
35713       parameters:
35714         - name: vnf-id
35715           in: path
35716           description: Unique id of VNF.  This is unique across the graph.
35717           required: true
35718           type: string
35719           example: __VNF-ID__
35720         - name: interface-name
35721           in: path
35722           description: Name that identifies the link aggregate interface
35723           required: true
35724           type: string
35725           example: __INTERFACE-NAME__
35726         - name: interface-name
35727           in: path
35728           description: Name given to the interface
35729           required: true
35730           type: string
35731           example: __INTERFACE-NAME__
35732         - name: l3-interface-ipv6-address
35733           in: path
35734           description: IP address
35735           required: true
35736           type: string
35737           example: __L3-INTERFACE-IPV6-ADDRESS__
35738         - name: vnf-name
35739           in: query
35740           description: Name of VNF.
35741           required: false
35742           type: string
35743         - name: vnf-name2
35744           in: query
35745           description: Alternate name of VNF.
35746           required: false
35747           type: string
35748         - name: vnf-type
35749           in: query
35750           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
35751           required: false
35752           type: string
35753         - name: service-id
35754           in: query
35755           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
35756           required: false
35757           type: string
35758         - name: regional-resource-zone
35759           in: query
35760           description: Regional way of organizing pservers, source of truth should define values
35761           required: false
35762           type: string
35763         - name: prov-status
35764           in: query
35765           description: Trigger for operational monitoring of this resource by Service Assurance systems.
35766           required: false
35767           type: string
35768         - name: heat-stack-id
35769           in: query
35770           description: Heat stack id corresponding to this instance, managed by MSO
35771           required: false
35772           type: string
35773         - name: in-maint
35774           in: query
35775           required: false
35776           type: boolean
35777         - name: is-closed-loop-disabled
35778           in: query
35779           required: false
35780           type: boolean
35781         - name: persona-model-id
35782           in: query
35783           description: the ASDC model id for this resource or service model.
35784           required: false
35785           type: string
35786         - name: persona-model-version
35787           in: query
35788           description: the ASDC model version for this resource or service model.
35789           required: false
35790           type: string
35791         - name: widget-model-id
35792           in: query
35793           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
35794           required: false
35795           type: string
35796         - name: widget-model-version
35797           in: query
35798           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
35799           required: false
35800           type: string
35801         - name: interface-id
35802           in: query
35803           description: ID of interface
35804           required: false
35805           type: string
35806         - name: interface-role
35807           in: query
35808           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
35809           required: false
35810           type: string
35811         - name: interface-id
35812           in: query
35813           description: ID of interface
35814           required: false
35815           type: string
35816         - name: macaddr
35817           in: query
35818           description: MAC address for the interface
35819           required: false
35820           type: string
35821         - name: network-name
35822           in: query
35823           description: Name of the network
35824           required: false
35825           type: string
35826         - name: vlan-id-inner
35827           in: query
35828           description: Inner VLAN tag
35829           required: false
35830           type: integer
35831           format: int64
35832         - name: neutron-network-id
35833           in: query
35834           description: Neutron network id of the interface that address belongs to
35835           required: false
35836           type: string
35837         - name: neutron-subnet-id
35838           in: query
35839           description: Neutron id of subnet that address belongs to
35840           required: false
35841           type: string
35842     put:
35843       tags:
35844         - Network
35845       summary: create or update an existing l3-interface-ipv6-address-list
35846       description: |
35847         Create or update an existing l3-interface-ipv6-address-list.
35848         #
35849         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
35850       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
35851       consumes:
35852         - application/json
35853         - application/xml
35854       produces:
35855         - application/json
35856         - application/xml
35857       responses:
35858         "default":
35859           description: Response codes found in [response codes](https://wiki.onap.org/).
35860       parameters:
35861         - name: vnf-id
35862           in: path
35863           description: Unique id of VNF.  This is unique across the graph.
35864           required: true
35865           type: string
35866           example: __VNF-ID__
35867         - name: interface-name
35868           in: path
35869           description: Name that identifies the link aggregate interface
35870           required: true
35871           type: string
35872           example: __INTERFACE-NAME__
35873         - name: interface-name
35874           in: path
35875           description: Name given to the interface
35876           required: true
35877           type: string
35878           example: __INTERFACE-NAME__
35879         - name: l3-interface-ipv6-address
35880           in: path
35881           description: IP address
35882           required: true
35883           type: string
35884           example: __L3-INTERFACE-IPV6-ADDRESS__
35885         - name: body
35886           in: body
35887           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
35888           required: true
35889           schema:
35890             $ref: "#/definitions/l3-interface-ipv6-address-list"
35891     patch:
35892       tags:
35893         - Network
35894       summary: update an existing l3-interface-ipv6-address-list
35895       description: |
35896         Update an existing l3-interface-ipv6-address-list
35897         #
35898         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35899         The PUT operation will entirely replace an existing object.
35900         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
35901         #
35902         Other differences between PUT and PATCH are:
35903         #
35904         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
35905         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35906         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35907       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
35908       consumes:
35909         - application/json
35910         - application/xml
35911       produces:
35912         - application/json
35913         - application/xml
35914       responses:
35915         "default":
35916           description: Response codes found in [response codes](https://wiki.onap.org/).
35917       parameters:
35918         - name: vnf-id
35919           in: path
35920           description: Unique id of VNF.  This is unique across the graph.
35921           required: true
35922           type: string
35923           example: __VNF-ID__
35924         - name: interface-name
35925           in: path
35926           description: Name that identifies the link aggregate interface
35927           required: true
35928           type: string
35929           example: __INTERFACE-NAME__
35930         - name: interface-name
35931           in: path
35932           description: Name given to the interface
35933           required: true
35934           type: string
35935           example: __INTERFACE-NAME__
35936         - name: l3-interface-ipv6-address
35937           in: path
35938           description: IP address
35939           required: true
35940           type: string
35941           example: __L3-INTERFACE-IPV6-ADDRESS__
35942         - name: body
35943           in: body
35944           description: l3-interface-ipv6-address-list object that needs to be created or updated.
35945           required: true
35946           schema:
35947             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
35948     delete:
35949       tags:
35950         - Network
35951       summary: delete an existing l3-interface-ipv6-address-list
35952       description: delete an existing l3-interface-ipv6-address-list
35953       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
35954       consumes:
35955         - application/json
35956         - application/xml
35957       produces:
35958         - application/json
35959         - application/xml
35960       responses:
35961         "default":
35962           description: Response codes found in [response codes](https://wiki.onap.org/).
35963       parameters:
35964         - name: vnf-id
35965           in: path
35966           description: Unique id of VNF.  This is unique across the graph.
35967           required: true
35968           type: string
35969           example: __VNF-ID__
35970         - name: interface-name
35971           in: path
35972           description: Name that identifies the link aggregate interface
35973           required: true
35974           type: string
35975           example: __INTERFACE-NAME__
35976         - name: interface-name
35977           in: path
35978           description: Name given to the interface
35979           required: true
35980           type: string
35981           example: __INTERFACE-NAME__
35982         - name: l3-interface-ipv6-address
35983           in: path
35984           description: IP address
35985           required: true
35986           type: string
35987           example: __L3-INTERFACE-IPV6-ADDRESS__
35988         - name: resource-version
35989           in: query
35990           description: resource-version for concurrency
35991           required: true
35992           type: string
35993   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
35994     get:
35995       tags:
35996         - Network
35997       summary: returns l-interface
35998       description: returns l-interface
35999       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
36000       produces:
36001         - application/json
36002         - application/xml
36003       responses:
36004         "200":
36005           description: successful operation
36006           schema:
36007               $ref: "#/getDefinitions/l-interface"
36008         "default":
36009           description: Response codes found in [response codes](https://wiki.onap.org/).
36010       parameters:
36011         - name: vnf-id
36012           in: path
36013           description: Unique id of VNF.  This is unique across the graph.
36014           required: true
36015           type: string
36016           example: __VNF-ID__
36017         - name: interface-name
36018           in: path
36019           description: Name that identifies the link aggregate interface
36020           required: true
36021           type: string
36022           example: __INTERFACE-NAME__
36023         - name: interface-name
36024           in: path
36025           description: Name given to the interface
36026           required: true
36027           type: string
36028           example: __INTERFACE-NAME__
36029         - name: vnf-name
36030           in: query
36031           description: Name of VNF.
36032           required: false
36033           type: string
36034         - name: vnf-name2
36035           in: query
36036           description: Alternate name of VNF.
36037           required: false
36038           type: string
36039         - name: vnf-type
36040           in: query
36041           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
36042           required: false
36043           type: string
36044         - name: service-id
36045           in: query
36046           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
36047           required: false
36048           type: string
36049         - name: regional-resource-zone
36050           in: query
36051           description: Regional way of organizing pservers, source of truth should define values
36052           required: false
36053           type: string
36054         - name: prov-status
36055           in: query
36056           description: Trigger for operational monitoring of this resource by Service Assurance systems.
36057           required: false
36058           type: string
36059         - name: heat-stack-id
36060           in: query
36061           description: Heat stack id corresponding to this instance, managed by MSO
36062           required: false
36063           type: string
36064         - name: in-maint
36065           in: query
36066           required: false
36067           type: boolean
36068         - name: is-closed-loop-disabled
36069           in: query
36070           required: false
36071           type: boolean
36072         - name: persona-model-id
36073           in: query
36074           description: the ASDC model id for this resource or service model.
36075           required: false
36076           type: string
36077         - name: persona-model-version
36078           in: query
36079           description: the ASDC model version for this resource or service model.
36080           required: false
36081           type: string
36082         - name: widget-model-id
36083           in: query
36084           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
36085           required: false
36086           type: string
36087         - name: widget-model-version
36088           in: query
36089           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
36090           required: false
36091           type: string
36092         - name: interface-id
36093           in: query
36094           description: ID of interface
36095           required: false
36096           type: string
36097         - name: interface-role
36098           in: query
36099           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
36100           required: false
36101           type: string
36102         - name: interface-id
36103           in: query
36104           description: ID of interface
36105           required: false
36106           type: string
36107         - name: macaddr
36108           in: query
36109           description: MAC address for the interface
36110           required: false
36111           type: string
36112         - name: network-name
36113           in: query
36114           description: Name of the network
36115           required: false
36116           type: string
36117     put:
36118       tags:
36119         - Network
36120       summary: create or update an existing l-interface
36121       description: |
36122         Create or update an existing l-interface.
36123         #
36124         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
36125       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
36126       consumes:
36127         - application/json
36128         - application/xml
36129       produces:
36130         - application/json
36131         - application/xml
36132       responses:
36133         "default":
36134           description: Response codes found in [response codes](https://wiki.onap.org/).
36135       parameters:
36136         - name: vnf-id
36137           in: path
36138           description: Unique id of VNF.  This is unique across the graph.
36139           required: true
36140           type: string
36141           example: __VNF-ID__
36142         - name: interface-name
36143           in: path
36144           description: Name that identifies the link aggregate interface
36145           required: true
36146           type: string
36147           example: __INTERFACE-NAME__
36148         - name: interface-name
36149           in: path
36150           description: Name given to the interface
36151           required: true
36152           type: string
36153           example: __INTERFACE-NAME__
36154         - name: body
36155           in: body
36156           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
36157           required: true
36158           schema:
36159             $ref: "#/definitions/l-interface"
36160     patch:
36161       tags:
36162         - Network
36163       summary: update an existing l-interface
36164       description: |
36165         Update an existing l-interface
36166         #
36167         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36168         The PUT operation will entirely replace an existing object.
36169         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
36170         #
36171         Other differences between PUT and PATCH are:
36172         #
36173         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
36174         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36175         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36176       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
36177       consumes:
36178         - application/json
36179         - application/xml
36180       produces:
36181         - application/json
36182         - application/xml
36183       responses:
36184         "default":
36185           description: Response codes found in [response codes](https://wiki.onap.org/).
36186       parameters:
36187         - name: vnf-id
36188           in: path
36189           description: Unique id of VNF.  This is unique across the graph.
36190           required: true
36191           type: string
36192           example: __VNF-ID__
36193         - name: interface-name
36194           in: path
36195           description: Name that identifies the link aggregate interface
36196           required: true
36197           type: string
36198           example: __INTERFACE-NAME__
36199         - name: interface-name
36200           in: path
36201           description: Name given to the interface
36202           required: true
36203           type: string
36204           example: __INTERFACE-NAME__
36205         - name: body
36206           in: body
36207           description: l-interface object that needs to be created or updated.
36208           required: true
36209           schema:
36210             $ref: "#/patchDefinitions/l-interface"
36211     delete:
36212       tags:
36213         - Network
36214       summary: delete an existing l-interface
36215       description: delete an existing l-interface
36216       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
36217       consumes:
36218         - application/json
36219         - application/xml
36220       produces:
36221         - application/json
36222         - application/xml
36223       responses:
36224         "default":
36225           description: Response codes found in [response codes](https://wiki.onap.org/).
36226       parameters:
36227         - name: vnf-id
36228           in: path
36229           description: Unique id of VNF.  This is unique across the graph.
36230           required: true
36231           type: string
36232           example: __VNF-ID__
36233         - name: interface-name
36234           in: path
36235           description: Name that identifies the link aggregate interface
36236           required: true
36237           type: string
36238           example: __INTERFACE-NAME__
36239         - name: interface-name
36240           in: path
36241           description: Name given to the interface
36242           required: true
36243           type: string
36244           example: __INTERFACE-NAME__
36245         - name: resource-version
36246           in: query
36247           description: resource-version for concurrency
36248           required: true
36249           type: string
36250   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
36251     get:
36252       tags:
36253         - Network
36254       summary: returns l-interfaces
36255       description: returns l-interfaces
36256       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfaces
36257       produces:
36258         - application/json
36259         - application/xml
36260       responses:
36261         "200":
36262           description: successful operation
36263           schema:
36264               $ref: "#/getDefinitions/l-interfaces"
36265         "default":
36266           description: Response codes found in [response codes](https://wiki.onap.org/).
36267       parameters:
36268         - name: vnf-id
36269           in: path
36270           description: Unique id of VNF.  This is unique across the graph.
36271           required: true
36272           type: string
36273           example: __VNF-ID__
36274         - name: interface-name
36275           in: path
36276           description: Name that identifies the link aggregate interface
36277           required: true
36278           type: string
36279           example: __INTERFACE-NAME__
36280         - name: vnf-name
36281           in: query
36282           description: Name of VNF.
36283           required: false
36284           type: string
36285         - name: vnf-name2
36286           in: query
36287           description: Alternate name of VNF.
36288           required: false
36289           type: string
36290         - name: vnf-type
36291           in: query
36292           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
36293           required: false
36294           type: string
36295         - name: service-id
36296           in: query
36297           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
36298           required: false
36299           type: string
36300         - name: regional-resource-zone
36301           in: query
36302           description: Regional way of organizing pservers, source of truth should define values
36303           required: false
36304           type: string
36305         - name: prov-status
36306           in: query
36307           description: Trigger for operational monitoring of this resource by Service Assurance systems.
36308           required: false
36309           type: string
36310         - name: heat-stack-id
36311           in: query
36312           description: Heat stack id corresponding to this instance, managed by MSO
36313           required: false
36314           type: string
36315         - name: in-maint
36316           in: query
36317           required: false
36318           type: boolean
36319         - name: is-closed-loop-disabled
36320           in: query
36321           required: false
36322           type: boolean
36323         - name: persona-model-id
36324           in: query
36325           description: the ASDC model id for this resource or service model.
36326           required: false
36327           type: string
36328         - name: persona-model-version
36329           in: query
36330           description: the ASDC model version for this resource or service model.
36331           required: false
36332           type: string
36333         - name: widget-model-id
36334           in: query
36335           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
36336           required: false
36337           type: string
36338         - name: widget-model-version
36339           in: query
36340           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
36341           required: false
36342           type: string
36343         - name: interface-id
36344           in: query
36345           description: ID of interface
36346           required: false
36347           type: string
36348         - name: interface-role
36349           in: query
36350           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
36351           required: false
36352           type: string
36353   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}:
36354     get:
36355       tags:
36356         - Network
36357       summary: returns lag-interface
36358       description: returns lag-interface
36359       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
36360       produces:
36361         - application/json
36362         - application/xml
36363       responses:
36364         "200":
36365           description: successful operation
36366           schema:
36367               $ref: "#/getDefinitions/lag-interface"
36368         "default":
36369           description: Response codes found in [response codes](https://wiki.onap.org/).
36370       parameters:
36371         - name: vnf-id
36372           in: path
36373           description: Unique id of VNF.  This is unique across the graph.
36374           required: true
36375           type: string
36376           example: __VNF-ID__
36377         - name: interface-name
36378           in: path
36379           description: Name that identifies the link aggregate interface
36380           required: true
36381           type: string
36382           example: __INTERFACE-NAME__
36383         - name: vnf-name
36384           in: query
36385           description: Name of VNF.
36386           required: false
36387           type: string
36388         - name: vnf-name2
36389           in: query
36390           description: Alternate name of VNF.
36391           required: false
36392           type: string
36393         - name: vnf-type
36394           in: query
36395           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
36396           required: false
36397           type: string
36398         - name: service-id
36399           in: query
36400           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
36401           required: false
36402           type: string
36403         - name: regional-resource-zone
36404           in: query
36405           description: Regional way of organizing pservers, source of truth should define values
36406           required: false
36407           type: string
36408         - name: prov-status
36409           in: query
36410           description: Trigger for operational monitoring of this resource by Service Assurance systems.
36411           required: false
36412           type: string
36413         - name: heat-stack-id
36414           in: query
36415           description: Heat stack id corresponding to this instance, managed by MSO
36416           required: false
36417           type: string
36418         - name: in-maint
36419           in: query
36420           required: false
36421           type: boolean
36422         - name: is-closed-loop-disabled
36423           in: query
36424           required: false
36425           type: boolean
36426         - name: persona-model-id
36427           in: query
36428           description: the ASDC model id for this resource or service model.
36429           required: false
36430           type: string
36431         - name: persona-model-version
36432           in: query
36433           description: the ASDC model version for this resource or service model.
36434           required: false
36435           type: string
36436         - name: widget-model-id
36437           in: query
36438           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
36439           required: false
36440           type: string
36441         - name: widget-model-version
36442           in: query
36443           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
36444           required: false
36445           type: string
36446         - name: interface-id
36447           in: query
36448           description: ID of interface
36449           required: false
36450           type: string
36451         - name: interface-role
36452           in: query
36453           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
36454           required: false
36455           type: string
36456     put:
36457       tags:
36458         - Network
36459       summary: create or update an existing lag-interface
36460       description: |
36461         Create or update an existing lag-interface.
36462         #
36463         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
36464       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
36465       consumes:
36466         - application/json
36467         - application/xml
36468       produces:
36469         - application/json
36470         - application/xml
36471       responses:
36472         "default":
36473           description: Response codes found in [response codes](https://wiki.onap.org/).
36474       parameters:
36475         - name: vnf-id
36476           in: path
36477           description: Unique id of VNF.  This is unique across the graph.
36478           required: true
36479           type: string
36480           example: __VNF-ID__
36481         - name: interface-name
36482           in: path
36483           description: Name that identifies the link aggregate interface
36484           required: true
36485           type: string
36486           example: __INTERFACE-NAME__
36487         - name: body
36488           in: body
36489           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
36490           required: true
36491           schema:
36492             $ref: "#/definitions/lag-interface"
36493     patch:
36494       tags:
36495         - Network
36496       summary: update an existing lag-interface
36497       description: |
36498         Update an existing lag-interface
36499         #
36500         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36501         The PUT operation will entirely replace an existing object.
36502         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
36503         #
36504         Other differences between PUT and PATCH are:
36505         #
36506         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
36507         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36508         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36509       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
36510       consumes:
36511         - application/json
36512         - application/xml
36513       produces:
36514         - application/json
36515         - application/xml
36516       responses:
36517         "default":
36518           description: Response codes found in [response codes](https://wiki.onap.org/).
36519       parameters:
36520         - name: vnf-id
36521           in: path
36522           description: Unique id of VNF.  This is unique across the graph.
36523           required: true
36524           type: string
36525           example: __VNF-ID__
36526         - name: interface-name
36527           in: path
36528           description: Name that identifies the link aggregate interface
36529           required: true
36530           type: string
36531           example: __INTERFACE-NAME__
36532         - name: body
36533           in: body
36534           description: lag-interface object that needs to be created or updated.
36535           required: true
36536           schema:
36537             $ref: "#/patchDefinitions/lag-interface"
36538     delete:
36539       tags:
36540         - Network
36541       summary: delete an existing lag-interface
36542       description: delete an existing lag-interface
36543       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
36544       consumes:
36545         - application/json
36546         - application/xml
36547       produces:
36548         - application/json
36549         - application/xml
36550       responses:
36551         "default":
36552           description: Response codes found in [response codes](https://wiki.onap.org/).
36553       parameters:
36554         - name: vnf-id
36555           in: path
36556           description: Unique id of VNF.  This is unique across the graph.
36557           required: true
36558           type: string
36559           example: __VNF-ID__
36560         - name: interface-name
36561           in: path
36562           description: Name that identifies the link aggregate interface
36563           required: true
36564           type: string
36565           example: __INTERFACE-NAME__
36566         - name: resource-version
36567           in: query
36568           description: resource-version for concurrency
36569           required: true
36570           type: string
36571   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces:
36572     get:
36573       tags:
36574         - Network
36575       summary: returns lag-interfaces
36576       description: returns lag-interfaces
36577       operationId: getNetworkGenericVnfsGenericVnfLagInterfaces
36578       produces:
36579         - application/json
36580         - application/xml
36581       responses:
36582         "200":
36583           description: successful operation
36584           schema:
36585               $ref: "#/getDefinitions/lag-interfaces"
36586         "default":
36587           description: Response codes found in [response codes](https://wiki.onap.org/).
36588       parameters:
36589         - name: vnf-id
36590           in: path
36591           description: Unique id of VNF.  This is unique across the graph.
36592           required: true
36593           type: string
36594           example: __VNF-ID__
36595         - name: vnf-name
36596           in: query
36597           description: Name of VNF.
36598           required: false
36599           type: string
36600         - name: vnf-name2
36601           in: query
36602           description: Alternate name of VNF.
36603           required: false
36604           type: string
36605         - name: vnf-type
36606           in: query
36607           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
36608           required: false
36609           type: string
36610         - name: service-id
36611           in: query
36612           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
36613           required: false
36614           type: string
36615         - name: regional-resource-zone
36616           in: query
36617           description: Regional way of organizing pservers, source of truth should define values
36618           required: false
36619           type: string
36620         - name: prov-status
36621           in: query
36622           description: Trigger for operational monitoring of this resource by Service Assurance systems.
36623           required: false
36624           type: string
36625         - name: heat-stack-id
36626           in: query
36627           description: Heat stack id corresponding to this instance, managed by MSO
36628           required: false
36629           type: string
36630         - name: in-maint
36631           in: query
36632           required: false
36633           type: boolean
36634         - name: is-closed-loop-disabled
36635           in: query
36636           required: false
36637           type: boolean
36638         - name: persona-model-id
36639           in: query
36640           description: the ASDC model id for this resource or service model.
36641           required: false
36642           type: string
36643         - name: persona-model-version
36644           in: query
36645           description: the ASDC model version for this resource or service model.
36646           required: false
36647           type: string
36648         - name: widget-model-id
36649           in: query
36650           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
36651           required: false
36652           type: string
36653         - name: widget-model-version
36654           in: query
36655           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
36656           required: false
36657           type: string
36658   /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship:
36659     put:
36660       tags:
36661         - Network
36662       summary: see node definition for valid relationships
36663       operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship
36664       consumes:
36665         - application/json
36666         - application/xml
36667       produces:
36668         - application/json
36669         - application/xml
36670       responses:
36671         "default":
36672           description: Response codes found in [response codes](https://wiki.onap.org/).
36673       parameters:
36674         - name: vnf-id
36675           in: path
36676           description: Unique id of VNF.  This is unique across the graph.
36677           required: true
36678           type: string
36679           example: __VNF-ID__
36680         - name: vf-module-id
36681           in: path
36682           description: Unique ID of vf-module.
36683           required: true
36684           type: string
36685           example: __VF-MODULE-ID__
36686         - name: body
36687           in: body
36688           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
36689           required: true
36690           schema:
36691             $ref: "#/definitions/relationship"
36692     delete:
36693       tags:
36694         - Network
36695       summary: delete an existing relationship
36696       description: delete an existing relationship
36697       operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship
36698       consumes:
36699         - application/json
36700         - application/xml
36701       produces:
36702         - application/json
36703         - application/xml
36704       responses:
36705         "default":
36706           description: Response codes found in [response codes](https://wiki.onap.org/).
36707       parameters:
36708         - name: vnf-id
36709           in: path
36710           description: Unique id of VNF.  This is unique across the graph.
36711           required: true
36712           type: string
36713           example: __VNF-ID__
36714         - name: vf-module-id
36715           in: path
36716           description: Unique ID of vf-module.
36717           required: true
36718           type: string
36719           example: __VF-MODULE-ID__
36720   /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}:
36721     get:
36722       tags:
36723         - Network
36724       summary: returns vf-module
36725       description: returns vf-module
36726       operationId: getNetworkGenericVnfsGenericVnfVfModulesVfModule
36727       produces:
36728         - application/json
36729         - application/xml
36730       responses:
36731         "200":
36732           description: successful operation
36733           schema:
36734               $ref: "#/getDefinitions/vf-module"
36735         "default":
36736           description: Response codes found in [response codes](https://wiki.onap.org/).
36737       parameters:
36738         - name: vnf-id
36739           in: path
36740           description: Unique id of VNF.  This is unique across the graph.
36741           required: true
36742           type: string
36743           example: __VNF-ID__
36744         - name: vf-module-id
36745           in: path
36746           description: Unique ID of vf-module.
36747           required: true
36748           type: string
36749           example: __VF-MODULE-ID__
36750         - name: vnf-name
36751           in: query
36752           description: Name of VNF.
36753           required: false
36754           type: string
36755         - name: vnf-name2
36756           in: query
36757           description: Alternate name of VNF.
36758           required: false
36759           type: string
36760         - name: vnf-type
36761           in: query
36762           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
36763           required: false
36764           type: string
36765         - name: service-id
36766           in: query
36767           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
36768           required: false
36769           type: string
36770         - name: regional-resource-zone
36771           in: query
36772           description: Regional way of organizing pservers, source of truth should define values
36773           required: false
36774           type: string
36775         - name: prov-status
36776           in: query
36777           description: Trigger for operational monitoring of this resource by Service Assurance systems.
36778           required: false
36779           type: string
36780         - name: heat-stack-id
36781           in: query
36782           description: Heat stack id corresponding to this instance, managed by MSO
36783           required: false
36784           type: string
36785         - name: in-maint
36786           in: query
36787           required: false
36788           type: boolean
36789         - name: is-closed-loop-disabled
36790           in: query
36791           required: false
36792           type: boolean
36793         - name: persona-model-id
36794           in: query
36795           description: the ASDC model id for this resource or service model.
36796           required: false
36797           type: string
36798         - name: persona-model-version
36799           in: query
36800           description: the ASDC model version for this resource or service model.
36801           required: false
36802           type: string
36803         - name: widget-model-id
36804           in: query
36805           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
36806           required: false
36807           type: string
36808         - name: widget-model-version
36809           in: query
36810           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
36811           required: false
36812           type: string
36813         - name: vf-module-name
36814           in: query
36815           description: Name of vf-module
36816           required: false
36817           type: string
36818         - name: heat-stack-id
36819           in: query
36820           description: Heat stack id corresponding to this instance.
36821           required: false
36822           type: string
36823         - name: persona-model-id
36824           in: query
36825           description: the ASDC model id for this resource or service model.
36826           required: false
36827           type: string
36828         - name: persona-model-version
36829           in: query
36830           description: the ASDC model version for this resource or service model.
36831           required: false
36832           type: string
36833         - name: widget-model-id
36834           in: query
36835           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
36836           required: false
36837           type: string
36838         - name: widget-model-version
36839           in: query
36840           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
36841           required: false
36842           type: string
36843         - name: contrail-service-instance-fqdn
36844           in: query
36845           description: the Contrail unique ID for a service-instance
36846           required: false
36847           type: string
36848     put:
36849       tags:
36850         - Network
36851       summary: create or update an existing vf-module
36852       description: |
36853         Create or update an existing vf-module.
36854         #
36855         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
36856       operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModule
36857       consumes:
36858         - application/json
36859         - application/xml
36860       produces:
36861         - application/json
36862         - application/xml
36863       responses:
36864         "default":
36865           description: Response codes found in [response codes](https://wiki.onap.org/).
36866       parameters:
36867         - name: vnf-id
36868           in: path
36869           description: Unique id of VNF.  This is unique across the graph.
36870           required: true
36871           type: string
36872           example: __VNF-ID__
36873         - name: vf-module-id
36874           in: path
36875           description: Unique ID of vf-module.
36876           required: true
36877           type: string
36878           example: __VF-MODULE-ID__
36879         - name: body
36880           in: body
36881           description: vf-module object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
36882           required: true
36883           schema:
36884             $ref: "#/definitions/vf-module"
36885     patch:
36886       tags:
36887         - Network
36888       summary: update an existing vf-module
36889       description: |
36890         Update an existing vf-module
36891         #
36892         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36893         The PUT operation will entirely replace an existing object.
36894         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
36895         #
36896         Other differences between PUT and PATCH are:
36897         #
36898         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
36899         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36900         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36901       operationId: UpdateNetworkGenericVnfsGenericVnfVfModulesVfModule
36902       consumes:
36903         - application/json
36904         - application/xml
36905       produces:
36906         - application/json
36907         - application/xml
36908       responses:
36909         "default":
36910           description: Response codes found in [response codes](https://wiki.onap.org/).
36911       parameters:
36912         - name: vnf-id
36913           in: path
36914           description: Unique id of VNF.  This is unique across the graph.
36915           required: true
36916           type: string
36917           example: __VNF-ID__
36918         - name: vf-module-id
36919           in: path
36920           description: Unique ID of vf-module.
36921           required: true
36922           type: string
36923           example: __VF-MODULE-ID__
36924         - name: body
36925           in: body
36926           description: vf-module object that needs to be created or updated.
36927           required: true
36928           schema:
36929             $ref: "#/patchDefinitions/vf-module"
36930     delete:
36931       tags:
36932         - Network
36933       summary: delete an existing vf-module
36934       description: delete an existing vf-module
36935       operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModule
36936       consumes:
36937         - application/json
36938         - application/xml
36939       produces:
36940         - application/json
36941         - application/xml
36942       responses:
36943         "default":
36944           description: Response codes found in [response codes](https://wiki.onap.org/).
36945       parameters:
36946         - name: vnf-id
36947           in: path
36948           description: Unique id of VNF.  This is unique across the graph.
36949           required: true
36950           type: string
36951           example: __VNF-ID__
36952         - name: vf-module-id
36953           in: path
36954           description: Unique ID of vf-module.
36955           required: true
36956           type: string
36957           example: __VF-MODULE-ID__
36958         - name: resource-version
36959           in: query
36960           description: resource-version for concurrency
36961           required: true
36962           type: string
36963   /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules:
36964     get:
36965       tags:
36966         - Network
36967       summary: returns vf-modules
36968       description: returns vf-modules
36969       operationId: getNetworkGenericVnfsGenericVnfVfModules
36970       produces:
36971         - application/json
36972         - application/xml
36973       responses:
36974         "200":
36975           description: successful operation
36976           schema:
36977               $ref: "#/getDefinitions/vf-modules"
36978         "default":
36979           description: Response codes found in [response codes](https://wiki.onap.org/).
36980       parameters:
36981         - name: vnf-id
36982           in: path
36983           description: Unique id of VNF.  This is unique across the graph.
36984           required: true
36985           type: string
36986           example: __VNF-ID__
36987         - name: vnf-name
36988           in: query
36989           description: Name of VNF.
36990           required: false
36991           type: string
36992         - name: vnf-name2
36993           in: query
36994           description: Alternate name of VNF.
36995           required: false
36996           type: string
36997         - name: vnf-type
36998           in: query
36999           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
37000           required: false
37001           type: string
37002         - name: service-id
37003           in: query
37004           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
37005           required: false
37006           type: string
37007         - name: regional-resource-zone
37008           in: query
37009           description: Regional way of organizing pservers, source of truth should define values
37010           required: false
37011           type: string
37012         - name: prov-status
37013           in: query
37014           description: Trigger for operational monitoring of this resource by Service Assurance systems.
37015           required: false
37016           type: string
37017         - name: heat-stack-id
37018           in: query
37019           description: Heat stack id corresponding to this instance, managed by MSO
37020           required: false
37021           type: string
37022         - name: in-maint
37023           in: query
37024           required: false
37025           type: boolean
37026         - name: is-closed-loop-disabled
37027           in: query
37028           required: false
37029           type: boolean
37030         - name: persona-model-id
37031           in: query
37032           description: the ASDC model id for this resource or service model.
37033           required: false
37034           type: string
37035         - name: persona-model-version
37036           in: query
37037           description: the ASDC model version for this resource or service model.
37038           required: false
37039           type: string
37040         - name: widget-model-id
37041           in: query
37042           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
37043           required: false
37044           type: string
37045         - name: widget-model-version
37046           in: query
37047           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
37048           required: false
37049           type: string
37050   /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship:
37051     put:
37052       tags:
37053         - Network
37054       summary: see node definition for valid relationships
37055       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship
37056       consumes:
37057         - application/json
37058         - application/xml
37059       produces:
37060         - application/json
37061         - application/xml
37062       responses:
37063         "default":
37064           description: Response codes found in [response codes](https://wiki.onap.org/).
37065       parameters:
37066         - name: vnf-id
37067           in: path
37068           description: Unique id of VNF.  This is unique across the graph.
37069           required: true
37070           type: string
37071           example: __VNF-ID__
37072         - name: group-uuid
37073           in: path
37074           description: Unique ID for the license group the resource belongs to, should be uuid.
37075           required: true
37076           type: string
37077           example: __GROUP-UUID__
37078         - name: resource-uuid
37079           in: path
37080           description: Unique ID of a license resource.
37081           required: true
37082           type: string
37083           example: __RESOURCE-UUID__
37084         - name: body
37085           in: body
37086           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLicensesLicense.json)
37087           required: true
37088           schema:
37089             $ref: "#/definitions/relationship"
37090     delete:
37091       tags:
37092         - Network
37093       summary: delete an existing relationship
37094       description: delete an existing relationship
37095       operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship
37096       consumes:
37097         - application/json
37098         - application/xml
37099       produces:
37100         - application/json
37101         - application/xml
37102       responses:
37103         "default":
37104           description: Response codes found in [response codes](https://wiki.onap.org/).
37105       parameters:
37106         - name: vnf-id
37107           in: path
37108           description: Unique id of VNF.  This is unique across the graph.
37109           required: true
37110           type: string
37111           example: __VNF-ID__
37112         - name: group-uuid
37113           in: path
37114           description: Unique ID for the license group the resource belongs to, should be uuid.
37115           required: true
37116           type: string
37117           example: __GROUP-UUID__
37118         - name: resource-uuid
37119           in: path
37120           description: Unique ID of a license resource.
37121           required: true
37122           type: string
37123           example: __RESOURCE-UUID__
37124   /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}:
37125     get:
37126       tags:
37127         - Network
37128       summary: returns license
37129       description: returns license
37130       operationId: getNetworkGenericVnfsGenericVnfLicensesLicense
37131       produces:
37132         - application/json
37133         - application/xml
37134       responses:
37135         "200":
37136           description: successful operation
37137           schema:
37138               $ref: "#/getDefinitions/license"
37139         "default":
37140           description: Response codes found in [response codes](https://wiki.onap.org/).
37141       parameters:
37142         - name: vnf-id
37143           in: path
37144           description: Unique id of VNF.  This is unique across the graph.
37145           required: true
37146           type: string
37147           example: __VNF-ID__
37148         - name: group-uuid
37149           in: path
37150           description: Unique ID for the license group the resource belongs to, should be uuid.
37151           required: true
37152           type: string
37153           example: __GROUP-UUID__
37154         - name: resource-uuid
37155           in: path
37156           description: Unique ID of a license resource.
37157           required: true
37158           type: string
37159           example: __RESOURCE-UUID__
37160         - name: vnf-name
37161           in: query
37162           description: Name of VNF.
37163           required: false
37164           type: string
37165         - name: vnf-name2
37166           in: query
37167           description: Alternate name of VNF.
37168           required: false
37169           type: string
37170         - name: vnf-type
37171           in: query
37172           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
37173           required: false
37174           type: string
37175         - name: service-id
37176           in: query
37177           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
37178           required: false
37179           type: string
37180         - name: regional-resource-zone
37181           in: query
37182           description: Regional way of organizing pservers, source of truth should define values
37183           required: false
37184           type: string
37185         - name: prov-status
37186           in: query
37187           description: Trigger for operational monitoring of this resource by Service Assurance systems.
37188           required: false
37189           type: string
37190         - name: heat-stack-id
37191           in: query
37192           description: Heat stack id corresponding to this instance, managed by MSO
37193           required: false
37194           type: string
37195         - name: in-maint
37196           in: query
37197           required: false
37198           type: boolean
37199         - name: is-closed-loop-disabled
37200           in: query
37201           required: false
37202           type: boolean
37203         - name: persona-model-id
37204           in: query
37205           description: the ASDC model id for this resource or service model.
37206           required: false
37207           type: string
37208         - name: persona-model-version
37209           in: query
37210           description: the ASDC model version for this resource or service model.
37211           required: false
37212           type: string
37213         - name: widget-model-id
37214           in: query
37215           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
37216           required: false
37217           type: string
37218         - name: widget-model-version
37219           in: query
37220           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
37221           required: false
37222           type: string
37223     put:
37224       tags:
37225         - Network
37226       summary: create or update an existing license
37227       description: |
37228         Create or update an existing license.
37229         #
37230         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
37231       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicense
37232       consumes:
37233         - application/json
37234         - application/xml
37235       produces:
37236         - application/json
37237         - application/xml
37238       responses:
37239         "default":
37240           description: Response codes found in [response codes](https://wiki.onap.org/).
37241       parameters:
37242         - name: vnf-id
37243           in: path
37244           description: Unique id of VNF.  This is unique across the graph.
37245           required: true
37246           type: string
37247           example: __VNF-ID__
37248         - name: group-uuid
37249           in: path
37250           description: Unique ID for the license group the resource belongs to, should be uuid.
37251           required: true
37252           type: string
37253           example: __GROUP-UUID__
37254         - name: resource-uuid
37255           in: path
37256           description: Unique ID of a license resource.
37257           required: true
37258           type: string
37259           example: __RESOURCE-UUID__
37260         - name: body
37261           in: body
37262           description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLicensesLicense.json)
37263           required: true
37264           schema:
37265             $ref: "#/definitions/license"
37266     patch:
37267       tags:
37268         - Network
37269       summary: update an existing license
37270       description: |
37271         Update an existing license
37272         #
37273         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37274         The PUT operation will entirely replace an existing object.
37275         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
37276         #
37277         Other differences between PUT and PATCH are:
37278         #
37279         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
37280         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37281         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37282       operationId: UpdateNetworkGenericVnfsGenericVnfLicensesLicense
37283       consumes:
37284         - application/json
37285         - application/xml
37286       produces:
37287         - application/json
37288         - application/xml
37289       responses:
37290         "default":
37291           description: Response codes found in [response codes](https://wiki.onap.org/).
37292       parameters:
37293         - name: vnf-id
37294           in: path
37295           description: Unique id of VNF.  This is unique across the graph.
37296           required: true
37297           type: string
37298           example: __VNF-ID__
37299         - name: group-uuid
37300           in: path
37301           description: Unique ID for the license group the resource belongs to, should be uuid.
37302           required: true
37303           type: string
37304           example: __GROUP-UUID__
37305         - name: resource-uuid
37306           in: path
37307           description: Unique ID of a license resource.
37308           required: true
37309           type: string
37310           example: __RESOURCE-UUID__
37311         - name: body
37312           in: body
37313           description: license object that needs to be created or updated.
37314           required: true
37315           schema:
37316             $ref: "#/patchDefinitions/license"
37317     delete:
37318       tags:
37319         - Network
37320       summary: delete an existing license
37321       description: delete an existing license
37322       operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicense
37323       consumes:
37324         - application/json
37325         - application/xml
37326       produces:
37327         - application/json
37328         - application/xml
37329       responses:
37330         "default":
37331           description: Response codes found in [response codes](https://wiki.onap.org/).
37332       parameters:
37333         - name: vnf-id
37334           in: path
37335           description: Unique id of VNF.  This is unique across the graph.
37336           required: true
37337           type: string
37338           example: __VNF-ID__
37339         - name: group-uuid
37340           in: path
37341           description: Unique ID for the license group the resource belongs to, should be uuid.
37342           required: true
37343           type: string
37344           example: __GROUP-UUID__
37345         - name: resource-uuid
37346           in: path
37347           description: Unique ID of a license resource.
37348           required: true
37349           type: string
37350           example: __RESOURCE-UUID__
37351         - name: resource-version
37352           in: query
37353           description: resource-version for concurrency
37354           required: true
37355           type: string
37356   /network/generic-vnfs/generic-vnf/{vnf-id}/licenses:
37357     get:
37358       tags:
37359         - Network
37360       summary: returns licenses
37361       description: returns licenses
37362       operationId: getNetworkGenericVnfsGenericVnfLicenses
37363       produces:
37364         - application/json
37365         - application/xml
37366       responses:
37367         "200":
37368           description: successful operation
37369           schema:
37370               $ref: "#/getDefinitions/licenses"
37371         "default":
37372           description: Response codes found in [response codes](https://wiki.onap.org/).
37373       parameters:
37374         - name: vnf-id
37375           in: path
37376           description: Unique id of VNF.  This is unique across the graph.
37377           required: true
37378           type: string
37379           example: __VNF-ID__
37380         - name: vnf-name
37381           in: query
37382           description: Name of VNF.
37383           required: false
37384           type: string
37385         - name: vnf-name2
37386           in: query
37387           description: Alternate name of VNF.
37388           required: false
37389           type: string
37390         - name: vnf-type
37391           in: query
37392           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
37393           required: false
37394           type: string
37395         - name: service-id
37396           in: query
37397           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
37398           required: false
37399           type: string
37400         - name: regional-resource-zone
37401           in: query
37402           description: Regional way of organizing pservers, source of truth should define values
37403           required: false
37404           type: string
37405         - name: prov-status
37406           in: query
37407           description: Trigger for operational monitoring of this resource by Service Assurance systems.
37408           required: false
37409           type: string
37410         - name: heat-stack-id
37411           in: query
37412           description: Heat stack id corresponding to this instance, managed by MSO
37413           required: false
37414           type: string
37415         - name: in-maint
37416           in: query
37417           required: false
37418           type: boolean
37419         - name: is-closed-loop-disabled
37420           in: query
37421           required: false
37422           type: boolean
37423         - name: persona-model-id
37424           in: query
37425           description: the ASDC model id for this resource or service model.
37426           required: false
37427           type: string
37428         - name: persona-model-version
37429           in: query
37430           description: the ASDC model version for this resource or service model.
37431           required: false
37432           type: string
37433         - name: widget-model-id
37434           in: query
37435           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
37436           required: false
37437           type: string
37438         - name: widget-model-version
37439           in: query
37440           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
37441           required: false
37442           type: string
37443   /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship:
37444     put:
37445       tags:
37446         - Network
37447       summary: see node definition for valid relationships
37448       operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship
37449       consumes:
37450         - application/json
37451         - application/xml
37452       produces:
37453         - application/json
37454         - application/xml
37455       responses:
37456         "default":
37457           description: Response codes found in [response codes](https://wiki.onap.org/).
37458       parameters:
37459         - name: vnf-id
37460           in: path
37461           description: Unique id of VNF.  This is unique across the graph.
37462           required: true
37463           type: string
37464           example: __VNF-ID__
37465         - name: group-uuid
37466           in: path
37467           description: Unique ID for the entitlement group the resource comes from, should be uuid.
37468           required: true
37469           type: string
37470           example: __GROUP-UUID__
37471         - name: resource-uuid
37472           in: path
37473           description: Unique ID of an entitlement resource.
37474           required: true
37475           type: string
37476           example: __RESOURCE-UUID__
37477         - name: body
37478           in: body
37479           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)
37480           required: true
37481           schema:
37482             $ref: "#/definitions/relationship"
37483     delete:
37484       tags:
37485         - Network
37486       summary: delete an existing relationship
37487       description: delete an existing relationship
37488       operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship
37489       consumes:
37490         - application/json
37491         - application/xml
37492       produces:
37493         - application/json
37494         - application/xml
37495       responses:
37496         "default":
37497           description: Response codes found in [response codes](https://wiki.onap.org/).
37498       parameters:
37499         - name: vnf-id
37500           in: path
37501           description: Unique id of VNF.  This is unique across the graph.
37502           required: true
37503           type: string
37504           example: __VNF-ID__
37505         - name: group-uuid
37506           in: path
37507           description: Unique ID for the entitlement group the resource comes from, should be uuid.
37508           required: true
37509           type: string
37510           example: __GROUP-UUID__
37511         - name: resource-uuid
37512           in: path
37513           description: Unique ID of an entitlement resource.
37514           required: true
37515           type: string
37516           example: __RESOURCE-UUID__
37517   /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}:
37518     get:
37519       tags:
37520         - Network
37521       summary: returns entitlement
37522       description: returns entitlement
37523       operationId: getNetworkGenericVnfsGenericVnfEntitlementsEntitlement
37524       produces:
37525         - application/json
37526         - application/xml
37527       responses:
37528         "200":
37529           description: successful operation
37530           schema:
37531               $ref: "#/getDefinitions/entitlement"
37532         "default":
37533           description: Response codes found in [response codes](https://wiki.onap.org/).
37534       parameters:
37535         - name: vnf-id
37536           in: path
37537           description: Unique id of VNF.  This is unique across the graph.
37538           required: true
37539           type: string
37540           example: __VNF-ID__
37541         - name: group-uuid
37542           in: path
37543           description: Unique ID for the entitlement group the resource comes from, should be uuid.
37544           required: true
37545           type: string
37546           example: __GROUP-UUID__
37547         - name: resource-uuid
37548           in: path
37549           description: Unique ID of an entitlement resource.
37550           required: true
37551           type: string
37552           example: __RESOURCE-UUID__
37553         - name: vnf-name
37554           in: query
37555           description: Name of VNF.
37556           required: false
37557           type: string
37558         - name: vnf-name2
37559           in: query
37560           description: Alternate name of VNF.
37561           required: false
37562           type: string
37563         - name: vnf-type
37564           in: query
37565           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
37566           required: false
37567           type: string
37568         - name: service-id
37569           in: query
37570           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
37571           required: false
37572           type: string
37573         - name: regional-resource-zone
37574           in: query
37575           description: Regional way of organizing pservers, source of truth should define values
37576           required: false
37577           type: string
37578         - name: prov-status
37579           in: query
37580           description: Trigger for operational monitoring of this resource by Service Assurance systems.
37581           required: false
37582           type: string
37583         - name: heat-stack-id
37584           in: query
37585           description: Heat stack id corresponding to this instance, managed by MSO
37586           required: false
37587           type: string
37588         - name: in-maint
37589           in: query
37590           required: false
37591           type: boolean
37592         - name: is-closed-loop-disabled
37593           in: query
37594           required: false
37595           type: boolean
37596         - name: persona-model-id
37597           in: query
37598           description: the ASDC model id for this resource or service model.
37599           required: false
37600           type: string
37601         - name: persona-model-version
37602           in: query
37603           description: the ASDC model version for this resource or service model.
37604           required: false
37605           type: string
37606         - name: widget-model-id
37607           in: query
37608           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
37609           required: false
37610           type: string
37611         - name: widget-model-version
37612           in: query
37613           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
37614           required: false
37615           type: string
37616     put:
37617       tags:
37618         - Network
37619       summary: create or update an existing entitlement
37620       description: |
37621         Create or update an existing entitlement.
37622         #
37623         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
37624       operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement
37625       consumes:
37626         - application/json
37627         - application/xml
37628       produces:
37629         - application/json
37630         - application/xml
37631       responses:
37632         "default":
37633           description: Response codes found in [response codes](https://wiki.onap.org/).
37634       parameters:
37635         - name: vnf-id
37636           in: path
37637           description: Unique id of VNF.  This is unique across the graph.
37638           required: true
37639           type: string
37640           example: __VNF-ID__
37641         - name: group-uuid
37642           in: path
37643           description: Unique ID for the entitlement group the resource comes from, should be uuid.
37644           required: true
37645           type: string
37646           example: __GROUP-UUID__
37647         - name: resource-uuid
37648           in: path
37649           description: Unique ID of an entitlement resource.
37650           required: true
37651           type: string
37652           example: __RESOURCE-UUID__
37653         - name: body
37654           in: body
37655           description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)
37656           required: true
37657           schema:
37658             $ref: "#/definitions/entitlement"
37659     patch:
37660       tags:
37661         - Network
37662       summary: update an existing entitlement
37663       description: |
37664         Update an existing entitlement
37665         #
37666         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37667         The PUT operation will entirely replace an existing object.
37668         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
37669         #
37670         Other differences between PUT and PATCH are:
37671         #
37672         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
37673         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37674         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37675       operationId: UpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement
37676       consumes:
37677         - application/json
37678         - application/xml
37679       produces:
37680         - application/json
37681         - application/xml
37682       responses:
37683         "default":
37684           description: Response codes found in [response codes](https://wiki.onap.org/).
37685       parameters:
37686         - name: vnf-id
37687           in: path
37688           description: Unique id of VNF.  This is unique across the graph.
37689           required: true
37690           type: string
37691           example: __VNF-ID__
37692         - name: group-uuid
37693           in: path
37694           description: Unique ID for the entitlement group the resource comes from, should be uuid.
37695           required: true
37696           type: string
37697           example: __GROUP-UUID__
37698         - name: resource-uuid
37699           in: path
37700           description: Unique ID of an entitlement resource.
37701           required: true
37702           type: string
37703           example: __RESOURCE-UUID__
37704         - name: body
37705           in: body
37706           description: entitlement object that needs to be created or updated.
37707           required: true
37708           schema:
37709             $ref: "#/patchDefinitions/entitlement"
37710     delete:
37711       tags:
37712         - Network
37713       summary: delete an existing entitlement
37714       description: delete an existing entitlement
37715       operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlement
37716       consumes:
37717         - application/json
37718         - application/xml
37719       produces:
37720         - application/json
37721         - application/xml
37722       responses:
37723         "default":
37724           description: Response codes found in [response codes](https://wiki.onap.org/).
37725       parameters:
37726         - name: vnf-id
37727           in: path
37728           description: Unique id of VNF.  This is unique across the graph.
37729           required: true
37730           type: string
37731           example: __VNF-ID__
37732         - name: group-uuid
37733           in: path
37734           description: Unique ID for the entitlement group the resource comes from, should be uuid.
37735           required: true
37736           type: string
37737           example: __GROUP-UUID__
37738         - name: resource-uuid
37739           in: path
37740           description: Unique ID of an entitlement resource.
37741           required: true
37742           type: string
37743           example: __RESOURCE-UUID__
37744         - name: resource-version
37745           in: query
37746           description: resource-version for concurrency
37747           required: true
37748           type: string
37749   /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements:
37750     get:
37751       tags:
37752         - Network
37753       summary: returns entitlements
37754       description: returns entitlements
37755       operationId: getNetworkGenericVnfsGenericVnfEntitlements
37756       produces:
37757         - application/json
37758         - application/xml
37759       responses:
37760         "200":
37761           description: successful operation
37762           schema:
37763               $ref: "#/getDefinitions/entitlements"
37764         "default":
37765           description: Response codes found in [response codes](https://wiki.onap.org/).
37766       parameters:
37767         - name: vnf-id
37768           in: path
37769           description: Unique id of VNF.  This is unique across the graph.
37770           required: true
37771           type: string
37772           example: __VNF-ID__
37773         - name: vnf-name
37774           in: query
37775           description: Name of VNF.
37776           required: false
37777           type: string
37778         - name: vnf-name2
37779           in: query
37780           description: Alternate name of VNF.
37781           required: false
37782           type: string
37783         - name: vnf-type
37784           in: query
37785           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
37786           required: false
37787           type: string
37788         - name: service-id
37789           in: query
37790           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
37791           required: false
37792           type: string
37793         - name: regional-resource-zone
37794           in: query
37795           description: Regional way of organizing pservers, source of truth should define values
37796           required: false
37797           type: string
37798         - name: prov-status
37799           in: query
37800           description: Trigger for operational monitoring of this resource by Service Assurance systems.
37801           required: false
37802           type: string
37803         - name: heat-stack-id
37804           in: query
37805           description: Heat stack id corresponding to this instance, managed by MSO
37806           required: false
37807           type: string
37808         - name: in-maint
37809           in: query
37810           required: false
37811           type: boolean
37812         - name: is-closed-loop-disabled
37813           in: query
37814           required: false
37815           type: boolean
37816         - name: persona-model-id
37817           in: query
37818           description: the ASDC model id for this resource or service model.
37819           required: false
37820           type: string
37821         - name: persona-model-version
37822           in: query
37823           description: the ASDC model version for this resource or service model.
37824           required: false
37825           type: string
37826         - name: widget-model-id
37827           in: query
37828           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
37829           required: false
37830           type: string
37831         - name: widget-model-version
37832           in: query
37833           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
37834           required: false
37835           type: string
37836   /network/generic-vnfs/generic-vnf/{vnf-id}:
37837     get:
37838       tags:
37839         - Network
37840       summary: returns generic-vnf
37841       description: returns generic-vnf
37842       operationId: getNetworkGenericVnfsGenericVnf
37843       produces:
37844         - application/json
37845         - application/xml
37846       responses:
37847         "200":
37848           description: successful operation
37849           schema:
37850               $ref: "#/getDefinitions/generic-vnf"
37851         "default":
37852           description: Response codes found in [response codes](https://wiki.onap.org/).
37853       parameters:
37854         - name: vnf-id
37855           in: path
37856           description: Unique id of VNF.  This is unique across the graph.
37857           required: true
37858           type: string
37859           example: __VNF-ID__
37860         - name: vnf-name
37861           in: query
37862           description: Name of VNF.
37863           required: false
37864           type: string
37865         - name: vnf-name2
37866           in: query
37867           description: Alternate name of VNF.
37868           required: false
37869           type: string
37870         - name: vnf-type
37871           in: query
37872           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
37873           required: false
37874           type: string
37875         - name: service-id
37876           in: query
37877           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
37878           required: false
37879           type: string
37880         - name: regional-resource-zone
37881           in: query
37882           description: Regional way of organizing pservers, source of truth should define values
37883           required: false
37884           type: string
37885         - name: prov-status
37886           in: query
37887           description: Trigger for operational monitoring of this resource by Service Assurance systems.
37888           required: false
37889           type: string
37890         - name: heat-stack-id
37891           in: query
37892           description: Heat stack id corresponding to this instance, managed by MSO
37893           required: false
37894           type: string
37895         - name: in-maint
37896           in: query
37897           required: false
37898           type: boolean
37899         - name: is-closed-loop-disabled
37900           in: query
37901           required: false
37902           type: boolean
37903         - name: persona-model-id
37904           in: query
37905           description: the ASDC model id for this resource or service model.
37906           required: false
37907           type: string
37908         - name: persona-model-version
37909           in: query
37910           description: the ASDC model version for this resource or service model.
37911           required: false
37912           type: string
37913         - name: widget-model-id
37914           in: query
37915           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
37916           required: false
37917           type: string
37918         - name: widget-model-version
37919           in: query
37920           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
37921           required: false
37922           type: string
37923     put:
37924       tags:
37925         - Network
37926       summary: create or update an existing generic-vnf
37927       description: |
37928         Create or update an existing generic-vnf.
37929         #
37930         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
37931       operationId: createOrUpdateNetworkGenericVnfsGenericVnf
37932       consumes:
37933         - application/json
37934         - application/xml
37935       produces:
37936         - application/json
37937         - application/xml
37938       responses:
37939         "default":
37940           description: Response codes found in [response codes](https://wiki.onap.org/).
37941       parameters:
37942         - name: vnf-id
37943           in: path
37944           description: Unique id of VNF.  This is unique across the graph.
37945           required: true
37946           type: string
37947           example: __VNF-ID__
37948         - name: body
37949           in: body
37950           description: generic-vnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnf.json)
37951           required: true
37952           schema:
37953             $ref: "#/definitions/generic-vnf"
37954     patch:
37955       tags:
37956         - Network
37957       summary: update an existing generic-vnf
37958       description: |
37959         Update an existing generic-vnf
37960         #
37961         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37962         The PUT operation will entirely replace an existing object.
37963         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
37964         #
37965         Other differences between PUT and PATCH are:
37966         #
37967         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
37968         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37969         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37970       operationId: UpdateNetworkGenericVnfsGenericVnf
37971       consumes:
37972         - application/json
37973         - application/xml
37974       produces:
37975         - application/json
37976         - application/xml
37977       responses:
37978         "default":
37979           description: Response codes found in [response codes](https://wiki.onap.org/).
37980       parameters:
37981         - name: vnf-id
37982           in: path
37983           description: Unique id of VNF.  This is unique across the graph.
37984           required: true
37985           type: string
37986           example: __VNF-ID__
37987         - name: body
37988           in: body
37989           description: generic-vnf object that needs to be created or updated.
37990           required: true
37991           schema:
37992             $ref: "#/patchDefinitions/generic-vnf"
37993     delete:
37994       tags:
37995         - Network
37996       summary: delete an existing generic-vnf
37997       description: delete an existing generic-vnf
37998       operationId: deleteNetworkGenericVnfsGenericVnf
37999       consumes:
38000         - application/json
38001         - application/xml
38002       produces:
38003         - application/json
38004         - application/xml
38005       responses:
38006         "default":
38007           description: Response codes found in [response codes](https://wiki.onap.org/).
38008       parameters:
38009         - name: vnf-id
38010           in: path
38011           description: Unique id of VNF.  This is unique across the graph.
38012           required: true
38013           type: string
38014           example: __VNF-ID__
38015         - name: resource-version
38016           in: query
38017           description: resource-version for concurrency
38018           required: true
38019           type: string
38020   /network/generic-vnfs:
38021     get:
38022       tags:
38023         - Network
38024       summary: returns generic-vnfs
38025       description: returns generic-vnfs
38026       operationId: getNetworkGenericVnfs
38027       produces:
38028         - application/json
38029         - application/xml
38030       responses:
38031         "200":
38032           description: successful operation
38033           schema:
38034               $ref: "#/getDefinitions/generic-vnfs"
38035         "default":
38036           description: Response codes found in [response codes](https://wiki.onap.org/).
38037   /network/lag-links/lag-link/{link-name}/relationship-list/relationship:
38038     put:
38039       tags:
38040         - Network
38041       summary: see node definition for valid relationships
38042       operationId: createOrUpdateNetworkLagLinksLagLinkRelationshipListRelationship
38043       consumes:
38044         - application/json
38045         - application/xml
38046       produces:
38047         - application/json
38048         - application/xml
38049       responses:
38050         "default":
38051           description: Response codes found in [response codes](https://wiki.onap.org/).
38052       parameters:
38053         - name: link-name
38054           in: path
38055           description: Alphabetical concatenation of lag-interface names
38056           required: true
38057           type: string
38058           example: __LINK-NAME__
38059         - name: body
38060           in: body
38061           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkLagLinksLagLink.json)
38062           required: true
38063           schema:
38064             $ref: "#/definitions/relationship"
38065     delete:
38066       tags:
38067         - Network
38068       summary: delete an existing relationship
38069       description: delete an existing relationship
38070       operationId: deleteNetworkLagLinksLagLinkRelationshipListRelationship
38071       consumes:
38072         - application/json
38073         - application/xml
38074       produces:
38075         - application/json
38076         - application/xml
38077       responses:
38078         "default":
38079           description: Response codes found in [response codes](https://wiki.onap.org/).
38080       parameters:
38081         - name: link-name
38082           in: path
38083           description: Alphabetical concatenation of lag-interface names
38084           required: true
38085           type: string
38086           example: __LINK-NAME__
38087   /network/lag-links/lag-link/{link-name}:
38088     get:
38089       tags:
38090         - Network
38091       summary: returns lag-link
38092       description: returns lag-link
38093       operationId: getNetworkLagLinksLagLink
38094       produces:
38095         - application/json
38096         - application/xml
38097       responses:
38098         "200":
38099           description: successful operation
38100           schema:
38101               $ref: "#/getDefinitions/lag-link"
38102         "default":
38103           description: Response codes found in [response codes](https://wiki.onap.org/).
38104       parameters:
38105         - name: link-name
38106           in: path
38107           description: Alphabetical concatenation of lag-interface names
38108           required: true
38109           type: string
38110           example: __LINK-NAME__
38111     put:
38112       tags:
38113         - Network
38114       summary: create or update an existing lag-link
38115       description: |
38116         Create or update an existing lag-link.
38117         #
38118         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
38119       operationId: createOrUpdateNetworkLagLinksLagLink
38120       consumes:
38121         - application/json
38122         - application/xml
38123       produces:
38124         - application/json
38125         - application/xml
38126       responses:
38127         "default":
38128           description: Response codes found in [response codes](https://wiki.onap.org/).
38129       parameters:
38130         - name: link-name
38131           in: path
38132           description: Alphabetical concatenation of lag-interface names
38133           required: true
38134           type: string
38135           example: __LINK-NAME__
38136         - name: body
38137           in: body
38138           description: lag-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkLagLinksLagLink.json)
38139           required: true
38140           schema:
38141             $ref: "#/definitions/lag-link"
38142     patch:
38143       tags:
38144         - Network
38145       summary: update an existing lag-link
38146       description: |
38147         Update an existing lag-link
38148         #
38149         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38150         The PUT operation will entirely replace an existing object.
38151         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
38152         #
38153         Other differences between PUT and PATCH are:
38154         #
38155         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
38156         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38157         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38158       operationId: UpdateNetworkLagLinksLagLink
38159       consumes:
38160         - application/json
38161         - application/xml
38162       produces:
38163         - application/json
38164         - application/xml
38165       responses:
38166         "default":
38167           description: Response codes found in [response codes](https://wiki.onap.org/).
38168       parameters:
38169         - name: link-name
38170           in: path
38171           description: Alphabetical concatenation of lag-interface names
38172           required: true
38173           type: string
38174           example: __LINK-NAME__
38175         - name: body
38176           in: body
38177           description: lag-link object that needs to be created or updated.
38178           required: true
38179           schema:
38180             $ref: "#/patchDefinitions/lag-link"
38181     delete:
38182       tags:
38183         - Network
38184       summary: delete an existing lag-link
38185       description: delete an existing lag-link
38186       operationId: deleteNetworkLagLinksLagLink
38187       consumes:
38188         - application/json
38189         - application/xml
38190       produces:
38191         - application/json
38192         - application/xml
38193       responses:
38194         "default":
38195           description: Response codes found in [response codes](https://wiki.onap.org/).
38196       parameters:
38197         - name: link-name
38198           in: path
38199           description: Alphabetical concatenation of lag-interface names
38200           required: true
38201           type: string
38202           example: __LINK-NAME__
38203         - name: resource-version
38204           in: query
38205           description: resource-version for concurrency
38206           required: true
38207           type: string
38208   /network/lag-links:
38209     get:
38210       tags:
38211         - Network
38212       summary: returns lag-links
38213       description: returns lag-links
38214       operationId: getNetworkLagLinks
38215       produces:
38216         - application/json
38217         - application/xml
38218       responses:
38219         "200":
38220           description: successful operation
38221           schema:
38222               $ref: "#/getDefinitions/lag-links"
38223         "default":
38224           description: Response codes found in [response codes](https://wiki.onap.org/).
38225   /network/newvces/newvce/{vnf-id2}/relationship-list/relationship:
38226     put:
38227       tags:
38228         - Network
38229       summary: see node definition for valid relationships
38230       operationId: createOrUpdateNetworkNewvcesNewvceRelationshipListRelationship
38231       consumes:
38232         - application/json
38233         - application/xml
38234       produces:
38235         - application/json
38236         - application/xml
38237       responses:
38238         "default":
38239           description: Response codes found in [response codes](https://wiki.onap.org/).
38240       parameters:
38241         - name: vnf-id2
38242           in: path
38243           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38244           required: true
38245           type: string
38246           example: __VNF-ID2__
38247         - name: body
38248           in: body
38249           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvce.json)
38250           required: true
38251           schema:
38252             $ref: "#/definitions/relationship"
38253     delete:
38254       tags:
38255         - Network
38256       summary: delete an existing relationship
38257       description: delete an existing relationship
38258       operationId: deleteNetworkNewvcesNewvceRelationshipListRelationship
38259       consumes:
38260         - application/json
38261         - application/xml
38262       produces:
38263         - application/json
38264         - application/xml
38265       responses:
38266         "default":
38267           description: Response codes found in [response codes](https://wiki.onap.org/).
38268       parameters:
38269         - name: vnf-id2
38270           in: path
38271           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38272           required: true
38273           type: string
38274           example: __VNF-ID2__
38275   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
38276     put:
38277       tags:
38278         - Network
38279       summary: see node definition for valid relationships
38280       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
38281       consumes:
38282         - application/json
38283         - application/xml
38284       produces:
38285         - application/json
38286         - application/xml
38287       responses:
38288         "default":
38289           description: Response codes found in [response codes](https://wiki.onap.org/).
38290       parameters:
38291         - name: vnf-id2
38292           in: path
38293           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38294           required: true
38295           type: string
38296           example: __VNF-ID2__
38297         - name: interface-name
38298           in: path
38299           description: Name given to the interface
38300           required: true
38301           type: string
38302           example: __INTERFACE-NAME__
38303         - name: vlan-interface
38304           in: path
38305           description: String that identifies the interface
38306           required: true
38307           type: string
38308           example: __VLAN-INTERFACE__
38309         - name: body
38310           in: body
38311           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
38312           required: true
38313           schema:
38314             $ref: "#/definitions/relationship"
38315     delete:
38316       tags:
38317         - Network
38318       summary: delete an existing relationship
38319       description: delete an existing relationship
38320       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
38321       consumes:
38322         - application/json
38323         - application/xml
38324       produces:
38325         - application/json
38326         - application/xml
38327       responses:
38328         "default":
38329           description: Response codes found in [response codes](https://wiki.onap.org/).
38330       parameters:
38331         - name: vnf-id2
38332           in: path
38333           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38334           required: true
38335           type: string
38336           example: __VNF-ID2__
38337         - name: interface-name
38338           in: path
38339           description: Name given to the interface
38340           required: true
38341           type: string
38342           example: __INTERFACE-NAME__
38343         - name: vlan-interface
38344           in: path
38345           description: String that identifies the interface
38346           required: true
38347           type: string
38348           example: __VLAN-INTERFACE__
38349   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
38350     put:
38351       tags:
38352         - Network
38353       summary: see node definition for valid relationships
38354       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
38355       consumes:
38356         - application/json
38357         - application/xml
38358       produces:
38359         - application/json
38360         - application/xml
38361       responses:
38362         "default":
38363           description: Response codes found in [response codes](https://wiki.onap.org/).
38364       parameters:
38365         - name: vnf-id2
38366           in: path
38367           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38368           required: true
38369           type: string
38370           example: __VNF-ID2__
38371         - name: interface-name
38372           in: path
38373           description: Name given to the interface
38374           required: true
38375           type: string
38376           example: __INTERFACE-NAME__
38377         - name: vlan-interface
38378           in: path
38379           description: String that identifies the interface
38380           required: true
38381           type: string
38382           example: __VLAN-INTERFACE__
38383         - name: l3-interface-ipv4-address
38384           in: path
38385           description: IP address
38386           required: true
38387           type: string
38388           example: __L3-INTERFACE-IPV4-ADDRESS__
38389         - name: body
38390           in: body
38391           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
38392           required: true
38393           schema:
38394             $ref: "#/definitions/relationship"
38395     delete:
38396       tags:
38397         - Network
38398       summary: delete an existing relationship
38399       description: delete an existing relationship
38400       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
38401       consumes:
38402         - application/json
38403         - application/xml
38404       produces:
38405         - application/json
38406         - application/xml
38407       responses:
38408         "default":
38409           description: Response codes found in [response codes](https://wiki.onap.org/).
38410       parameters:
38411         - name: vnf-id2
38412           in: path
38413           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38414           required: true
38415           type: string
38416           example: __VNF-ID2__
38417         - name: interface-name
38418           in: path
38419           description: Name given to the interface
38420           required: true
38421           type: string
38422           example: __INTERFACE-NAME__
38423         - name: vlan-interface
38424           in: path
38425           description: String that identifies the interface
38426           required: true
38427           type: string
38428           example: __VLAN-INTERFACE__
38429         - name: l3-interface-ipv4-address
38430           in: path
38431           description: IP address
38432           required: true
38433           type: string
38434           example: __L3-INTERFACE-IPV4-ADDRESS__
38435   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
38436     get:
38437       tags:
38438         - Network
38439       summary: returns l3-interface-ipv4-address-list
38440       description: returns l3-interface-ipv4-address-list
38441       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
38442       produces:
38443         - application/json
38444         - application/xml
38445       responses:
38446         "200":
38447           description: successful operation
38448           schema:
38449               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
38450         "default":
38451           description: Response codes found in [response codes](https://wiki.onap.org/).
38452       parameters:
38453         - name: vnf-id2
38454           in: path
38455           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38456           required: true
38457           type: string
38458           example: __VNF-ID2__
38459         - name: interface-name
38460           in: path
38461           description: Name given to the interface
38462           required: true
38463           type: string
38464           example: __INTERFACE-NAME__
38465         - name: vlan-interface
38466           in: path
38467           description: String that identifies the interface
38468           required: true
38469           type: string
38470           example: __VLAN-INTERFACE__
38471         - name: l3-interface-ipv4-address
38472           in: path
38473           description: IP address
38474           required: true
38475           type: string
38476           example: __L3-INTERFACE-IPV4-ADDRESS__
38477         - name: vnf-name
38478           in: query
38479           description: Name of VNF.
38480           required: false
38481           type: string
38482         - name: vnf-name2
38483           in: query
38484           description: Alternate name of VNF.
38485           required: false
38486           type: string
38487         - name: vnf-type
38488           in: query
38489           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
38490           required: false
38491           type: string
38492         - name: prov-status
38493           in: query
38494           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
38495           required: false
38496           type: string
38497         - name: heat-stack-id
38498           in: query
38499           description: Heat stack id corresponding to this instance, managed by MSO
38500           required: false
38501           type: string
38502         - name: interface-id
38503           in: query
38504           description: ID of interface
38505           required: false
38506           type: string
38507         - name: macaddr
38508           in: query
38509           description: MAC address for the interface
38510           required: false
38511           type: string
38512         - name: network-name
38513           in: query
38514           description: Name of the network
38515           required: false
38516           type: string
38517         - name: vlan-id-inner
38518           in: query
38519           description: Inner VLAN tag
38520           required: false
38521           type: integer
38522           format: int64
38523         - name: vpn-id
38524           in: query
38525           description: This indicates the customers VPN ID associated with this vlan
38526           required: false
38527           type: string
38528         - name: vlan-id-inner
38529           in: query
38530           description: Inner VLAN tag
38531           required: false
38532           type: integer
38533           format: int64
38534         - name: neutron-network-id
38535           in: query
38536           description: Neutron network id of the interface that address belongs to
38537           required: false
38538           type: string
38539         - name: neutron-subnet-id
38540           in: query
38541           description: Neutron id of subnet that address belongs to
38542           required: false
38543           type: string
38544     put:
38545       tags:
38546         - Network
38547       summary: create or update an existing l3-interface-ipv4-address-list
38548       description: |
38549         Create or update an existing l3-interface-ipv4-address-list.
38550         #
38551         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
38552       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
38553       consumes:
38554         - application/json
38555         - application/xml
38556       produces:
38557         - application/json
38558         - application/xml
38559       responses:
38560         "default":
38561           description: Response codes found in [response codes](https://wiki.onap.org/).
38562       parameters:
38563         - name: vnf-id2
38564           in: path
38565           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38566           required: true
38567           type: string
38568           example: __VNF-ID2__
38569         - name: interface-name
38570           in: path
38571           description: Name given to the interface
38572           required: true
38573           type: string
38574           example: __INTERFACE-NAME__
38575         - name: vlan-interface
38576           in: path
38577           description: String that identifies the interface
38578           required: true
38579           type: string
38580           example: __VLAN-INTERFACE__
38581         - name: l3-interface-ipv4-address
38582           in: path
38583           description: IP address
38584           required: true
38585           type: string
38586           example: __L3-INTERFACE-IPV4-ADDRESS__
38587         - name: body
38588           in: body
38589           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
38590           required: true
38591           schema:
38592             $ref: "#/definitions/l3-interface-ipv4-address-list"
38593     patch:
38594       tags:
38595         - Network
38596       summary: update an existing l3-interface-ipv4-address-list
38597       description: |
38598         Update an existing l3-interface-ipv4-address-list
38599         #
38600         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38601         The PUT operation will entirely replace an existing object.
38602         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
38603         #
38604         Other differences between PUT and PATCH are:
38605         #
38606         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
38607         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38608         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38609       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
38610       consumes:
38611         - application/json
38612         - application/xml
38613       produces:
38614         - application/json
38615         - application/xml
38616       responses:
38617         "default":
38618           description: Response codes found in [response codes](https://wiki.onap.org/).
38619       parameters:
38620         - name: vnf-id2
38621           in: path
38622           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38623           required: true
38624           type: string
38625           example: __VNF-ID2__
38626         - name: interface-name
38627           in: path
38628           description: Name given to the interface
38629           required: true
38630           type: string
38631           example: __INTERFACE-NAME__
38632         - name: vlan-interface
38633           in: path
38634           description: String that identifies the interface
38635           required: true
38636           type: string
38637           example: __VLAN-INTERFACE__
38638         - name: l3-interface-ipv4-address
38639           in: path
38640           description: IP address
38641           required: true
38642           type: string
38643           example: __L3-INTERFACE-IPV4-ADDRESS__
38644         - name: body
38645           in: body
38646           description: l3-interface-ipv4-address-list object that needs to be created or updated.
38647           required: true
38648           schema:
38649             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
38650     delete:
38651       tags:
38652         - Network
38653       summary: delete an existing l3-interface-ipv4-address-list
38654       description: delete an existing l3-interface-ipv4-address-list
38655       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
38656       consumes:
38657         - application/json
38658         - application/xml
38659       produces:
38660         - application/json
38661         - application/xml
38662       responses:
38663         "default":
38664           description: Response codes found in [response codes](https://wiki.onap.org/).
38665       parameters:
38666         - name: vnf-id2
38667           in: path
38668           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38669           required: true
38670           type: string
38671           example: __VNF-ID2__
38672         - name: interface-name
38673           in: path
38674           description: Name given to the interface
38675           required: true
38676           type: string
38677           example: __INTERFACE-NAME__
38678         - name: vlan-interface
38679           in: path
38680           description: String that identifies the interface
38681           required: true
38682           type: string
38683           example: __VLAN-INTERFACE__
38684         - name: l3-interface-ipv4-address
38685           in: path
38686           description: IP address
38687           required: true
38688           type: string
38689           example: __L3-INTERFACE-IPV4-ADDRESS__
38690         - name: resource-version
38691           in: query
38692           description: resource-version for concurrency
38693           required: true
38694           type: string
38695   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
38696     put:
38697       tags:
38698         - Network
38699       summary: see node definition for valid relationships
38700       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
38701       consumes:
38702         - application/json
38703         - application/xml
38704       produces:
38705         - application/json
38706         - application/xml
38707       responses:
38708         "default":
38709           description: Response codes found in [response codes](https://wiki.onap.org/).
38710       parameters:
38711         - name: vnf-id2
38712           in: path
38713           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38714           required: true
38715           type: string
38716           example: __VNF-ID2__
38717         - name: interface-name
38718           in: path
38719           description: Name given to the interface
38720           required: true
38721           type: string
38722           example: __INTERFACE-NAME__
38723         - name: vlan-interface
38724           in: path
38725           description: String that identifies the interface
38726           required: true
38727           type: string
38728           example: __VLAN-INTERFACE__
38729         - name: l3-interface-ipv6-address
38730           in: path
38731           description: IP address
38732           required: true
38733           type: string
38734           example: __L3-INTERFACE-IPV6-ADDRESS__
38735         - name: body
38736           in: body
38737           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
38738           required: true
38739           schema:
38740             $ref: "#/definitions/relationship"
38741     delete:
38742       tags:
38743         - Network
38744       summary: delete an existing relationship
38745       description: delete an existing relationship
38746       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
38747       consumes:
38748         - application/json
38749         - application/xml
38750       produces:
38751         - application/json
38752         - application/xml
38753       responses:
38754         "default":
38755           description: Response codes found in [response codes](https://wiki.onap.org/).
38756       parameters:
38757         - name: vnf-id2
38758           in: path
38759           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38760           required: true
38761           type: string
38762           example: __VNF-ID2__
38763         - name: interface-name
38764           in: path
38765           description: Name given to the interface
38766           required: true
38767           type: string
38768           example: __INTERFACE-NAME__
38769         - name: vlan-interface
38770           in: path
38771           description: String that identifies the interface
38772           required: true
38773           type: string
38774           example: __VLAN-INTERFACE__
38775         - name: l3-interface-ipv6-address
38776           in: path
38777           description: IP address
38778           required: true
38779           type: string
38780           example: __L3-INTERFACE-IPV6-ADDRESS__
38781   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
38782     get:
38783       tags:
38784         - Network
38785       summary: returns l3-interface-ipv6-address-list
38786       description: returns l3-interface-ipv6-address-list
38787       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
38788       produces:
38789         - application/json
38790         - application/xml
38791       responses:
38792         "200":
38793           description: successful operation
38794           schema:
38795               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
38796         "default":
38797           description: Response codes found in [response codes](https://wiki.onap.org/).
38798       parameters:
38799         - name: vnf-id2
38800           in: path
38801           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38802           required: true
38803           type: string
38804           example: __VNF-ID2__
38805         - name: interface-name
38806           in: path
38807           description: Name given to the interface
38808           required: true
38809           type: string
38810           example: __INTERFACE-NAME__
38811         - name: vlan-interface
38812           in: path
38813           description: String that identifies the interface
38814           required: true
38815           type: string
38816           example: __VLAN-INTERFACE__
38817         - name: l3-interface-ipv6-address
38818           in: path
38819           description: IP address
38820           required: true
38821           type: string
38822           example: __L3-INTERFACE-IPV6-ADDRESS__
38823         - name: vnf-name
38824           in: query
38825           description: Name of VNF.
38826           required: false
38827           type: string
38828         - name: vnf-name2
38829           in: query
38830           description: Alternate name of VNF.
38831           required: false
38832           type: string
38833         - name: vnf-type
38834           in: query
38835           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
38836           required: false
38837           type: string
38838         - name: prov-status
38839           in: query
38840           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
38841           required: false
38842           type: string
38843         - name: heat-stack-id
38844           in: query
38845           description: Heat stack id corresponding to this instance, managed by MSO
38846           required: false
38847           type: string
38848         - name: interface-id
38849           in: query
38850           description: ID of interface
38851           required: false
38852           type: string
38853         - name: macaddr
38854           in: query
38855           description: MAC address for the interface
38856           required: false
38857           type: string
38858         - name: network-name
38859           in: query
38860           description: Name of the network
38861           required: false
38862           type: string
38863         - name: vlan-id-inner
38864           in: query
38865           description: Inner VLAN tag
38866           required: false
38867           type: integer
38868           format: int64
38869         - name: vpn-id
38870           in: query
38871           description: This indicates the customers VPN ID associated with this vlan
38872           required: false
38873           type: string
38874         - name: vlan-id-inner
38875           in: query
38876           description: Inner VLAN tag
38877           required: false
38878           type: integer
38879           format: int64
38880         - name: neutron-network-id
38881           in: query
38882           description: Neutron network id of the interface that address belongs to
38883           required: false
38884           type: string
38885         - name: neutron-subnet-id
38886           in: query
38887           description: Neutron id of subnet that address belongs to
38888           required: false
38889           type: string
38890     put:
38891       tags:
38892         - Network
38893       summary: create or update an existing l3-interface-ipv6-address-list
38894       description: |
38895         Create or update an existing l3-interface-ipv6-address-list.
38896         #
38897         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
38898       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
38899       consumes:
38900         - application/json
38901         - application/xml
38902       produces:
38903         - application/json
38904         - application/xml
38905       responses:
38906         "default":
38907           description: Response codes found in [response codes](https://wiki.onap.org/).
38908       parameters:
38909         - name: vnf-id2
38910           in: path
38911           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38912           required: true
38913           type: string
38914           example: __VNF-ID2__
38915         - name: interface-name
38916           in: path
38917           description: Name given to the interface
38918           required: true
38919           type: string
38920           example: __INTERFACE-NAME__
38921         - name: vlan-interface
38922           in: path
38923           description: String that identifies the interface
38924           required: true
38925           type: string
38926           example: __VLAN-INTERFACE__
38927         - name: l3-interface-ipv6-address
38928           in: path
38929           description: IP address
38930           required: true
38931           type: string
38932           example: __L3-INTERFACE-IPV6-ADDRESS__
38933         - name: body
38934           in: body
38935           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
38936           required: true
38937           schema:
38938             $ref: "#/definitions/l3-interface-ipv6-address-list"
38939     patch:
38940       tags:
38941         - Network
38942       summary: update an existing l3-interface-ipv6-address-list
38943       description: |
38944         Update an existing l3-interface-ipv6-address-list
38945         #
38946         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38947         The PUT operation will entirely replace an existing object.
38948         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
38949         #
38950         Other differences between PUT and PATCH are:
38951         #
38952         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
38953         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38954         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38955       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
38956       consumes:
38957         - application/json
38958         - application/xml
38959       produces:
38960         - application/json
38961         - application/xml
38962       responses:
38963         "default":
38964           description: Response codes found in [response codes](https://wiki.onap.org/).
38965       parameters:
38966         - name: vnf-id2
38967           in: path
38968           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38969           required: true
38970           type: string
38971           example: __VNF-ID2__
38972         - name: interface-name
38973           in: path
38974           description: Name given to the interface
38975           required: true
38976           type: string
38977           example: __INTERFACE-NAME__
38978         - name: vlan-interface
38979           in: path
38980           description: String that identifies the interface
38981           required: true
38982           type: string
38983           example: __VLAN-INTERFACE__
38984         - name: l3-interface-ipv6-address
38985           in: path
38986           description: IP address
38987           required: true
38988           type: string
38989           example: __L3-INTERFACE-IPV6-ADDRESS__
38990         - name: body
38991           in: body
38992           description: l3-interface-ipv6-address-list object that needs to be created or updated.
38993           required: true
38994           schema:
38995             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
38996     delete:
38997       tags:
38998         - Network
38999       summary: delete an existing l3-interface-ipv6-address-list
39000       description: delete an existing l3-interface-ipv6-address-list
39001       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
39002       consumes:
39003         - application/json
39004         - application/xml
39005       produces:
39006         - application/json
39007         - application/xml
39008       responses:
39009         "default":
39010           description: Response codes found in [response codes](https://wiki.onap.org/).
39011       parameters:
39012         - name: vnf-id2
39013           in: path
39014           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39015           required: true
39016           type: string
39017           example: __VNF-ID2__
39018         - name: interface-name
39019           in: path
39020           description: Name given to the interface
39021           required: true
39022           type: string
39023           example: __INTERFACE-NAME__
39024         - name: vlan-interface
39025           in: path
39026           description: String that identifies the interface
39027           required: true
39028           type: string
39029           example: __VLAN-INTERFACE__
39030         - name: l3-interface-ipv6-address
39031           in: path
39032           description: IP address
39033           required: true
39034           type: string
39035           example: __L3-INTERFACE-IPV6-ADDRESS__
39036         - name: resource-version
39037           in: query
39038           description: resource-version for concurrency
39039           required: true
39040           type: string
39041   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
39042     get:
39043       tags:
39044         - Network
39045       summary: returns vlan
39046       description: returns vlan
39047       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
39048       produces:
39049         - application/json
39050         - application/xml
39051       responses:
39052         "200":
39053           description: successful operation
39054           schema:
39055               $ref: "#/getDefinitions/vlan"
39056         "default":
39057           description: Response codes found in [response codes](https://wiki.onap.org/).
39058       parameters:
39059         - name: vnf-id2
39060           in: path
39061           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39062           required: true
39063           type: string
39064           example: __VNF-ID2__
39065         - name: interface-name
39066           in: path
39067           description: Name given to the interface
39068           required: true
39069           type: string
39070           example: __INTERFACE-NAME__
39071         - name: vlan-interface
39072           in: path
39073           description: String that identifies the interface
39074           required: true
39075           type: string
39076           example: __VLAN-INTERFACE__
39077         - name: vnf-name
39078           in: query
39079           description: Name of VNF.
39080           required: false
39081           type: string
39082         - name: vnf-name2
39083           in: query
39084           description: Alternate name of VNF.
39085           required: false
39086           type: string
39087         - name: vnf-type
39088           in: query
39089           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
39090           required: false
39091           type: string
39092         - name: prov-status
39093           in: query
39094           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
39095           required: false
39096           type: string
39097         - name: heat-stack-id
39098           in: query
39099           description: Heat stack id corresponding to this instance, managed by MSO
39100           required: false
39101           type: string
39102         - name: interface-id
39103           in: query
39104           description: ID of interface
39105           required: false
39106           type: string
39107         - name: macaddr
39108           in: query
39109           description: MAC address for the interface
39110           required: false
39111           type: string
39112         - name: network-name
39113           in: query
39114           description: Name of the network
39115           required: false
39116           type: string
39117         - name: vlan-id-inner
39118           in: query
39119           description: Inner VLAN tag
39120           required: false
39121           type: integer
39122           format: int64
39123         - name: vpn-id
39124           in: query
39125           description: This indicates the customers VPN ID associated with this vlan
39126           required: false
39127           type: string
39128     put:
39129       tags:
39130         - Network
39131       summary: create or update an existing vlan
39132       description: |
39133         Create or update an existing vlan.
39134         #
39135         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
39136       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
39137       consumes:
39138         - application/json
39139         - application/xml
39140       produces:
39141         - application/json
39142         - application/xml
39143       responses:
39144         "default":
39145           description: Response codes found in [response codes](https://wiki.onap.org/).
39146       parameters:
39147         - name: vnf-id2
39148           in: path
39149           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39150           required: true
39151           type: string
39152           example: __VNF-ID2__
39153         - name: interface-name
39154           in: path
39155           description: Name given to the interface
39156           required: true
39157           type: string
39158           example: __INTERFACE-NAME__
39159         - name: vlan-interface
39160           in: path
39161           description: String that identifies the interface
39162           required: true
39163           type: string
39164           example: __VLAN-INTERFACE__
39165         - name: body
39166           in: body
39167           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
39168           required: true
39169           schema:
39170             $ref: "#/definitions/vlan"
39171     patch:
39172       tags:
39173         - Network
39174       summary: update an existing vlan
39175       description: |
39176         Update an existing vlan
39177         #
39178         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39179         The PUT operation will entirely replace an existing object.
39180         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
39181         #
39182         Other differences between PUT and PATCH are:
39183         #
39184         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
39185         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39186         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39187       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
39188       consumes:
39189         - application/json
39190         - application/xml
39191       produces:
39192         - application/json
39193         - application/xml
39194       responses:
39195         "default":
39196           description: Response codes found in [response codes](https://wiki.onap.org/).
39197       parameters:
39198         - name: vnf-id2
39199           in: path
39200           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39201           required: true
39202           type: string
39203           example: __VNF-ID2__
39204         - name: interface-name
39205           in: path
39206           description: Name given to the interface
39207           required: true
39208           type: string
39209           example: __INTERFACE-NAME__
39210         - name: vlan-interface
39211           in: path
39212           description: String that identifies the interface
39213           required: true
39214           type: string
39215           example: __VLAN-INTERFACE__
39216         - name: body
39217           in: body
39218           description: vlan object that needs to be created or updated.
39219           required: true
39220           schema:
39221             $ref: "#/patchDefinitions/vlan"
39222     delete:
39223       tags:
39224         - Network
39225       summary: delete an existing vlan
39226       description: delete an existing vlan
39227       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
39228       consumes:
39229         - application/json
39230         - application/xml
39231       produces:
39232         - application/json
39233         - application/xml
39234       responses:
39235         "default":
39236           description: Response codes found in [response codes](https://wiki.onap.org/).
39237       parameters:
39238         - name: vnf-id2
39239           in: path
39240           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39241           required: true
39242           type: string
39243           example: __VNF-ID2__
39244         - name: interface-name
39245           in: path
39246           description: Name given to the interface
39247           required: true
39248           type: string
39249           example: __INTERFACE-NAME__
39250         - name: vlan-interface
39251           in: path
39252           description: String that identifies the interface
39253           required: true
39254           type: string
39255           example: __VLAN-INTERFACE__
39256         - name: resource-version
39257           in: query
39258           description: resource-version for concurrency
39259           required: true
39260           type: string
39261   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans:
39262     get:
39263       tags:
39264         - Network
39265       summary: returns vlans
39266       description: returns vlans
39267       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlans
39268       produces:
39269         - application/json
39270         - application/xml
39271       responses:
39272         "200":
39273           description: successful operation
39274           schema:
39275               $ref: "#/getDefinitions/vlans"
39276         "default":
39277           description: Response codes found in [response codes](https://wiki.onap.org/).
39278       parameters:
39279         - name: vnf-id2
39280           in: path
39281           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39282           required: true
39283           type: string
39284           example: __VNF-ID2__
39285         - name: interface-name
39286           in: path
39287           description: Name given to the interface
39288           required: true
39289           type: string
39290           example: __INTERFACE-NAME__
39291         - name: vnf-name
39292           in: query
39293           description: Name of VNF.
39294           required: false
39295           type: string
39296         - name: vnf-name2
39297           in: query
39298           description: Alternate name of VNF.
39299           required: false
39300           type: string
39301         - name: vnf-type
39302           in: query
39303           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
39304           required: false
39305           type: string
39306         - name: prov-status
39307           in: query
39308           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
39309           required: false
39310           type: string
39311         - name: heat-stack-id
39312           in: query
39313           description: Heat stack id corresponding to this instance, managed by MSO
39314           required: false
39315           type: string
39316         - name: interface-id
39317           in: query
39318           description: ID of interface
39319           required: false
39320           type: string
39321         - name: macaddr
39322           in: query
39323           description: MAC address for the interface
39324           required: false
39325           type: string
39326         - name: network-name
39327           in: query
39328           description: Name of the network
39329           required: false
39330           type: string
39331   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
39332     put:
39333       tags:
39334         - Network
39335       summary: see node definition for valid relationships
39336       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
39337       consumes:
39338         - application/json
39339         - application/xml
39340       produces:
39341         - application/json
39342         - application/xml
39343       responses:
39344         "default":
39345           description: Response codes found in [response codes](https://wiki.onap.org/).
39346       parameters:
39347         - name: vnf-id2
39348           in: path
39349           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39350           required: true
39351           type: string
39352           example: __VNF-ID2__
39353         - name: interface-name
39354           in: path
39355           description: Name given to the interface
39356           required: true
39357           type: string
39358           example: __INTERFACE-NAME__
39359         - name: pci-id
39360           in: path
39361           description: PCI ID used to identify the sriov-vf
39362           required: true
39363           type: string
39364           example: __PCI-ID__
39365         - name: body
39366           in: body
39367           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
39368           required: true
39369           schema:
39370             $ref: "#/definitions/relationship"
39371     delete:
39372       tags:
39373         - Network
39374       summary: delete an existing relationship
39375       description: delete an existing relationship
39376       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
39377       consumes:
39378         - application/json
39379         - application/xml
39380       produces:
39381         - application/json
39382         - application/xml
39383       responses:
39384         "default":
39385           description: Response codes found in [response codes](https://wiki.onap.org/).
39386       parameters:
39387         - name: vnf-id2
39388           in: path
39389           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39390           required: true
39391           type: string
39392           example: __VNF-ID2__
39393         - name: interface-name
39394           in: path
39395           description: Name given to the interface
39396           required: true
39397           type: string
39398           example: __INTERFACE-NAME__
39399         - name: pci-id
39400           in: path
39401           description: PCI ID used to identify the sriov-vf
39402           required: true
39403           type: string
39404           example: __PCI-ID__
39405   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
39406     get:
39407       tags:
39408         - Network
39409       summary: returns sriov-vf
39410       description: returns sriov-vf
39411       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
39412       produces:
39413         - application/json
39414         - application/xml
39415       responses:
39416         "200":
39417           description: successful operation
39418           schema:
39419               $ref: "#/getDefinitions/sriov-vf"
39420         "default":
39421           description: Response codes found in [response codes](https://wiki.onap.org/).
39422       parameters:
39423         - name: vnf-id2
39424           in: path
39425           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39426           required: true
39427           type: string
39428           example: __VNF-ID2__
39429         - name: interface-name
39430           in: path
39431           description: Name given to the interface
39432           required: true
39433           type: string
39434           example: __INTERFACE-NAME__
39435         - name: pci-id
39436           in: path
39437           description: PCI ID used to identify the sriov-vf
39438           required: true
39439           type: string
39440           example: __PCI-ID__
39441         - name: vnf-name
39442           in: query
39443           description: Name of VNF.
39444           required: false
39445           type: string
39446         - name: vnf-name2
39447           in: query
39448           description: Alternate name of VNF.
39449           required: false
39450           type: string
39451         - name: vnf-type
39452           in: query
39453           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
39454           required: false
39455           type: string
39456         - name: prov-status
39457           in: query
39458           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
39459           required: false
39460           type: string
39461         - name: heat-stack-id
39462           in: query
39463           description: Heat stack id corresponding to this instance, managed by MSO
39464           required: false
39465           type: string
39466         - name: interface-id
39467           in: query
39468           description: ID of interface
39469           required: false
39470           type: string
39471         - name: macaddr
39472           in: query
39473           description: MAC address for the interface
39474           required: false
39475           type: string
39476         - name: network-name
39477           in: query
39478           description: Name of the network
39479           required: false
39480           type: string
39481         - name: vf-vlan-filter
39482           in: query
39483           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
39484           required: false
39485           type: string
39486         - name: vf-mac-filter
39487           in: query
39488           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
39489           required: false
39490           type: string
39491         - name: vf-vlan-strip
39492           in: query
39493           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
39494           required: false
39495           type: boolean
39496         - name: neutron-network-id
39497           in: query
39498           description: Neutron network id of the interface
39499           required: false
39500           type: string
39501     put:
39502       tags:
39503         - Network
39504       summary: create or update an existing sriov-vf
39505       description: |
39506         Create or update an existing sriov-vf.
39507         #
39508         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
39509       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
39510       consumes:
39511         - application/json
39512         - application/xml
39513       produces:
39514         - application/json
39515         - application/xml
39516       responses:
39517         "default":
39518           description: Response codes found in [response codes](https://wiki.onap.org/).
39519       parameters:
39520         - name: vnf-id2
39521           in: path
39522           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39523           required: true
39524           type: string
39525           example: __VNF-ID2__
39526         - name: interface-name
39527           in: path
39528           description: Name given to the interface
39529           required: true
39530           type: string
39531           example: __INTERFACE-NAME__
39532         - name: pci-id
39533           in: path
39534           description: PCI ID used to identify the sriov-vf
39535           required: true
39536           type: string
39537           example: __PCI-ID__
39538         - name: body
39539           in: body
39540           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
39541           required: true
39542           schema:
39543             $ref: "#/definitions/sriov-vf"
39544     patch:
39545       tags:
39546         - Network
39547       summary: update an existing sriov-vf
39548       description: |
39549         Update an existing sriov-vf
39550         #
39551         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39552         The PUT operation will entirely replace an existing object.
39553         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
39554         #
39555         Other differences between PUT and PATCH are:
39556         #
39557         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
39558         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39559         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39560       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
39561       consumes:
39562         - application/json
39563         - application/xml
39564       produces:
39565         - application/json
39566         - application/xml
39567       responses:
39568         "default":
39569           description: Response codes found in [response codes](https://wiki.onap.org/).
39570       parameters:
39571         - name: vnf-id2
39572           in: path
39573           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39574           required: true
39575           type: string
39576           example: __VNF-ID2__
39577         - name: interface-name
39578           in: path
39579           description: Name given to the interface
39580           required: true
39581           type: string
39582           example: __INTERFACE-NAME__
39583         - name: pci-id
39584           in: path
39585           description: PCI ID used to identify the sriov-vf
39586           required: true
39587           type: string
39588           example: __PCI-ID__
39589         - name: body
39590           in: body
39591           description: sriov-vf object that needs to be created or updated.
39592           required: true
39593           schema:
39594             $ref: "#/patchDefinitions/sriov-vf"
39595     delete:
39596       tags:
39597         - Network
39598       summary: delete an existing sriov-vf
39599       description: delete an existing sriov-vf
39600       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
39601       consumes:
39602         - application/json
39603         - application/xml
39604       produces:
39605         - application/json
39606         - application/xml
39607       responses:
39608         "default":
39609           description: Response codes found in [response codes](https://wiki.onap.org/).
39610       parameters:
39611         - name: vnf-id2
39612           in: path
39613           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39614           required: true
39615           type: string
39616           example: __VNF-ID2__
39617         - name: interface-name
39618           in: path
39619           description: Name given to the interface
39620           required: true
39621           type: string
39622           example: __INTERFACE-NAME__
39623         - name: pci-id
39624           in: path
39625           description: PCI ID used to identify the sriov-vf
39626           required: true
39627           type: string
39628           example: __PCI-ID__
39629         - name: resource-version
39630           in: query
39631           description: resource-version for concurrency
39632           required: true
39633           type: string
39634   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
39635     get:
39636       tags:
39637         - Network
39638       summary: returns sriov-vfs
39639       description: returns sriov-vfs
39640       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfs
39641       produces:
39642         - application/json
39643         - application/xml
39644       responses:
39645         "200":
39646           description: successful operation
39647           schema:
39648               $ref: "#/getDefinitions/sriov-vfs"
39649         "default":
39650           description: Response codes found in [response codes](https://wiki.onap.org/).
39651       parameters:
39652         - name: vnf-id2
39653           in: path
39654           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39655           required: true
39656           type: string
39657           example: __VNF-ID2__
39658         - name: interface-name
39659           in: path
39660           description: Name given to the interface
39661           required: true
39662           type: string
39663           example: __INTERFACE-NAME__
39664         - name: vnf-name
39665           in: query
39666           description: Name of VNF.
39667           required: false
39668           type: string
39669         - name: vnf-name2
39670           in: query
39671           description: Alternate name of VNF.
39672           required: false
39673           type: string
39674         - name: vnf-type
39675           in: query
39676           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
39677           required: false
39678           type: string
39679         - name: prov-status
39680           in: query
39681           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
39682           required: false
39683           type: string
39684         - name: heat-stack-id
39685           in: query
39686           description: Heat stack id corresponding to this instance, managed by MSO
39687           required: false
39688           type: string
39689         - name: interface-id
39690           in: query
39691           description: ID of interface
39692           required: false
39693           type: string
39694         - name: macaddr
39695           in: query
39696           description: MAC address for the interface
39697           required: false
39698           type: string
39699         - name: network-name
39700           in: query
39701           description: Name of the network
39702           required: false
39703           type: string
39704   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
39705     put:
39706       tags:
39707         - Network
39708       summary: see node definition for valid relationships
39709       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship
39710       consumes:
39711         - application/json
39712         - application/xml
39713       produces:
39714         - application/json
39715         - application/xml
39716       responses:
39717         "default":
39718           description: Response codes found in [response codes](https://wiki.onap.org/).
39719       parameters:
39720         - name: vnf-id2
39721           in: path
39722           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39723           required: true
39724           type: string
39725           example: __VNF-ID2__
39726         - name: interface-name
39727           in: path
39728           description: Name given to the interface
39729           required: true
39730           type: string
39731           example: __INTERFACE-NAME__
39732         - name: body
39733           in: body
39734           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterface.json)
39735           required: true
39736           schema:
39737             $ref: "#/definitions/relationship"
39738     delete:
39739       tags:
39740         - Network
39741       summary: delete an existing relationship
39742       description: delete an existing relationship
39743       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship
39744       consumes:
39745         - application/json
39746         - application/xml
39747       produces:
39748         - application/json
39749         - application/xml
39750       responses:
39751         "default":
39752           description: Response codes found in [response codes](https://wiki.onap.org/).
39753       parameters:
39754         - name: vnf-id2
39755           in: path
39756           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39757           required: true
39758           type: string
39759           example: __VNF-ID2__
39760         - name: interface-name
39761           in: path
39762           description: Name given to the interface
39763           required: true
39764           type: string
39765           example: __INTERFACE-NAME__
39766   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
39767     put:
39768       tags:
39769         - Network
39770       summary: see node definition for valid relationships
39771       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
39772       consumes:
39773         - application/json
39774         - application/xml
39775       produces:
39776         - application/json
39777         - application/xml
39778       responses:
39779         "default":
39780           description: Response codes found in [response codes](https://wiki.onap.org/).
39781       parameters:
39782         - name: vnf-id2
39783           in: path
39784           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39785           required: true
39786           type: string
39787           example: __VNF-ID2__
39788         - name: interface-name
39789           in: path
39790           description: Name given to the interface
39791           required: true
39792           type: string
39793           example: __INTERFACE-NAME__
39794         - name: l3-interface-ipv4-address
39795           in: path
39796           description: IP address
39797           required: true
39798           type: string
39799           example: __L3-INTERFACE-IPV4-ADDRESS__
39800         - name: body
39801           in: body
39802           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
39803           required: true
39804           schema:
39805             $ref: "#/definitions/relationship"
39806     delete:
39807       tags:
39808         - Network
39809       summary: delete an existing relationship
39810       description: delete an existing relationship
39811       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
39812       consumes:
39813         - application/json
39814         - application/xml
39815       produces:
39816         - application/json
39817         - application/xml
39818       responses:
39819         "default":
39820           description: Response codes found in [response codes](https://wiki.onap.org/).
39821       parameters:
39822         - name: vnf-id2
39823           in: path
39824           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39825           required: true
39826           type: string
39827           example: __VNF-ID2__
39828         - name: interface-name
39829           in: path
39830           description: Name given to the interface
39831           required: true
39832           type: string
39833           example: __INTERFACE-NAME__
39834         - name: l3-interface-ipv4-address
39835           in: path
39836           description: IP address
39837           required: true
39838           type: string
39839           example: __L3-INTERFACE-IPV4-ADDRESS__
39840   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
39841     get:
39842       tags:
39843         - Network
39844       summary: returns l3-interface-ipv4-address-list
39845       description: returns l3-interface-ipv4-address-list
39846       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
39847       produces:
39848         - application/json
39849         - application/xml
39850       responses:
39851         "200":
39852           description: successful operation
39853           schema:
39854               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
39855         "default":
39856           description: Response codes found in [response codes](https://wiki.onap.org/).
39857       parameters:
39858         - name: vnf-id2
39859           in: path
39860           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39861           required: true
39862           type: string
39863           example: __VNF-ID2__
39864         - name: interface-name
39865           in: path
39866           description: Name given to the interface
39867           required: true
39868           type: string
39869           example: __INTERFACE-NAME__
39870         - name: l3-interface-ipv4-address
39871           in: path
39872           description: IP address
39873           required: true
39874           type: string
39875           example: __L3-INTERFACE-IPV4-ADDRESS__
39876         - name: vnf-name
39877           in: query
39878           description: Name of VNF.
39879           required: false
39880           type: string
39881         - name: vnf-name2
39882           in: query
39883           description: Alternate name of VNF.
39884           required: false
39885           type: string
39886         - name: vnf-type
39887           in: query
39888           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
39889           required: false
39890           type: string
39891         - name: prov-status
39892           in: query
39893           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
39894           required: false
39895           type: string
39896         - name: heat-stack-id
39897           in: query
39898           description: Heat stack id corresponding to this instance, managed by MSO
39899           required: false
39900           type: string
39901         - name: interface-id
39902           in: query
39903           description: ID of interface
39904           required: false
39905           type: string
39906         - name: macaddr
39907           in: query
39908           description: MAC address for the interface
39909           required: false
39910           type: string
39911         - name: network-name
39912           in: query
39913           description: Name of the network
39914           required: false
39915           type: string
39916         - name: vlan-id-inner
39917           in: query
39918           description: Inner VLAN tag
39919           required: false
39920           type: integer
39921           format: int64
39922         - name: neutron-network-id
39923           in: query
39924           description: Neutron network id of the interface that address belongs to
39925           required: false
39926           type: string
39927         - name: neutron-subnet-id
39928           in: query
39929           description: Neutron id of subnet that address belongs to
39930           required: false
39931           type: string
39932     put:
39933       tags:
39934         - Network
39935       summary: create or update an existing l3-interface-ipv4-address-list
39936       description: |
39937         Create or update an existing l3-interface-ipv4-address-list.
39938         #
39939         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
39940       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
39941       consumes:
39942         - application/json
39943         - application/xml
39944       produces:
39945         - application/json
39946         - application/xml
39947       responses:
39948         "default":
39949           description: Response codes found in [response codes](https://wiki.onap.org/).
39950       parameters:
39951         - name: vnf-id2
39952           in: path
39953           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39954           required: true
39955           type: string
39956           example: __VNF-ID2__
39957         - name: interface-name
39958           in: path
39959           description: Name given to the interface
39960           required: true
39961           type: string
39962           example: __INTERFACE-NAME__
39963         - name: l3-interface-ipv4-address
39964           in: path
39965           description: IP address
39966           required: true
39967           type: string
39968           example: __L3-INTERFACE-IPV4-ADDRESS__
39969         - name: body
39970           in: body
39971           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
39972           required: true
39973           schema:
39974             $ref: "#/definitions/l3-interface-ipv4-address-list"
39975     patch:
39976       tags:
39977         - Network
39978       summary: update an existing l3-interface-ipv4-address-list
39979       description: |
39980         Update an existing l3-interface-ipv4-address-list
39981         #
39982         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39983         The PUT operation will entirely replace an existing object.
39984         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
39985         #
39986         Other differences between PUT and PATCH are:
39987         #
39988         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
39989         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39990         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39991       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
39992       consumes:
39993         - application/json
39994         - application/xml
39995       produces:
39996         - application/json
39997         - application/xml
39998       responses:
39999         "default":
40000           description: Response codes found in [response codes](https://wiki.onap.org/).
40001       parameters:
40002         - name: vnf-id2
40003           in: path
40004           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40005           required: true
40006           type: string
40007           example: __VNF-ID2__
40008         - name: interface-name
40009           in: path
40010           description: Name given to the interface
40011           required: true
40012           type: string
40013           example: __INTERFACE-NAME__
40014         - name: l3-interface-ipv4-address
40015           in: path
40016           description: IP address
40017           required: true
40018           type: string
40019           example: __L3-INTERFACE-IPV4-ADDRESS__
40020         - name: body
40021           in: body
40022           description: l3-interface-ipv4-address-list object that needs to be created or updated.
40023           required: true
40024           schema:
40025             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
40026     delete:
40027       tags:
40028         - Network
40029       summary: delete an existing l3-interface-ipv4-address-list
40030       description: delete an existing l3-interface-ipv4-address-list
40031       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
40032       consumes:
40033         - application/json
40034         - application/xml
40035       produces:
40036         - application/json
40037         - application/xml
40038       responses:
40039         "default":
40040           description: Response codes found in [response codes](https://wiki.onap.org/).
40041       parameters:
40042         - name: vnf-id2
40043           in: path
40044           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40045           required: true
40046           type: string
40047           example: __VNF-ID2__
40048         - name: interface-name
40049           in: path
40050           description: Name given to the interface
40051           required: true
40052           type: string
40053           example: __INTERFACE-NAME__
40054         - name: l3-interface-ipv4-address
40055           in: path
40056           description: IP address
40057           required: true
40058           type: string
40059           example: __L3-INTERFACE-IPV4-ADDRESS__
40060         - name: resource-version
40061           in: query
40062           description: resource-version for concurrency
40063           required: true
40064           type: string
40065   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
40066     put:
40067       tags:
40068         - Network
40069       summary: see node definition for valid relationships
40070       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
40071       consumes:
40072         - application/json
40073         - application/xml
40074       produces:
40075         - application/json
40076         - application/xml
40077       responses:
40078         "default":
40079           description: Response codes found in [response codes](https://wiki.onap.org/).
40080       parameters:
40081         - name: vnf-id2
40082           in: path
40083           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40084           required: true
40085           type: string
40086           example: __VNF-ID2__
40087         - name: interface-name
40088           in: path
40089           description: Name given to the interface
40090           required: true
40091           type: string
40092           example: __INTERFACE-NAME__
40093         - name: l3-interface-ipv6-address
40094           in: path
40095           description: IP address
40096           required: true
40097           type: string
40098           example: __L3-INTERFACE-IPV6-ADDRESS__
40099         - name: body
40100           in: body
40101           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
40102           required: true
40103           schema:
40104             $ref: "#/definitions/relationship"
40105     delete:
40106       tags:
40107         - Network
40108       summary: delete an existing relationship
40109       description: delete an existing relationship
40110       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
40111       consumes:
40112         - application/json
40113         - application/xml
40114       produces:
40115         - application/json
40116         - application/xml
40117       responses:
40118         "default":
40119           description: Response codes found in [response codes](https://wiki.onap.org/).
40120       parameters:
40121         - name: vnf-id2
40122           in: path
40123           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40124           required: true
40125           type: string
40126           example: __VNF-ID2__
40127         - name: interface-name
40128           in: path
40129           description: Name given to the interface
40130           required: true
40131           type: string
40132           example: __INTERFACE-NAME__
40133         - name: l3-interface-ipv6-address
40134           in: path
40135           description: IP address
40136           required: true
40137           type: string
40138           example: __L3-INTERFACE-IPV6-ADDRESS__
40139   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
40140     get:
40141       tags:
40142         - Network
40143       summary: returns l3-interface-ipv6-address-list
40144       description: returns l3-interface-ipv6-address-list
40145       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
40146       produces:
40147         - application/json
40148         - application/xml
40149       responses:
40150         "200":
40151           description: successful operation
40152           schema:
40153               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
40154         "default":
40155           description: Response codes found in [response codes](https://wiki.onap.org/).
40156       parameters:
40157         - name: vnf-id2
40158           in: path
40159           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40160           required: true
40161           type: string
40162           example: __VNF-ID2__
40163         - name: interface-name
40164           in: path
40165           description: Name given to the interface
40166           required: true
40167           type: string
40168           example: __INTERFACE-NAME__
40169         - name: l3-interface-ipv6-address
40170           in: path
40171           description: IP address
40172           required: true
40173           type: string
40174           example: __L3-INTERFACE-IPV6-ADDRESS__
40175         - name: vnf-name
40176           in: query
40177           description: Name of VNF.
40178           required: false
40179           type: string
40180         - name: vnf-name2
40181           in: query
40182           description: Alternate name of VNF.
40183           required: false
40184           type: string
40185         - name: vnf-type
40186           in: query
40187           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
40188           required: false
40189           type: string
40190         - name: prov-status
40191           in: query
40192           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
40193           required: false
40194           type: string
40195         - name: heat-stack-id
40196           in: query
40197           description: Heat stack id corresponding to this instance, managed by MSO
40198           required: false
40199           type: string
40200         - name: interface-id
40201           in: query
40202           description: ID of interface
40203           required: false
40204           type: string
40205         - name: macaddr
40206           in: query
40207           description: MAC address for the interface
40208           required: false
40209           type: string
40210         - name: network-name
40211           in: query
40212           description: Name of the network
40213           required: false
40214           type: string
40215         - name: vlan-id-inner
40216           in: query
40217           description: Inner VLAN tag
40218           required: false
40219           type: integer
40220           format: int64
40221         - name: neutron-network-id
40222           in: query
40223           description: Neutron network id of the interface that address belongs to
40224           required: false
40225           type: string
40226         - name: neutron-subnet-id
40227           in: query
40228           description: Neutron id of subnet that address belongs to
40229           required: false
40230           type: string
40231     put:
40232       tags:
40233         - Network
40234       summary: create or update an existing l3-interface-ipv6-address-list
40235       description: |
40236         Create or update an existing l3-interface-ipv6-address-list.
40237         #
40238         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
40239       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
40240       consumes:
40241         - application/json
40242         - application/xml
40243       produces:
40244         - application/json
40245         - application/xml
40246       responses:
40247         "default":
40248           description: Response codes found in [response codes](https://wiki.onap.org/).
40249       parameters:
40250         - name: vnf-id2
40251           in: path
40252           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40253           required: true
40254           type: string
40255           example: __VNF-ID2__
40256         - name: interface-name
40257           in: path
40258           description: Name given to the interface
40259           required: true
40260           type: string
40261           example: __INTERFACE-NAME__
40262         - name: l3-interface-ipv6-address
40263           in: path
40264           description: IP address
40265           required: true
40266           type: string
40267           example: __L3-INTERFACE-IPV6-ADDRESS__
40268         - name: body
40269           in: body
40270           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
40271           required: true
40272           schema:
40273             $ref: "#/definitions/l3-interface-ipv6-address-list"
40274     patch:
40275       tags:
40276         - Network
40277       summary: update an existing l3-interface-ipv6-address-list
40278       description: |
40279         Update an existing l3-interface-ipv6-address-list
40280         #
40281         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40282         The PUT operation will entirely replace an existing object.
40283         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
40284         #
40285         Other differences between PUT and PATCH are:
40286         #
40287         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
40288         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40289         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40290       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
40291       consumes:
40292         - application/json
40293         - application/xml
40294       produces:
40295         - application/json
40296         - application/xml
40297       responses:
40298         "default":
40299           description: Response codes found in [response codes](https://wiki.onap.org/).
40300       parameters:
40301         - name: vnf-id2
40302           in: path
40303           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40304           required: true
40305           type: string
40306           example: __VNF-ID2__
40307         - name: interface-name
40308           in: path
40309           description: Name given to the interface
40310           required: true
40311           type: string
40312           example: __INTERFACE-NAME__
40313         - name: l3-interface-ipv6-address
40314           in: path
40315           description: IP address
40316           required: true
40317           type: string
40318           example: __L3-INTERFACE-IPV6-ADDRESS__
40319         - name: body
40320           in: body
40321           description: l3-interface-ipv6-address-list object that needs to be created or updated.
40322           required: true
40323           schema:
40324             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
40325     delete:
40326       tags:
40327         - Network
40328       summary: delete an existing l3-interface-ipv6-address-list
40329       description: delete an existing l3-interface-ipv6-address-list
40330       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
40331       consumes:
40332         - application/json
40333         - application/xml
40334       produces:
40335         - application/json
40336         - application/xml
40337       responses:
40338         "default":
40339           description: Response codes found in [response codes](https://wiki.onap.org/).
40340       parameters:
40341         - name: vnf-id2
40342           in: path
40343           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40344           required: true
40345           type: string
40346           example: __VNF-ID2__
40347         - name: interface-name
40348           in: path
40349           description: Name given to the interface
40350           required: true
40351           type: string
40352           example: __INTERFACE-NAME__
40353         - name: l3-interface-ipv6-address
40354           in: path
40355           description: IP address
40356           required: true
40357           type: string
40358           example: __L3-INTERFACE-IPV6-ADDRESS__
40359         - name: resource-version
40360           in: query
40361           description: resource-version for concurrency
40362           required: true
40363           type: string
40364   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}:
40365     get:
40366       tags:
40367         - Network
40368       summary: returns l-interface
40369       description: returns l-interface
40370       operationId: getNetworkNewvcesNewvceLInterfacesLInterface
40371       produces:
40372         - application/json
40373         - application/xml
40374       responses:
40375         "200":
40376           description: successful operation
40377           schema:
40378               $ref: "#/getDefinitions/l-interface"
40379         "default":
40380           description: Response codes found in [response codes](https://wiki.onap.org/).
40381       parameters:
40382         - name: vnf-id2
40383           in: path
40384           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40385           required: true
40386           type: string
40387           example: __VNF-ID2__
40388         - name: interface-name
40389           in: path
40390           description: Name given to the interface
40391           required: true
40392           type: string
40393           example: __INTERFACE-NAME__
40394         - name: vnf-name
40395           in: query
40396           description: Name of VNF.
40397           required: false
40398           type: string
40399         - name: vnf-name2
40400           in: query
40401           description: Alternate name of VNF.
40402           required: false
40403           type: string
40404         - name: vnf-type
40405           in: query
40406           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
40407           required: false
40408           type: string
40409         - name: prov-status
40410           in: query
40411           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
40412           required: false
40413           type: string
40414         - name: heat-stack-id
40415           in: query
40416           description: Heat stack id corresponding to this instance, managed by MSO
40417           required: false
40418           type: string
40419         - name: interface-id
40420           in: query
40421           description: ID of interface
40422           required: false
40423           type: string
40424         - name: macaddr
40425           in: query
40426           description: MAC address for the interface
40427           required: false
40428           type: string
40429         - name: network-name
40430           in: query
40431           description: Name of the network
40432           required: false
40433           type: string
40434     put:
40435       tags:
40436         - Network
40437       summary: create or update an existing l-interface
40438       description: |
40439         Create or update an existing l-interface.
40440         #
40441         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
40442       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterface
40443       consumes:
40444         - application/json
40445         - application/xml
40446       produces:
40447         - application/json
40448         - application/xml
40449       responses:
40450         "default":
40451           description: Response codes found in [response codes](https://wiki.onap.org/).
40452       parameters:
40453         - name: vnf-id2
40454           in: path
40455           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40456           required: true
40457           type: string
40458           example: __VNF-ID2__
40459         - name: interface-name
40460           in: path
40461           description: Name given to the interface
40462           required: true
40463           type: string
40464           example: __INTERFACE-NAME__
40465         - name: body
40466           in: body
40467           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterface.json)
40468           required: true
40469           schema:
40470             $ref: "#/definitions/l-interface"
40471     patch:
40472       tags:
40473         - Network
40474       summary: update an existing l-interface
40475       description: |
40476         Update an existing l-interface
40477         #
40478         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40479         The PUT operation will entirely replace an existing object.
40480         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
40481         #
40482         Other differences between PUT and PATCH are:
40483         #
40484         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
40485         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40486         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40487       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterface
40488       consumes:
40489         - application/json
40490         - application/xml
40491       produces:
40492         - application/json
40493         - application/xml
40494       responses:
40495         "default":
40496           description: Response codes found in [response codes](https://wiki.onap.org/).
40497       parameters:
40498         - name: vnf-id2
40499           in: path
40500           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40501           required: true
40502           type: string
40503           example: __VNF-ID2__
40504         - name: interface-name
40505           in: path
40506           description: Name given to the interface
40507           required: true
40508           type: string
40509           example: __INTERFACE-NAME__
40510         - name: body
40511           in: body
40512           description: l-interface object that needs to be created or updated.
40513           required: true
40514           schema:
40515             $ref: "#/patchDefinitions/l-interface"
40516     delete:
40517       tags:
40518         - Network
40519       summary: delete an existing l-interface
40520       description: delete an existing l-interface
40521       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterface
40522       consumes:
40523         - application/json
40524         - application/xml
40525       produces:
40526         - application/json
40527         - application/xml
40528       responses:
40529         "default":
40530           description: Response codes found in [response codes](https://wiki.onap.org/).
40531       parameters:
40532         - name: vnf-id2
40533           in: path
40534           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40535           required: true
40536           type: string
40537           example: __VNF-ID2__
40538         - name: interface-name
40539           in: path
40540           description: Name given to the interface
40541           required: true
40542           type: string
40543           example: __INTERFACE-NAME__
40544         - name: resource-version
40545           in: query
40546           description: resource-version for concurrency
40547           required: true
40548           type: string
40549   /network/newvces/newvce/{vnf-id2}/l-interfaces:
40550     get:
40551       tags:
40552         - Network
40553       summary: returns l-interfaces
40554       description: returns l-interfaces
40555       operationId: getNetworkNewvcesNewvceLInterfaces
40556       produces:
40557         - application/json
40558         - application/xml
40559       responses:
40560         "200":
40561           description: successful operation
40562           schema:
40563               $ref: "#/getDefinitions/l-interfaces"
40564         "default":
40565           description: Response codes found in [response codes](https://wiki.onap.org/).
40566       parameters:
40567         - name: vnf-id2
40568           in: path
40569           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40570           required: true
40571           type: string
40572           example: __VNF-ID2__
40573         - name: vnf-name
40574           in: query
40575           description: Name of VNF.
40576           required: false
40577           type: string
40578         - name: vnf-name2
40579           in: query
40580           description: Alternate name of VNF.
40581           required: false
40582           type: string
40583         - name: vnf-type
40584           in: query
40585           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
40586           required: false
40587           type: string
40588         - name: prov-status
40589           in: query
40590           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
40591           required: false
40592           type: string
40593         - name: heat-stack-id
40594           in: query
40595           description: Heat stack id corresponding to this instance, managed by MSO
40596           required: false
40597           type: string
40598   /network/newvces/newvce/{vnf-id2}:
40599     get:
40600       tags:
40601         - Network
40602       summary: returns newvce
40603       description: returns newvce
40604       operationId: getNetworkNewvcesNewvce
40605       produces:
40606         - application/json
40607         - application/xml
40608       responses:
40609         "200":
40610           description: successful operation
40611           schema:
40612               $ref: "#/getDefinitions/newvce"
40613         "default":
40614           description: Response codes found in [response codes](https://wiki.onap.org/).
40615       parameters:
40616         - name: vnf-id2
40617           in: path
40618           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40619           required: true
40620           type: string
40621           example: __VNF-ID2__
40622         - name: vnf-name
40623           in: query
40624           description: Name of VNF.
40625           required: false
40626           type: string
40627         - name: vnf-name2
40628           in: query
40629           description: Alternate name of VNF.
40630           required: false
40631           type: string
40632         - name: vnf-type
40633           in: query
40634           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
40635           required: false
40636           type: string
40637         - name: prov-status
40638           in: query
40639           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
40640           required: false
40641           type: string
40642         - name: heat-stack-id
40643           in: query
40644           description: Heat stack id corresponding to this instance, managed by MSO
40645           required: false
40646           type: string
40647     put:
40648       tags:
40649         - Network
40650       summary: create or update an existing newvce
40651       description: |
40652         Create or update an existing newvce.
40653         #
40654         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
40655       operationId: createOrUpdateNetworkNewvcesNewvce
40656       consumes:
40657         - application/json
40658         - application/xml
40659       produces:
40660         - application/json
40661         - application/xml
40662       responses:
40663         "default":
40664           description: Response codes found in [response codes](https://wiki.onap.org/).
40665       parameters:
40666         - name: vnf-id2
40667           in: path
40668           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40669           required: true
40670           type: string
40671           example: __VNF-ID2__
40672         - name: body
40673           in: body
40674           description: newvce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvce.json)
40675           required: true
40676           schema:
40677             $ref: "#/definitions/newvce"
40678     patch:
40679       tags:
40680         - Network
40681       summary: update an existing newvce
40682       description: |
40683         Update an existing newvce
40684         #
40685         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40686         The PUT operation will entirely replace an existing object.
40687         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
40688         #
40689         Other differences between PUT and PATCH are:
40690         #
40691         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
40692         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40693         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40694       operationId: UpdateNetworkNewvcesNewvce
40695       consumes:
40696         - application/json
40697         - application/xml
40698       produces:
40699         - application/json
40700         - application/xml
40701       responses:
40702         "default":
40703           description: Response codes found in [response codes](https://wiki.onap.org/).
40704       parameters:
40705         - name: vnf-id2
40706           in: path
40707           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40708           required: true
40709           type: string
40710           example: __VNF-ID2__
40711         - name: body
40712           in: body
40713           description: newvce object that needs to be created or updated.
40714           required: true
40715           schema:
40716             $ref: "#/patchDefinitions/newvce"
40717     delete:
40718       tags:
40719         - Network
40720       summary: delete an existing newvce
40721       description: delete an existing newvce
40722       operationId: deleteNetworkNewvcesNewvce
40723       consumes:
40724         - application/json
40725         - application/xml
40726       produces:
40727         - application/json
40728         - application/xml
40729       responses:
40730         "default":
40731           description: Response codes found in [response codes](https://wiki.onap.org/).
40732       parameters:
40733         - name: vnf-id2
40734           in: path
40735           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40736           required: true
40737           type: string
40738           example: __VNF-ID2__
40739         - name: resource-version
40740           in: query
40741           description: resource-version for concurrency
40742           required: true
40743           type: string
40744   /network/newvces:
40745     get:
40746       tags:
40747         - Network
40748       summary: returns newvces
40749       description: returns newvces
40750       operationId: getNetworkNewvces
40751       produces:
40752         - application/json
40753         - application/xml
40754       responses:
40755         "200":
40756           description: successful operation
40757           schema:
40758               $ref: "#/getDefinitions/newvces"
40759         "default":
40760           description: Response codes found in [response codes](https://wiki.onap.org/).
40761   /network/pnfs/pnf/{pnf-name}/relationship-list/relationship:
40762     put:
40763       tags:
40764         - Network
40765       summary: see node definition for valid relationships
40766       operationId: createOrUpdateNetworkPnfsPnfRelationshipListRelationship
40767       consumes:
40768         - application/json
40769         - application/xml
40770       produces:
40771         - application/json
40772         - application/xml
40773       responses:
40774         "default":
40775           description: Response codes found in [response codes](https://wiki.onap.org/).
40776       parameters:
40777         - name: pnf-name
40778           in: path
40779           description: unique name of Physical Network Function.
40780           required: true
40781           type: string
40782           example: __PNF-NAME__
40783         - name: body
40784           in: body
40785           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnf.json)
40786           required: true
40787           schema:
40788             $ref: "#/definitions/relationship"
40789     delete:
40790       tags:
40791         - Network
40792       summary: delete an existing relationship
40793       description: delete an existing relationship
40794       operationId: deleteNetworkPnfsPnfRelationshipListRelationship
40795       consumes:
40796         - application/json
40797         - application/xml
40798       produces:
40799         - application/json
40800         - application/xml
40801       responses:
40802         "default":
40803           description: Response codes found in [response codes](https://wiki.onap.org/).
40804       parameters:
40805         - name: pnf-name
40806           in: path
40807           description: unique name of Physical Network Function.
40808           required: true
40809           type: string
40810           example: __PNF-NAME__
40811   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
40812     put:
40813       tags:
40814         - Network
40815       summary: see node definition for valid relationships
40816       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship
40817       consumes:
40818         - application/json
40819         - application/xml
40820       produces:
40821         - application/json
40822         - application/xml
40823       responses:
40824         "default":
40825           description: Response codes found in [response codes](https://wiki.onap.org/).
40826       parameters:
40827         - name: pnf-name
40828           in: path
40829           description: unique name of Physical Network Function.
40830           required: true
40831           type: string
40832           example: __PNF-NAME__
40833         - name: interface-name
40834           in: path
40835           description: Name that identifies the physical interface
40836           required: true
40837           type: string
40838           example: __INTERFACE-NAME__
40839         - name: body
40840           in: body
40841           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterface.json)
40842           required: true
40843           schema:
40844             $ref: "#/definitions/relationship"
40845     delete:
40846       tags:
40847         - Network
40848       summary: delete an existing relationship
40849       description: delete an existing relationship
40850       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship
40851       consumes:
40852         - application/json
40853         - application/xml
40854       produces:
40855         - application/json
40856         - application/xml
40857       responses:
40858         "default":
40859           description: Response codes found in [response codes](https://wiki.onap.org/).
40860       parameters:
40861         - name: pnf-name
40862           in: path
40863           description: unique name of Physical Network Function.
40864           required: true
40865           type: string
40866           example: __PNF-NAME__
40867         - name: interface-name
40868           in: path
40869           description: Name that identifies the physical interface
40870           required: true
40871           type: string
40872           example: __INTERFACE-NAME__
40873   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
40874     put:
40875       tags:
40876         - Network
40877       summary: see node definition for valid relationships
40878       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
40879       consumes:
40880         - application/json
40881         - application/xml
40882       produces:
40883         - application/json
40884         - application/xml
40885       responses:
40886         "default":
40887           description: Response codes found in [response codes](https://wiki.onap.org/).
40888       parameters:
40889         - name: pnf-name
40890           in: path
40891           description: unique name of Physical Network Function.
40892           required: true
40893           type: string
40894           example: __PNF-NAME__
40895         - name: interface-name
40896           in: path
40897           description: Name that identifies the physical interface
40898           required: true
40899           type: string
40900           example: __INTERFACE-NAME__
40901         - name: interface-name
40902           in: path
40903           description: Name given to the interface
40904           required: true
40905           type: string
40906           example: __INTERFACE-NAME__
40907         - name: vlan-interface
40908           in: path
40909           description: String that identifies the interface
40910           required: true
40911           type: string
40912           example: __VLAN-INTERFACE__
40913         - name: body
40914           in: body
40915           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
40916           required: true
40917           schema:
40918             $ref: "#/definitions/relationship"
40919     delete:
40920       tags:
40921         - Network
40922       summary: delete an existing relationship
40923       description: delete an existing relationship
40924       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
40925       consumes:
40926         - application/json
40927         - application/xml
40928       produces:
40929         - application/json
40930         - application/xml
40931       responses:
40932         "default":
40933           description: Response codes found in [response codes](https://wiki.onap.org/).
40934       parameters:
40935         - name: pnf-name
40936           in: path
40937           description: unique name of Physical Network Function.
40938           required: true
40939           type: string
40940           example: __PNF-NAME__
40941         - name: interface-name
40942           in: path
40943           description: Name that identifies the physical interface
40944           required: true
40945           type: string
40946           example: __INTERFACE-NAME__
40947         - name: interface-name
40948           in: path
40949           description: Name given to the interface
40950           required: true
40951           type: string
40952           example: __INTERFACE-NAME__
40953         - name: vlan-interface
40954           in: path
40955           description: String that identifies the interface
40956           required: true
40957           type: string
40958           example: __VLAN-INTERFACE__
40959   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
40960     put:
40961       tags:
40962         - Network
40963       summary: see node definition for valid relationships
40964       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
40965       consumes:
40966         - application/json
40967         - application/xml
40968       produces:
40969         - application/json
40970         - application/xml
40971       responses:
40972         "default":
40973           description: Response codes found in [response codes](https://wiki.onap.org/).
40974       parameters:
40975         - name: pnf-name
40976           in: path
40977           description: unique name of Physical Network Function.
40978           required: true
40979           type: string
40980           example: __PNF-NAME__
40981         - name: interface-name
40982           in: path
40983           description: Name that identifies the physical interface
40984           required: true
40985           type: string
40986           example: __INTERFACE-NAME__
40987         - name: interface-name
40988           in: path
40989           description: Name given to the interface
40990           required: true
40991           type: string
40992           example: __INTERFACE-NAME__
40993         - name: vlan-interface
40994           in: path
40995           description: String that identifies the interface
40996           required: true
40997           type: string
40998           example: __VLAN-INTERFACE__
40999         - name: l3-interface-ipv4-address
41000           in: path
41001           description: IP address
41002           required: true
41003           type: string
41004           example: __L3-INTERFACE-IPV4-ADDRESS__
41005         - name: body
41006           in: body
41007           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
41008           required: true
41009           schema:
41010             $ref: "#/definitions/relationship"
41011     delete:
41012       tags:
41013         - Network
41014       summary: delete an existing relationship
41015       description: delete an existing relationship
41016       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
41017       consumes:
41018         - application/json
41019         - application/xml
41020       produces:
41021         - application/json
41022         - application/xml
41023       responses:
41024         "default":
41025           description: Response codes found in [response codes](https://wiki.onap.org/).
41026       parameters:
41027         - name: pnf-name
41028           in: path
41029           description: unique name of Physical Network Function.
41030           required: true
41031           type: string
41032           example: __PNF-NAME__
41033         - name: interface-name
41034           in: path
41035           description: Name that identifies the physical interface
41036           required: true
41037           type: string
41038           example: __INTERFACE-NAME__
41039         - name: interface-name
41040           in: path
41041           description: Name given to the interface
41042           required: true
41043           type: string
41044           example: __INTERFACE-NAME__
41045         - name: vlan-interface
41046           in: path
41047           description: String that identifies the interface
41048           required: true
41049           type: string
41050           example: __VLAN-INTERFACE__
41051         - name: l3-interface-ipv4-address
41052           in: path
41053           description: IP address
41054           required: true
41055           type: string
41056           example: __L3-INTERFACE-IPV4-ADDRESS__
41057   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
41058     get:
41059       tags:
41060         - Network
41061       summary: returns l3-interface-ipv4-address-list
41062       description: returns l3-interface-ipv4-address-list
41063       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
41064       produces:
41065         - application/json
41066         - application/xml
41067       responses:
41068         "200":
41069           description: successful operation
41070           schema:
41071               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
41072         "default":
41073           description: Response codes found in [response codes](https://wiki.onap.org/).
41074       parameters:
41075         - name: pnf-name
41076           in: path
41077           description: unique name of Physical Network Function.
41078           required: true
41079           type: string
41080           example: __PNF-NAME__
41081         - name: interface-name
41082           in: path
41083           description: Name that identifies the physical interface
41084           required: true
41085           type: string
41086           example: __INTERFACE-NAME__
41087         - name: interface-name
41088           in: path
41089           description: Name given to the interface
41090           required: true
41091           type: string
41092           example: __INTERFACE-NAME__
41093         - name: vlan-interface
41094           in: path
41095           description: String that identifies the interface
41096           required: true
41097           type: string
41098           example: __VLAN-INTERFACE__
41099         - name: l3-interface-ipv4-address
41100           in: path
41101           description: IP address
41102           required: true
41103           type: string
41104           example: __L3-INTERFACE-IPV4-ADDRESS__
41105         - name: inv-status
41106           in: query
41107           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
41108           required: false
41109           type: string
41110         - name: prov-status
41111           in: query
41112           description: Trigger for operational monitoring of this resource by Service Assurance systems.
41113           required: false
41114           type: string
41115         - name: interface-id
41116           in: query
41117           description: ID of interface
41118           required: false
41119           type: string
41120         - name: macaddr
41121           in: query
41122           description: MAC address for the interface
41123           required: false
41124           type: string
41125         - name: network-name
41126           in: query
41127           description: Name of the network
41128           required: false
41129           type: string
41130         - name: vlan-id-inner
41131           in: query
41132           description: Inner VLAN tag
41133           required: false
41134           type: integer
41135           format: int64
41136         - name: vpn-id
41137           in: query
41138           description: This indicates the customers VPN ID associated with this vlan
41139           required: false
41140           type: string
41141         - name: vlan-id-inner
41142           in: query
41143           description: Inner VLAN tag
41144           required: false
41145           type: integer
41146           format: int64
41147         - name: neutron-network-id
41148           in: query
41149           description: Neutron network id of the interface that address belongs to
41150           required: false
41151           type: string
41152         - name: neutron-subnet-id
41153           in: query
41154           description: Neutron id of subnet that address belongs to
41155           required: false
41156           type: string
41157     put:
41158       tags:
41159         - Network
41160       summary: create or update an existing l3-interface-ipv4-address-list
41161       description: |
41162         Create or update an existing l3-interface-ipv4-address-list.
41163         #
41164         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
41165       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
41166       consumes:
41167         - application/json
41168         - application/xml
41169       produces:
41170         - application/json
41171         - application/xml
41172       responses:
41173         "default":
41174           description: Response codes found in [response codes](https://wiki.onap.org/).
41175       parameters:
41176         - name: pnf-name
41177           in: path
41178           description: unique name of Physical Network Function.
41179           required: true
41180           type: string
41181           example: __PNF-NAME__
41182         - name: interface-name
41183           in: path
41184           description: Name that identifies the physical interface
41185           required: true
41186           type: string
41187           example: __INTERFACE-NAME__
41188         - name: interface-name
41189           in: path
41190           description: Name given to the interface
41191           required: true
41192           type: string
41193           example: __INTERFACE-NAME__
41194         - name: vlan-interface
41195           in: path
41196           description: String that identifies the interface
41197           required: true
41198           type: string
41199           example: __VLAN-INTERFACE__
41200         - name: l3-interface-ipv4-address
41201           in: path
41202           description: IP address
41203           required: true
41204           type: string
41205           example: __L3-INTERFACE-IPV4-ADDRESS__
41206         - name: body
41207           in: body
41208           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
41209           required: true
41210           schema:
41211             $ref: "#/definitions/l3-interface-ipv4-address-list"
41212     patch:
41213       tags:
41214         - Network
41215       summary: update an existing l3-interface-ipv4-address-list
41216       description: |
41217         Update an existing l3-interface-ipv4-address-list
41218         #
41219         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41220         The PUT operation will entirely replace an existing object.
41221         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
41222         #
41223         Other differences between PUT and PATCH are:
41224         #
41225         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
41226         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41227         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41228       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
41229       consumes:
41230         - application/json
41231         - application/xml
41232       produces:
41233         - application/json
41234         - application/xml
41235       responses:
41236         "default":
41237           description: Response codes found in [response codes](https://wiki.onap.org/).
41238       parameters:
41239         - name: pnf-name
41240           in: path
41241           description: unique name of Physical Network Function.
41242           required: true
41243           type: string
41244           example: __PNF-NAME__
41245         - name: interface-name
41246           in: path
41247           description: Name that identifies the physical interface
41248           required: true
41249           type: string
41250           example: __INTERFACE-NAME__
41251         - name: interface-name
41252           in: path
41253           description: Name given to the interface
41254           required: true
41255           type: string
41256           example: __INTERFACE-NAME__
41257         - name: vlan-interface
41258           in: path
41259           description: String that identifies the interface
41260           required: true
41261           type: string
41262           example: __VLAN-INTERFACE__
41263         - name: l3-interface-ipv4-address
41264           in: path
41265           description: IP address
41266           required: true
41267           type: string
41268           example: __L3-INTERFACE-IPV4-ADDRESS__
41269         - name: body
41270           in: body
41271           description: l3-interface-ipv4-address-list object that needs to be created or updated.
41272           required: true
41273           schema:
41274             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
41275     delete:
41276       tags:
41277         - Network
41278       summary: delete an existing l3-interface-ipv4-address-list
41279       description: delete an existing l3-interface-ipv4-address-list
41280       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
41281       consumes:
41282         - application/json
41283         - application/xml
41284       produces:
41285         - application/json
41286         - application/xml
41287       responses:
41288         "default":
41289           description: Response codes found in [response codes](https://wiki.onap.org/).
41290       parameters:
41291         - name: pnf-name
41292           in: path
41293           description: unique name of Physical Network Function.
41294           required: true
41295           type: string
41296           example: __PNF-NAME__
41297         - name: interface-name
41298           in: path
41299           description: Name that identifies the physical interface
41300           required: true
41301           type: string
41302           example: __INTERFACE-NAME__
41303         - name: interface-name
41304           in: path
41305           description: Name given to the interface
41306           required: true
41307           type: string
41308           example: __INTERFACE-NAME__
41309         - name: vlan-interface
41310           in: path
41311           description: String that identifies the interface
41312           required: true
41313           type: string
41314           example: __VLAN-INTERFACE__
41315         - name: l3-interface-ipv4-address
41316           in: path
41317           description: IP address
41318           required: true
41319           type: string
41320           example: __L3-INTERFACE-IPV4-ADDRESS__
41321         - name: resource-version
41322           in: query
41323           description: resource-version for concurrency
41324           required: true
41325           type: string
41326   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
41327     put:
41328       tags:
41329         - Network
41330       summary: see node definition for valid relationships
41331       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
41332       consumes:
41333         - application/json
41334         - application/xml
41335       produces:
41336         - application/json
41337         - application/xml
41338       responses:
41339         "default":
41340           description: Response codes found in [response codes](https://wiki.onap.org/).
41341       parameters:
41342         - name: pnf-name
41343           in: path
41344           description: unique name of Physical Network Function.
41345           required: true
41346           type: string
41347           example: __PNF-NAME__
41348         - name: interface-name
41349           in: path
41350           description: Name that identifies the physical interface
41351           required: true
41352           type: string
41353           example: __INTERFACE-NAME__
41354         - name: interface-name
41355           in: path
41356           description: Name given to the interface
41357           required: true
41358           type: string
41359           example: __INTERFACE-NAME__
41360         - name: vlan-interface
41361           in: path
41362           description: String that identifies the interface
41363           required: true
41364           type: string
41365           example: __VLAN-INTERFACE__
41366         - name: l3-interface-ipv6-address
41367           in: path
41368           description: IP address
41369           required: true
41370           type: string
41371           example: __L3-INTERFACE-IPV6-ADDRESS__
41372         - name: body
41373           in: body
41374           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
41375           required: true
41376           schema:
41377             $ref: "#/definitions/relationship"
41378     delete:
41379       tags:
41380         - Network
41381       summary: delete an existing relationship
41382       description: delete an existing relationship
41383       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
41384       consumes:
41385         - application/json
41386         - application/xml
41387       produces:
41388         - application/json
41389         - application/xml
41390       responses:
41391         "default":
41392           description: Response codes found in [response codes](https://wiki.onap.org/).
41393       parameters:
41394         - name: pnf-name
41395           in: path
41396           description: unique name of Physical Network Function.
41397           required: true
41398           type: string
41399           example: __PNF-NAME__
41400         - name: interface-name
41401           in: path
41402           description: Name that identifies the physical interface
41403           required: true
41404           type: string
41405           example: __INTERFACE-NAME__
41406         - name: interface-name
41407           in: path
41408           description: Name given to the interface
41409           required: true
41410           type: string
41411           example: __INTERFACE-NAME__
41412         - name: vlan-interface
41413           in: path
41414           description: String that identifies the interface
41415           required: true
41416           type: string
41417           example: __VLAN-INTERFACE__
41418         - name: l3-interface-ipv6-address
41419           in: path
41420           description: IP address
41421           required: true
41422           type: string
41423           example: __L3-INTERFACE-IPV6-ADDRESS__
41424   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
41425     get:
41426       tags:
41427         - Network
41428       summary: returns l3-interface-ipv6-address-list
41429       description: returns l3-interface-ipv6-address-list
41430       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
41431       produces:
41432         - application/json
41433         - application/xml
41434       responses:
41435         "200":
41436           description: successful operation
41437           schema:
41438               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
41439         "default":
41440           description: Response codes found in [response codes](https://wiki.onap.org/).
41441       parameters:
41442         - name: pnf-name
41443           in: path
41444           description: unique name of Physical Network Function.
41445           required: true
41446           type: string
41447           example: __PNF-NAME__
41448         - name: interface-name
41449           in: path
41450           description: Name that identifies the physical interface
41451           required: true
41452           type: string
41453           example: __INTERFACE-NAME__
41454         - name: interface-name
41455           in: path
41456           description: Name given to the interface
41457           required: true
41458           type: string
41459           example: __INTERFACE-NAME__
41460         - name: vlan-interface
41461           in: path
41462           description: String that identifies the interface
41463           required: true
41464           type: string
41465           example: __VLAN-INTERFACE__
41466         - name: l3-interface-ipv6-address
41467           in: path
41468           description: IP address
41469           required: true
41470           type: string
41471           example: __L3-INTERFACE-IPV6-ADDRESS__
41472         - name: inv-status
41473           in: query
41474           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
41475           required: false
41476           type: string
41477         - name: prov-status
41478           in: query
41479           description: Trigger for operational monitoring of this resource by Service Assurance systems.
41480           required: false
41481           type: string
41482         - name: interface-id
41483           in: query
41484           description: ID of interface
41485           required: false
41486           type: string
41487         - name: macaddr
41488           in: query
41489           description: MAC address for the interface
41490           required: false
41491           type: string
41492         - name: network-name
41493           in: query
41494           description: Name of the network
41495           required: false
41496           type: string
41497         - name: vlan-id-inner
41498           in: query
41499           description: Inner VLAN tag
41500           required: false
41501           type: integer
41502           format: int64
41503         - name: vpn-id
41504           in: query
41505           description: This indicates the customers VPN ID associated with this vlan
41506           required: false
41507           type: string
41508         - name: vlan-id-inner
41509           in: query
41510           description: Inner VLAN tag
41511           required: false
41512           type: integer
41513           format: int64
41514         - name: neutron-network-id
41515           in: query
41516           description: Neutron network id of the interface that address belongs to
41517           required: false
41518           type: string
41519         - name: neutron-subnet-id
41520           in: query
41521           description: Neutron id of subnet that address belongs to
41522           required: false
41523           type: string
41524     put:
41525       tags:
41526         - Network
41527       summary: create or update an existing l3-interface-ipv6-address-list
41528       description: |
41529         Create or update an existing l3-interface-ipv6-address-list.
41530         #
41531         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
41532       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
41533       consumes:
41534         - application/json
41535         - application/xml
41536       produces:
41537         - application/json
41538         - application/xml
41539       responses:
41540         "default":
41541           description: Response codes found in [response codes](https://wiki.onap.org/).
41542       parameters:
41543         - name: pnf-name
41544           in: path
41545           description: unique name of Physical Network Function.
41546           required: true
41547           type: string
41548           example: __PNF-NAME__
41549         - name: interface-name
41550           in: path
41551           description: Name that identifies the physical interface
41552           required: true
41553           type: string
41554           example: __INTERFACE-NAME__
41555         - name: interface-name
41556           in: path
41557           description: Name given to the interface
41558           required: true
41559           type: string
41560           example: __INTERFACE-NAME__
41561         - name: vlan-interface
41562           in: path
41563           description: String that identifies the interface
41564           required: true
41565           type: string
41566           example: __VLAN-INTERFACE__
41567         - name: l3-interface-ipv6-address
41568           in: path
41569           description: IP address
41570           required: true
41571           type: string
41572           example: __L3-INTERFACE-IPV6-ADDRESS__
41573         - name: body
41574           in: body
41575           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
41576           required: true
41577           schema:
41578             $ref: "#/definitions/l3-interface-ipv6-address-list"
41579     patch:
41580       tags:
41581         - Network
41582       summary: update an existing l3-interface-ipv6-address-list
41583       description: |
41584         Update an existing l3-interface-ipv6-address-list
41585         #
41586         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41587         The PUT operation will entirely replace an existing object.
41588         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
41589         #
41590         Other differences between PUT and PATCH are:
41591         #
41592         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
41593         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41594         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41595       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
41596       consumes:
41597         - application/json
41598         - application/xml
41599       produces:
41600         - application/json
41601         - application/xml
41602       responses:
41603         "default":
41604           description: Response codes found in [response codes](https://wiki.onap.org/).
41605       parameters:
41606         - name: pnf-name
41607           in: path
41608           description: unique name of Physical Network Function.
41609           required: true
41610           type: string
41611           example: __PNF-NAME__
41612         - name: interface-name
41613           in: path
41614           description: Name that identifies the physical interface
41615           required: true
41616           type: string
41617           example: __INTERFACE-NAME__
41618         - name: interface-name
41619           in: path
41620           description: Name given to the interface
41621           required: true
41622           type: string
41623           example: __INTERFACE-NAME__
41624         - name: vlan-interface
41625           in: path
41626           description: String that identifies the interface
41627           required: true
41628           type: string
41629           example: __VLAN-INTERFACE__
41630         - name: l3-interface-ipv6-address
41631           in: path
41632           description: IP address
41633           required: true
41634           type: string
41635           example: __L3-INTERFACE-IPV6-ADDRESS__
41636         - name: body
41637           in: body
41638           description: l3-interface-ipv6-address-list object that needs to be created or updated.
41639           required: true
41640           schema:
41641             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
41642     delete:
41643       tags:
41644         - Network
41645       summary: delete an existing l3-interface-ipv6-address-list
41646       description: delete an existing l3-interface-ipv6-address-list
41647       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
41648       consumes:
41649         - application/json
41650         - application/xml
41651       produces:
41652         - application/json
41653         - application/xml
41654       responses:
41655         "default":
41656           description: Response codes found in [response codes](https://wiki.onap.org/).
41657       parameters:
41658         - name: pnf-name
41659           in: path
41660           description: unique name of Physical Network Function.
41661           required: true
41662           type: string
41663           example: __PNF-NAME__
41664         - name: interface-name
41665           in: path
41666           description: Name that identifies the physical interface
41667           required: true
41668           type: string
41669           example: __INTERFACE-NAME__
41670         - name: interface-name
41671           in: path
41672           description: Name given to the interface
41673           required: true
41674           type: string
41675           example: __INTERFACE-NAME__
41676         - name: vlan-interface
41677           in: path
41678           description: String that identifies the interface
41679           required: true
41680           type: string
41681           example: __VLAN-INTERFACE__
41682         - name: l3-interface-ipv6-address
41683           in: path
41684           description: IP address
41685           required: true
41686           type: string
41687           example: __L3-INTERFACE-IPV6-ADDRESS__
41688         - name: resource-version
41689           in: query
41690           description: resource-version for concurrency
41691           required: true
41692           type: string
41693   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
41694     get:
41695       tags:
41696         - Network
41697       summary: returns vlan
41698       description: returns vlan
41699       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
41700       produces:
41701         - application/json
41702         - application/xml
41703       responses:
41704         "200":
41705           description: successful operation
41706           schema:
41707               $ref: "#/getDefinitions/vlan"
41708         "default":
41709           description: Response codes found in [response codes](https://wiki.onap.org/).
41710       parameters:
41711         - name: pnf-name
41712           in: path
41713           description: unique name of Physical Network Function.
41714           required: true
41715           type: string
41716           example: __PNF-NAME__
41717         - name: interface-name
41718           in: path
41719           description: Name that identifies the physical interface
41720           required: true
41721           type: string
41722           example: __INTERFACE-NAME__
41723         - name: interface-name
41724           in: path
41725           description: Name given to the interface
41726           required: true
41727           type: string
41728           example: __INTERFACE-NAME__
41729         - name: vlan-interface
41730           in: path
41731           description: String that identifies the interface
41732           required: true
41733           type: string
41734           example: __VLAN-INTERFACE__
41735         - name: inv-status
41736           in: query
41737           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
41738           required: false
41739           type: string
41740         - name: prov-status
41741           in: query
41742           description: Trigger for operational monitoring of this resource by Service Assurance systems.
41743           required: false
41744           type: string
41745         - name: interface-id
41746           in: query
41747           description: ID of interface
41748           required: false
41749           type: string
41750         - name: macaddr
41751           in: query
41752           description: MAC address for the interface
41753           required: false
41754           type: string
41755         - name: network-name
41756           in: query
41757           description: Name of the network
41758           required: false
41759           type: string
41760         - name: vlan-id-inner
41761           in: query
41762           description: Inner VLAN tag
41763           required: false
41764           type: integer
41765           format: int64
41766         - name: vpn-id
41767           in: query
41768           description: This indicates the customers VPN ID associated with this vlan
41769           required: false
41770           type: string
41771     put:
41772       tags:
41773         - Network
41774       summary: create or update an existing vlan
41775       description: |
41776         Create or update an existing vlan.
41777         #
41778         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
41779       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
41780       consumes:
41781         - application/json
41782         - application/xml
41783       produces:
41784         - application/json
41785         - application/xml
41786       responses:
41787         "default":
41788           description: Response codes found in [response codes](https://wiki.onap.org/).
41789       parameters:
41790         - name: pnf-name
41791           in: path
41792           description: unique name of Physical Network Function.
41793           required: true
41794           type: string
41795           example: __PNF-NAME__
41796         - name: interface-name
41797           in: path
41798           description: Name that identifies the physical interface
41799           required: true
41800           type: string
41801           example: __INTERFACE-NAME__
41802         - name: interface-name
41803           in: path
41804           description: Name given to the interface
41805           required: true
41806           type: string
41807           example: __INTERFACE-NAME__
41808         - name: vlan-interface
41809           in: path
41810           description: String that identifies the interface
41811           required: true
41812           type: string
41813           example: __VLAN-INTERFACE__
41814         - name: body
41815           in: body
41816           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
41817           required: true
41818           schema:
41819             $ref: "#/definitions/vlan"
41820     patch:
41821       tags:
41822         - Network
41823       summary: update an existing vlan
41824       description: |
41825         Update an existing vlan
41826         #
41827         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41828         The PUT operation will entirely replace an existing object.
41829         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
41830         #
41831         Other differences between PUT and PATCH are:
41832         #
41833         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
41834         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41835         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41836       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
41837       consumes:
41838         - application/json
41839         - application/xml
41840       produces:
41841         - application/json
41842         - application/xml
41843       responses:
41844         "default":
41845           description: Response codes found in [response codes](https://wiki.onap.org/).
41846       parameters:
41847         - name: pnf-name
41848           in: path
41849           description: unique name of Physical Network Function.
41850           required: true
41851           type: string
41852           example: __PNF-NAME__
41853         - name: interface-name
41854           in: path
41855           description: Name that identifies the physical interface
41856           required: true
41857           type: string
41858           example: __INTERFACE-NAME__
41859         - name: interface-name
41860           in: path
41861           description: Name given to the interface
41862           required: true
41863           type: string
41864           example: __INTERFACE-NAME__
41865         - name: vlan-interface
41866           in: path
41867           description: String that identifies the interface
41868           required: true
41869           type: string
41870           example: __VLAN-INTERFACE__
41871         - name: body
41872           in: body
41873           description: vlan object that needs to be created or updated.
41874           required: true
41875           schema:
41876             $ref: "#/patchDefinitions/vlan"
41877     delete:
41878       tags:
41879         - Network
41880       summary: delete an existing vlan
41881       description: delete an existing vlan
41882       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
41883       consumes:
41884         - application/json
41885         - application/xml
41886       produces:
41887         - application/json
41888         - application/xml
41889       responses:
41890         "default":
41891           description: Response codes found in [response codes](https://wiki.onap.org/).
41892       parameters:
41893         - name: pnf-name
41894           in: path
41895           description: unique name of Physical Network Function.
41896           required: true
41897           type: string
41898           example: __PNF-NAME__
41899         - name: interface-name
41900           in: path
41901           description: Name that identifies the physical interface
41902           required: true
41903           type: string
41904           example: __INTERFACE-NAME__
41905         - name: interface-name
41906           in: path
41907           description: Name given to the interface
41908           required: true
41909           type: string
41910           example: __INTERFACE-NAME__
41911         - name: vlan-interface
41912           in: path
41913           description: String that identifies the interface
41914           required: true
41915           type: string
41916           example: __VLAN-INTERFACE__
41917         - name: resource-version
41918           in: query
41919           description: resource-version for concurrency
41920           required: true
41921           type: string
41922   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
41923     get:
41924       tags:
41925         - Network
41926       summary: returns vlans
41927       description: returns vlans
41928       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlans
41929       produces:
41930         - application/json
41931         - application/xml
41932       responses:
41933         "200":
41934           description: successful operation
41935           schema:
41936               $ref: "#/getDefinitions/vlans"
41937         "default":
41938           description: Response codes found in [response codes](https://wiki.onap.org/).
41939       parameters:
41940         - name: pnf-name
41941           in: path
41942           description: unique name of Physical Network Function.
41943           required: true
41944           type: string
41945           example: __PNF-NAME__
41946         - name: interface-name
41947           in: path
41948           description: Name that identifies the physical interface
41949           required: true
41950           type: string
41951           example: __INTERFACE-NAME__
41952         - name: interface-name
41953           in: path
41954           description: Name given to the interface
41955           required: true
41956           type: string
41957           example: __INTERFACE-NAME__
41958         - name: inv-status
41959           in: query
41960           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
41961           required: false
41962           type: string
41963         - name: prov-status
41964           in: query
41965           description: Trigger for operational monitoring of this resource by Service Assurance systems.
41966           required: false
41967           type: string
41968         - name: interface-id
41969           in: query
41970           description: ID of interface
41971           required: false
41972           type: string
41973         - name: macaddr
41974           in: query
41975           description: MAC address for the interface
41976           required: false
41977           type: string
41978         - name: network-name
41979           in: query
41980           description: Name of the network
41981           required: false
41982           type: string
41983   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
41984     put:
41985       tags:
41986         - Network
41987       summary: see node definition for valid relationships
41988       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
41989       consumes:
41990         - application/json
41991         - application/xml
41992       produces:
41993         - application/json
41994         - application/xml
41995       responses:
41996         "default":
41997           description: Response codes found in [response codes](https://wiki.onap.org/).
41998       parameters:
41999         - name: pnf-name
42000           in: path
42001           description: unique name of Physical Network Function.
42002           required: true
42003           type: string
42004           example: __PNF-NAME__
42005         - name: interface-name
42006           in: path
42007           description: Name that identifies the physical interface
42008           required: true
42009           type: string
42010           example: __INTERFACE-NAME__
42011         - name: interface-name
42012           in: path
42013           description: Name given to the interface
42014           required: true
42015           type: string
42016           example: __INTERFACE-NAME__
42017         - name: pci-id
42018           in: path
42019           description: PCI ID used to identify the sriov-vf
42020           required: true
42021           type: string
42022           example: __PCI-ID__
42023         - name: body
42024           in: body
42025           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
42026           required: true
42027           schema:
42028             $ref: "#/definitions/relationship"
42029     delete:
42030       tags:
42031         - Network
42032       summary: delete an existing relationship
42033       description: delete an existing relationship
42034       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
42035       consumes:
42036         - application/json
42037         - application/xml
42038       produces:
42039         - application/json
42040         - application/xml
42041       responses:
42042         "default":
42043           description: Response codes found in [response codes](https://wiki.onap.org/).
42044       parameters:
42045         - name: pnf-name
42046           in: path
42047           description: unique name of Physical Network Function.
42048           required: true
42049           type: string
42050           example: __PNF-NAME__
42051         - name: interface-name
42052           in: path
42053           description: Name that identifies the physical interface
42054           required: true
42055           type: string
42056           example: __INTERFACE-NAME__
42057         - name: interface-name
42058           in: path
42059           description: Name given to the interface
42060           required: true
42061           type: string
42062           example: __INTERFACE-NAME__
42063         - name: pci-id
42064           in: path
42065           description: PCI ID used to identify the sriov-vf
42066           required: true
42067           type: string
42068           example: __PCI-ID__
42069   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
42070     get:
42071       tags:
42072         - Network
42073       summary: returns sriov-vf
42074       description: returns sriov-vf
42075       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
42076       produces:
42077         - application/json
42078         - application/xml
42079       responses:
42080         "200":
42081           description: successful operation
42082           schema:
42083               $ref: "#/getDefinitions/sriov-vf"
42084         "default":
42085           description: Response codes found in [response codes](https://wiki.onap.org/).
42086       parameters:
42087         - name: pnf-name
42088           in: path
42089           description: unique name of Physical Network Function.
42090           required: true
42091           type: string
42092           example: __PNF-NAME__
42093         - name: interface-name
42094           in: path
42095           description: Name that identifies the physical interface
42096           required: true
42097           type: string
42098           example: __INTERFACE-NAME__
42099         - name: interface-name
42100           in: path
42101           description: Name given to the interface
42102           required: true
42103           type: string
42104           example: __INTERFACE-NAME__
42105         - name: pci-id
42106           in: path
42107           description: PCI ID used to identify the sriov-vf
42108           required: true
42109           type: string
42110           example: __PCI-ID__
42111         - name: inv-status
42112           in: query
42113           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
42114           required: false
42115           type: string
42116         - name: prov-status
42117           in: query
42118           description: Trigger for operational monitoring of this resource by Service Assurance systems.
42119           required: false
42120           type: string
42121         - name: interface-id
42122           in: query
42123           description: ID of interface
42124           required: false
42125           type: string
42126         - name: macaddr
42127           in: query
42128           description: MAC address for the interface
42129           required: false
42130           type: string
42131         - name: network-name
42132           in: query
42133           description: Name of the network
42134           required: false
42135           type: string
42136         - name: vf-vlan-filter
42137           in: query
42138           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
42139           required: false
42140           type: string
42141         - name: vf-mac-filter
42142           in: query
42143           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
42144           required: false
42145           type: string
42146         - name: vf-vlan-strip
42147           in: query
42148           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
42149           required: false
42150           type: boolean
42151         - name: neutron-network-id
42152           in: query
42153           description: Neutron network id of the interface
42154           required: false
42155           type: string
42156     put:
42157       tags:
42158         - Network
42159       summary: create or update an existing sriov-vf
42160       description: |
42161         Create or update an existing sriov-vf.
42162         #
42163         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
42164       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
42165       consumes:
42166         - application/json
42167         - application/xml
42168       produces:
42169         - application/json
42170         - application/xml
42171       responses:
42172         "default":
42173           description: Response codes found in [response codes](https://wiki.onap.org/).
42174       parameters:
42175         - name: pnf-name
42176           in: path
42177           description: unique name of Physical Network Function.
42178           required: true
42179           type: string
42180           example: __PNF-NAME__
42181         - name: interface-name
42182           in: path
42183           description: Name that identifies the physical interface
42184           required: true
42185           type: string
42186           example: __INTERFACE-NAME__
42187         - name: interface-name
42188           in: path
42189           description: Name given to the interface
42190           required: true
42191           type: string
42192           example: __INTERFACE-NAME__
42193         - name: pci-id
42194           in: path
42195           description: PCI ID used to identify the sriov-vf
42196           required: true
42197           type: string
42198           example: __PCI-ID__
42199         - name: body
42200           in: body
42201           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
42202           required: true
42203           schema:
42204             $ref: "#/definitions/sriov-vf"
42205     patch:
42206       tags:
42207         - Network
42208       summary: update an existing sriov-vf
42209       description: |
42210         Update an existing sriov-vf
42211         #
42212         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42213         The PUT operation will entirely replace an existing object.
42214         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
42215         #
42216         Other differences between PUT and PATCH are:
42217         #
42218         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
42219         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42220         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42221       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
42222       consumes:
42223         - application/json
42224         - application/xml
42225       produces:
42226         - application/json
42227         - application/xml
42228       responses:
42229         "default":
42230           description: Response codes found in [response codes](https://wiki.onap.org/).
42231       parameters:
42232         - name: pnf-name
42233           in: path
42234           description: unique name of Physical Network Function.
42235           required: true
42236           type: string
42237           example: __PNF-NAME__
42238         - name: interface-name
42239           in: path
42240           description: Name that identifies the physical interface
42241           required: true
42242           type: string
42243           example: __INTERFACE-NAME__
42244         - name: interface-name
42245           in: path
42246           description: Name given to the interface
42247           required: true
42248           type: string
42249           example: __INTERFACE-NAME__
42250         - name: pci-id
42251           in: path
42252           description: PCI ID used to identify the sriov-vf
42253           required: true
42254           type: string
42255           example: __PCI-ID__
42256         - name: body
42257           in: body
42258           description: sriov-vf object that needs to be created or updated.
42259           required: true
42260           schema:
42261             $ref: "#/patchDefinitions/sriov-vf"
42262     delete:
42263       tags:
42264         - Network
42265       summary: delete an existing sriov-vf
42266       description: delete an existing sriov-vf
42267       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
42268       consumes:
42269         - application/json
42270         - application/xml
42271       produces:
42272         - application/json
42273         - application/xml
42274       responses:
42275         "default":
42276           description: Response codes found in [response codes](https://wiki.onap.org/).
42277       parameters:
42278         - name: pnf-name
42279           in: path
42280           description: unique name of Physical Network Function.
42281           required: true
42282           type: string
42283           example: __PNF-NAME__
42284         - name: interface-name
42285           in: path
42286           description: Name that identifies the physical interface
42287           required: true
42288           type: string
42289           example: __INTERFACE-NAME__
42290         - name: interface-name
42291           in: path
42292           description: Name given to the interface
42293           required: true
42294           type: string
42295           example: __INTERFACE-NAME__
42296         - name: pci-id
42297           in: path
42298           description: PCI ID used to identify the sriov-vf
42299           required: true
42300           type: string
42301           example: __PCI-ID__
42302         - name: resource-version
42303           in: query
42304           description: resource-version for concurrency
42305           required: true
42306           type: string
42307   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
42308     get:
42309       tags:
42310         - Network
42311       summary: returns sriov-vfs
42312       description: returns sriov-vfs
42313       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
42314       produces:
42315         - application/json
42316         - application/xml
42317       responses:
42318         "200":
42319           description: successful operation
42320           schema:
42321               $ref: "#/getDefinitions/sriov-vfs"
42322         "default":
42323           description: Response codes found in [response codes](https://wiki.onap.org/).
42324       parameters:
42325         - name: pnf-name
42326           in: path
42327           description: unique name of Physical Network Function.
42328           required: true
42329           type: string
42330           example: __PNF-NAME__
42331         - name: interface-name
42332           in: path
42333           description: Name that identifies the physical interface
42334           required: true
42335           type: string
42336           example: __INTERFACE-NAME__
42337         - name: interface-name
42338           in: path
42339           description: Name given to the interface
42340           required: true
42341           type: string
42342           example: __INTERFACE-NAME__
42343         - name: inv-status
42344           in: query
42345           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
42346           required: false
42347           type: string
42348         - name: prov-status
42349           in: query
42350           description: Trigger for operational monitoring of this resource by Service Assurance systems.
42351           required: false
42352           type: string
42353         - name: interface-id
42354           in: query
42355           description: ID of interface
42356           required: false
42357           type: string
42358         - name: macaddr
42359           in: query
42360           description: MAC address for the interface
42361           required: false
42362           type: string
42363         - name: network-name
42364           in: query
42365           description: Name of the network
42366           required: false
42367           type: string
42368   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
42369     put:
42370       tags:
42371         - Network
42372       summary: see node definition for valid relationships
42373       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
42374       consumes:
42375         - application/json
42376         - application/xml
42377       produces:
42378         - application/json
42379         - application/xml
42380       responses:
42381         "default":
42382           description: Response codes found in [response codes](https://wiki.onap.org/).
42383       parameters:
42384         - name: pnf-name
42385           in: path
42386           description: unique name of Physical Network Function.
42387           required: true
42388           type: string
42389           example: __PNF-NAME__
42390         - name: interface-name
42391           in: path
42392           description: Name that identifies the physical interface
42393           required: true
42394           type: string
42395           example: __INTERFACE-NAME__
42396         - name: interface-name
42397           in: path
42398           description: Name given to the interface
42399           required: true
42400           type: string
42401           example: __INTERFACE-NAME__
42402         - name: body
42403           in: body
42404           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
42405           required: true
42406           schema:
42407             $ref: "#/definitions/relationship"
42408     delete:
42409       tags:
42410         - Network
42411       summary: delete an existing relationship
42412       description: delete an existing relationship
42413       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
42414       consumes:
42415         - application/json
42416         - application/xml
42417       produces:
42418         - application/json
42419         - application/xml
42420       responses:
42421         "default":
42422           description: Response codes found in [response codes](https://wiki.onap.org/).
42423       parameters:
42424         - name: pnf-name
42425           in: path
42426           description: unique name of Physical Network Function.
42427           required: true
42428           type: string
42429           example: __PNF-NAME__
42430         - name: interface-name
42431           in: path
42432           description: Name that identifies the physical interface
42433           required: true
42434           type: string
42435           example: __INTERFACE-NAME__
42436         - name: interface-name
42437           in: path
42438           description: Name given to the interface
42439           required: true
42440           type: string
42441           example: __INTERFACE-NAME__
42442   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
42443     put:
42444       tags:
42445         - Network
42446       summary: see node definition for valid relationships
42447       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
42448       consumes:
42449         - application/json
42450         - application/xml
42451       produces:
42452         - application/json
42453         - application/xml
42454       responses:
42455         "default":
42456           description: Response codes found in [response codes](https://wiki.onap.org/).
42457       parameters:
42458         - name: pnf-name
42459           in: path
42460           description: unique name of Physical Network Function.
42461           required: true
42462           type: string
42463           example: __PNF-NAME__
42464         - name: interface-name
42465           in: path
42466           description: Name that identifies the physical interface
42467           required: true
42468           type: string
42469           example: __INTERFACE-NAME__
42470         - name: interface-name
42471           in: path
42472           description: Name given to the interface
42473           required: true
42474           type: string
42475           example: __INTERFACE-NAME__
42476         - name: l3-interface-ipv4-address
42477           in: path
42478           description: IP address
42479           required: true
42480           type: string
42481           example: __L3-INTERFACE-IPV4-ADDRESS__
42482         - name: body
42483           in: body
42484           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
42485           required: true
42486           schema:
42487             $ref: "#/definitions/relationship"
42488     delete:
42489       tags:
42490         - Network
42491       summary: delete an existing relationship
42492       description: delete an existing relationship
42493       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
42494       consumes:
42495         - application/json
42496         - application/xml
42497       produces:
42498         - application/json
42499         - application/xml
42500       responses:
42501         "default":
42502           description: Response codes found in [response codes](https://wiki.onap.org/).
42503       parameters:
42504         - name: pnf-name
42505           in: path
42506           description: unique name of Physical Network Function.
42507           required: true
42508           type: string
42509           example: __PNF-NAME__
42510         - name: interface-name
42511           in: path
42512           description: Name that identifies the physical interface
42513           required: true
42514           type: string
42515           example: __INTERFACE-NAME__
42516         - name: interface-name
42517           in: path
42518           description: Name given to the interface
42519           required: true
42520           type: string
42521           example: __INTERFACE-NAME__
42522         - name: l3-interface-ipv4-address
42523           in: path
42524           description: IP address
42525           required: true
42526           type: string
42527           example: __L3-INTERFACE-IPV4-ADDRESS__
42528   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
42529     get:
42530       tags:
42531         - Network
42532       summary: returns l3-interface-ipv4-address-list
42533       description: returns l3-interface-ipv4-address-list
42534       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
42535       produces:
42536         - application/json
42537         - application/xml
42538       responses:
42539         "200":
42540           description: successful operation
42541           schema:
42542               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
42543         "default":
42544           description: Response codes found in [response codes](https://wiki.onap.org/).
42545       parameters:
42546         - name: pnf-name
42547           in: path
42548           description: unique name of Physical Network Function.
42549           required: true
42550           type: string
42551           example: __PNF-NAME__
42552         - name: interface-name
42553           in: path
42554           description: Name that identifies the physical interface
42555           required: true
42556           type: string
42557           example: __INTERFACE-NAME__
42558         - name: interface-name
42559           in: path
42560           description: Name given to the interface
42561           required: true
42562           type: string
42563           example: __INTERFACE-NAME__
42564         - name: l3-interface-ipv4-address
42565           in: path
42566           description: IP address
42567           required: true
42568           type: string
42569           example: __L3-INTERFACE-IPV4-ADDRESS__
42570         - name: inv-status
42571           in: query
42572           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
42573           required: false
42574           type: string
42575         - name: prov-status
42576           in: query
42577           description: Trigger for operational monitoring of this resource by Service Assurance systems.
42578           required: false
42579           type: string
42580         - name: interface-id
42581           in: query
42582           description: ID of interface
42583           required: false
42584           type: string
42585         - name: macaddr
42586           in: query
42587           description: MAC address for the interface
42588           required: false
42589           type: string
42590         - name: network-name
42591           in: query
42592           description: Name of the network
42593           required: false
42594           type: string
42595         - name: vlan-id-inner
42596           in: query
42597           description: Inner VLAN tag
42598           required: false
42599           type: integer
42600           format: int64
42601         - name: neutron-network-id
42602           in: query
42603           description: Neutron network id of the interface that address belongs to
42604           required: false
42605           type: string
42606         - name: neutron-subnet-id
42607           in: query
42608           description: Neutron id of subnet that address belongs to
42609           required: false
42610           type: string
42611     put:
42612       tags:
42613         - Network
42614       summary: create or update an existing l3-interface-ipv4-address-list
42615       description: |
42616         Create or update an existing l3-interface-ipv4-address-list.
42617         #
42618         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
42619       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
42620       consumes:
42621         - application/json
42622         - application/xml
42623       produces:
42624         - application/json
42625         - application/xml
42626       responses:
42627         "default":
42628           description: Response codes found in [response codes](https://wiki.onap.org/).
42629       parameters:
42630         - name: pnf-name
42631           in: path
42632           description: unique name of Physical Network Function.
42633           required: true
42634           type: string
42635           example: __PNF-NAME__
42636         - name: interface-name
42637           in: path
42638           description: Name that identifies the physical interface
42639           required: true
42640           type: string
42641           example: __INTERFACE-NAME__
42642         - name: interface-name
42643           in: path
42644           description: Name given to the interface
42645           required: true
42646           type: string
42647           example: __INTERFACE-NAME__
42648         - name: l3-interface-ipv4-address
42649           in: path
42650           description: IP address
42651           required: true
42652           type: string
42653           example: __L3-INTERFACE-IPV4-ADDRESS__
42654         - name: body
42655           in: body
42656           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
42657           required: true
42658           schema:
42659             $ref: "#/definitions/l3-interface-ipv4-address-list"
42660     patch:
42661       tags:
42662         - Network
42663       summary: update an existing l3-interface-ipv4-address-list
42664       description: |
42665         Update an existing l3-interface-ipv4-address-list
42666         #
42667         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42668         The PUT operation will entirely replace an existing object.
42669         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
42670         #
42671         Other differences between PUT and PATCH are:
42672         #
42673         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
42674         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42675         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42676       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
42677       consumes:
42678         - application/json
42679         - application/xml
42680       produces:
42681         - application/json
42682         - application/xml
42683       responses:
42684         "default":
42685           description: Response codes found in [response codes](https://wiki.onap.org/).
42686       parameters:
42687         - name: pnf-name
42688           in: path
42689           description: unique name of Physical Network Function.
42690           required: true
42691           type: string
42692           example: __PNF-NAME__
42693         - name: interface-name
42694           in: path
42695           description: Name that identifies the physical interface
42696           required: true
42697           type: string
42698           example: __INTERFACE-NAME__
42699         - name: interface-name
42700           in: path
42701           description: Name given to the interface
42702           required: true
42703           type: string
42704           example: __INTERFACE-NAME__
42705         - name: l3-interface-ipv4-address
42706           in: path
42707           description: IP address
42708           required: true
42709           type: string
42710           example: __L3-INTERFACE-IPV4-ADDRESS__
42711         - name: body
42712           in: body
42713           description: l3-interface-ipv4-address-list object that needs to be created or updated.
42714           required: true
42715           schema:
42716             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
42717     delete:
42718       tags:
42719         - Network
42720       summary: delete an existing l3-interface-ipv4-address-list
42721       description: delete an existing l3-interface-ipv4-address-list
42722       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
42723       consumes:
42724         - application/json
42725         - application/xml
42726       produces:
42727         - application/json
42728         - application/xml
42729       responses:
42730         "default":
42731           description: Response codes found in [response codes](https://wiki.onap.org/).
42732       parameters:
42733         - name: pnf-name
42734           in: path
42735           description: unique name of Physical Network Function.
42736           required: true
42737           type: string
42738           example: __PNF-NAME__
42739         - name: interface-name
42740           in: path
42741           description: Name that identifies the physical interface
42742           required: true
42743           type: string
42744           example: __INTERFACE-NAME__
42745         - name: interface-name
42746           in: path
42747           description: Name given to the interface
42748           required: true
42749           type: string
42750           example: __INTERFACE-NAME__
42751         - name: l3-interface-ipv4-address
42752           in: path
42753           description: IP address
42754           required: true
42755           type: string
42756           example: __L3-INTERFACE-IPV4-ADDRESS__
42757         - name: resource-version
42758           in: query
42759           description: resource-version for concurrency
42760           required: true
42761           type: string
42762   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
42763     put:
42764       tags:
42765         - Network
42766       summary: see node definition for valid relationships
42767       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
42768       consumes:
42769         - application/json
42770         - application/xml
42771       produces:
42772         - application/json
42773         - application/xml
42774       responses:
42775         "default":
42776           description: Response codes found in [response codes](https://wiki.onap.org/).
42777       parameters:
42778         - name: pnf-name
42779           in: path
42780           description: unique name of Physical Network Function.
42781           required: true
42782           type: string
42783           example: __PNF-NAME__
42784         - name: interface-name
42785           in: path
42786           description: Name that identifies the physical interface
42787           required: true
42788           type: string
42789           example: __INTERFACE-NAME__
42790         - name: interface-name
42791           in: path
42792           description: Name given to the interface
42793           required: true
42794           type: string
42795           example: __INTERFACE-NAME__
42796         - name: l3-interface-ipv6-address
42797           in: path
42798           description: IP address
42799           required: true
42800           type: string
42801           example: __L3-INTERFACE-IPV6-ADDRESS__
42802         - name: body
42803           in: body
42804           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
42805           required: true
42806           schema:
42807             $ref: "#/definitions/relationship"
42808     delete:
42809       tags:
42810         - Network
42811       summary: delete an existing relationship
42812       description: delete an existing relationship
42813       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
42814       consumes:
42815         - application/json
42816         - application/xml
42817       produces:
42818         - application/json
42819         - application/xml
42820       responses:
42821         "default":
42822           description: Response codes found in [response codes](https://wiki.onap.org/).
42823       parameters:
42824         - name: pnf-name
42825           in: path
42826           description: unique name of Physical Network Function.
42827           required: true
42828           type: string
42829           example: __PNF-NAME__
42830         - name: interface-name
42831           in: path
42832           description: Name that identifies the physical interface
42833           required: true
42834           type: string
42835           example: __INTERFACE-NAME__
42836         - name: interface-name
42837           in: path
42838           description: Name given to the interface
42839           required: true
42840           type: string
42841           example: __INTERFACE-NAME__
42842         - name: l3-interface-ipv6-address
42843           in: path
42844           description: IP address
42845           required: true
42846           type: string
42847           example: __L3-INTERFACE-IPV6-ADDRESS__
42848   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
42849     get:
42850       tags:
42851         - Network
42852       summary: returns l3-interface-ipv6-address-list
42853       description: returns l3-interface-ipv6-address-list
42854       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
42855       produces:
42856         - application/json
42857         - application/xml
42858       responses:
42859         "200":
42860           description: successful operation
42861           schema:
42862               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
42863         "default":
42864           description: Response codes found in [response codes](https://wiki.onap.org/).
42865       parameters:
42866         - name: pnf-name
42867           in: path
42868           description: unique name of Physical Network Function.
42869           required: true
42870           type: string
42871           example: __PNF-NAME__
42872         - name: interface-name
42873           in: path
42874           description: Name that identifies the physical interface
42875           required: true
42876           type: string
42877           example: __INTERFACE-NAME__
42878         - name: interface-name
42879           in: path
42880           description: Name given to the interface
42881           required: true
42882           type: string
42883           example: __INTERFACE-NAME__
42884         - name: l3-interface-ipv6-address
42885           in: path
42886           description: IP address
42887           required: true
42888           type: string
42889           example: __L3-INTERFACE-IPV6-ADDRESS__
42890         - name: inv-status
42891           in: query
42892           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
42893           required: false
42894           type: string
42895         - name: prov-status
42896           in: query
42897           description: Trigger for operational monitoring of this resource by Service Assurance systems.
42898           required: false
42899           type: string
42900         - name: interface-id
42901           in: query
42902           description: ID of interface
42903           required: false
42904           type: string
42905         - name: macaddr
42906           in: query
42907           description: MAC address for the interface
42908           required: false
42909           type: string
42910         - name: network-name
42911           in: query
42912           description: Name of the network
42913           required: false
42914           type: string
42915         - name: vlan-id-inner
42916           in: query
42917           description: Inner VLAN tag
42918           required: false
42919           type: integer
42920           format: int64
42921         - name: neutron-network-id
42922           in: query
42923           description: Neutron network id of the interface that address belongs to
42924           required: false
42925           type: string
42926         - name: neutron-subnet-id
42927           in: query
42928           description: Neutron id of subnet that address belongs to
42929           required: false
42930           type: string
42931     put:
42932       tags:
42933         - Network
42934       summary: create or update an existing l3-interface-ipv6-address-list
42935       description: |
42936         Create or update an existing l3-interface-ipv6-address-list.
42937         #
42938         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
42939       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
42940       consumes:
42941         - application/json
42942         - application/xml
42943       produces:
42944         - application/json
42945         - application/xml
42946       responses:
42947         "default":
42948           description: Response codes found in [response codes](https://wiki.onap.org/).
42949       parameters:
42950         - name: pnf-name
42951           in: path
42952           description: unique name of Physical Network Function.
42953           required: true
42954           type: string
42955           example: __PNF-NAME__
42956         - name: interface-name
42957           in: path
42958           description: Name that identifies the physical interface
42959           required: true
42960           type: string
42961           example: __INTERFACE-NAME__
42962         - name: interface-name
42963           in: path
42964           description: Name given to the interface
42965           required: true
42966           type: string
42967           example: __INTERFACE-NAME__
42968         - name: l3-interface-ipv6-address
42969           in: path
42970           description: IP address
42971           required: true
42972           type: string
42973           example: __L3-INTERFACE-IPV6-ADDRESS__
42974         - name: body
42975           in: body
42976           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
42977           required: true
42978           schema:
42979             $ref: "#/definitions/l3-interface-ipv6-address-list"
42980     patch:
42981       tags:
42982         - Network
42983       summary: update an existing l3-interface-ipv6-address-list
42984       description: |
42985         Update an existing l3-interface-ipv6-address-list
42986         #
42987         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42988         The PUT operation will entirely replace an existing object.
42989         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
42990         #
42991         Other differences between PUT and PATCH are:
42992         #
42993         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
42994         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42995         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42996       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
42997       consumes:
42998         - application/json
42999         - application/xml
43000       produces:
43001         - application/json
43002         - application/xml
43003       responses:
43004         "default":
43005           description: Response codes found in [response codes](https://wiki.onap.org/).
43006       parameters:
43007         - name: pnf-name
43008           in: path
43009           description: unique name of Physical Network Function.
43010           required: true
43011           type: string
43012           example: __PNF-NAME__
43013         - name: interface-name
43014           in: path
43015           description: Name that identifies the physical interface
43016           required: true
43017           type: string
43018           example: __INTERFACE-NAME__
43019         - name: interface-name
43020           in: path
43021           description: Name given to the interface
43022           required: true
43023           type: string
43024           example: __INTERFACE-NAME__
43025         - name: l3-interface-ipv6-address
43026           in: path
43027           description: IP address
43028           required: true
43029           type: string
43030           example: __L3-INTERFACE-IPV6-ADDRESS__
43031         - name: body
43032           in: body
43033           description: l3-interface-ipv6-address-list object that needs to be created or updated.
43034           required: true
43035           schema:
43036             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
43037     delete:
43038       tags:
43039         - Network
43040       summary: delete an existing l3-interface-ipv6-address-list
43041       description: delete an existing l3-interface-ipv6-address-list
43042       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
43043       consumes:
43044         - application/json
43045         - application/xml
43046       produces:
43047         - application/json
43048         - application/xml
43049       responses:
43050         "default":
43051           description: Response codes found in [response codes](https://wiki.onap.org/).
43052       parameters:
43053         - name: pnf-name
43054           in: path
43055           description: unique name of Physical Network Function.
43056           required: true
43057           type: string
43058           example: __PNF-NAME__
43059         - name: interface-name
43060           in: path
43061           description: Name that identifies the physical interface
43062           required: true
43063           type: string
43064           example: __INTERFACE-NAME__
43065         - name: interface-name
43066           in: path
43067           description: Name given to the interface
43068           required: true
43069           type: string
43070           example: __INTERFACE-NAME__
43071         - name: l3-interface-ipv6-address
43072           in: path
43073           description: IP address
43074           required: true
43075           type: string
43076           example: __L3-INTERFACE-IPV6-ADDRESS__
43077         - name: resource-version
43078           in: query
43079           description: resource-version for concurrency
43080           required: true
43081           type: string
43082   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
43083     get:
43084       tags:
43085         - Network
43086       summary: returns l-interface
43087       description: returns l-interface
43088       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
43089       produces:
43090         - application/json
43091         - application/xml
43092       responses:
43093         "200":
43094           description: successful operation
43095           schema:
43096               $ref: "#/getDefinitions/l-interface"
43097         "default":
43098           description: Response codes found in [response codes](https://wiki.onap.org/).
43099       parameters:
43100         - name: pnf-name
43101           in: path
43102           description: unique name of Physical Network Function.
43103           required: true
43104           type: string
43105           example: __PNF-NAME__
43106         - name: interface-name
43107           in: path
43108           description: Name that identifies the physical interface
43109           required: true
43110           type: string
43111           example: __INTERFACE-NAME__
43112         - name: interface-name
43113           in: path
43114           description: Name given to the interface
43115           required: true
43116           type: string
43117           example: __INTERFACE-NAME__
43118         - name: inv-status
43119           in: query
43120           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
43121           required: false
43122           type: string
43123         - name: prov-status
43124           in: query
43125           description: Trigger for operational monitoring of this resource by Service Assurance systems.
43126           required: false
43127           type: string
43128         - name: interface-id
43129           in: query
43130           description: ID of interface
43131           required: false
43132           type: string
43133         - name: macaddr
43134           in: query
43135           description: MAC address for the interface
43136           required: false
43137           type: string
43138         - name: network-name
43139           in: query
43140           description: Name of the network
43141           required: false
43142           type: string
43143     put:
43144       tags:
43145         - Network
43146       summary: create or update an existing l-interface
43147       description: |
43148         Create or update an existing l-interface.
43149         #
43150         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
43151       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
43152       consumes:
43153         - application/json
43154         - application/xml
43155       produces:
43156         - application/json
43157         - application/xml
43158       responses:
43159         "default":
43160           description: Response codes found in [response codes](https://wiki.onap.org/).
43161       parameters:
43162         - name: pnf-name
43163           in: path
43164           description: unique name of Physical Network Function.
43165           required: true
43166           type: string
43167           example: __PNF-NAME__
43168         - name: interface-name
43169           in: path
43170           description: Name that identifies the physical interface
43171           required: true
43172           type: string
43173           example: __INTERFACE-NAME__
43174         - name: interface-name
43175           in: path
43176           description: Name given to the interface
43177           required: true
43178           type: string
43179           example: __INTERFACE-NAME__
43180         - name: body
43181           in: body
43182           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
43183           required: true
43184           schema:
43185             $ref: "#/definitions/l-interface"
43186     patch:
43187       tags:
43188         - Network
43189       summary: update an existing l-interface
43190       description: |
43191         Update an existing l-interface
43192         #
43193         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43194         The PUT operation will entirely replace an existing object.
43195         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
43196         #
43197         Other differences between PUT and PATCH are:
43198         #
43199         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
43200         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43201         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43202       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
43203       consumes:
43204         - application/json
43205         - application/xml
43206       produces:
43207         - application/json
43208         - application/xml
43209       responses:
43210         "default":
43211           description: Response codes found in [response codes](https://wiki.onap.org/).
43212       parameters:
43213         - name: pnf-name
43214           in: path
43215           description: unique name of Physical Network Function.
43216           required: true
43217           type: string
43218           example: __PNF-NAME__
43219         - name: interface-name
43220           in: path
43221           description: Name that identifies the physical interface
43222           required: true
43223           type: string
43224           example: __INTERFACE-NAME__
43225         - name: interface-name
43226           in: path
43227           description: Name given to the interface
43228           required: true
43229           type: string
43230           example: __INTERFACE-NAME__
43231         - name: body
43232           in: body
43233           description: l-interface object that needs to be created or updated.
43234           required: true
43235           schema:
43236             $ref: "#/patchDefinitions/l-interface"
43237     delete:
43238       tags:
43239         - Network
43240       summary: delete an existing l-interface
43241       description: delete an existing l-interface
43242       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
43243       consumes:
43244         - application/json
43245         - application/xml
43246       produces:
43247         - application/json
43248         - application/xml
43249       responses:
43250         "default":
43251           description: Response codes found in [response codes](https://wiki.onap.org/).
43252       parameters:
43253         - name: pnf-name
43254           in: path
43255           description: unique name of Physical Network Function.
43256           required: true
43257           type: string
43258           example: __PNF-NAME__
43259         - name: interface-name
43260           in: path
43261           description: Name that identifies the physical interface
43262           required: true
43263           type: string
43264           example: __INTERFACE-NAME__
43265         - name: interface-name
43266           in: path
43267           description: Name given to the interface
43268           required: true
43269           type: string
43270           example: __INTERFACE-NAME__
43271         - name: resource-version
43272           in: query
43273           description: resource-version for concurrency
43274           required: true
43275           type: string
43276   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
43277     get:
43278       tags:
43279         - Network
43280       summary: returns l-interfaces
43281       description: returns l-interfaces
43282       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfaces
43283       produces:
43284         - application/json
43285         - application/xml
43286       responses:
43287         "200":
43288           description: successful operation
43289           schema:
43290               $ref: "#/getDefinitions/l-interfaces"
43291         "default":
43292           description: Response codes found in [response codes](https://wiki.onap.org/).
43293       parameters:
43294         - name: pnf-name
43295           in: path
43296           description: unique name of Physical Network Function.
43297           required: true
43298           type: string
43299           example: __PNF-NAME__
43300         - name: interface-name
43301           in: path
43302           description: Name that identifies the physical interface
43303           required: true
43304           type: string
43305           example: __INTERFACE-NAME__
43306         - name: inv-status
43307           in: query
43308           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
43309           required: false
43310           type: string
43311         - name: prov-status
43312           in: query
43313           description: Trigger for operational monitoring of this resource by Service Assurance systems.
43314           required: false
43315           type: string
43316   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}:
43317     get:
43318       tags:
43319         - Network
43320       summary: returns p-interface
43321       description: returns p-interface
43322       operationId: getNetworkPnfsPnfPInterfacesPInterface
43323       produces:
43324         - application/json
43325         - application/xml
43326       responses:
43327         "200":
43328           description: successful operation
43329           schema:
43330               $ref: "#/getDefinitions/p-interface"
43331         "default":
43332           description: Response codes found in [response codes](https://wiki.onap.org/).
43333       parameters:
43334         - name: pnf-name
43335           in: path
43336           description: unique name of Physical Network Function.
43337           required: true
43338           type: string
43339           example: __PNF-NAME__
43340         - name: interface-name
43341           in: path
43342           description: Name that identifies the physical interface
43343           required: true
43344           type: string
43345           example: __INTERFACE-NAME__
43346         - name: inv-status
43347           in: query
43348           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
43349           required: false
43350           type: string
43351         - name: prov-status
43352           in: query
43353           description: Trigger for operational monitoring of this resource by Service Assurance systems.
43354           required: false
43355           type: string
43356     put:
43357       tags:
43358         - Network
43359       summary: create or update an existing p-interface
43360       description: |
43361         Create or update an existing p-interface.
43362         #
43363         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
43364       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterface
43365       consumes:
43366         - application/json
43367         - application/xml
43368       produces:
43369         - application/json
43370         - application/xml
43371       responses:
43372         "default":
43373           description: Response codes found in [response codes](https://wiki.onap.org/).
43374       parameters:
43375         - name: pnf-name
43376           in: path
43377           description: unique name of Physical Network Function.
43378           required: true
43379           type: string
43380           example: __PNF-NAME__
43381         - name: interface-name
43382           in: path
43383           description: Name that identifies the physical interface
43384           required: true
43385           type: string
43386           example: __INTERFACE-NAME__
43387         - name: body
43388           in: body
43389           description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterface.json)
43390           required: true
43391           schema:
43392             $ref: "#/definitions/p-interface"
43393     patch:
43394       tags:
43395         - Network
43396       summary: update an existing p-interface
43397       description: |
43398         Update an existing p-interface
43399         #
43400         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43401         The PUT operation will entirely replace an existing object.
43402         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
43403         #
43404         Other differences between PUT and PATCH are:
43405         #
43406         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
43407         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43408         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43409       operationId: UpdateNetworkPnfsPnfPInterfacesPInterface
43410       consumes:
43411         - application/json
43412         - application/xml
43413       produces:
43414         - application/json
43415         - application/xml
43416       responses:
43417         "default":
43418           description: Response codes found in [response codes](https://wiki.onap.org/).
43419       parameters:
43420         - name: pnf-name
43421           in: path
43422           description: unique name of Physical Network Function.
43423           required: true
43424           type: string
43425           example: __PNF-NAME__
43426         - name: interface-name
43427           in: path
43428           description: Name that identifies the physical interface
43429           required: true
43430           type: string
43431           example: __INTERFACE-NAME__
43432         - name: body
43433           in: body
43434           description: p-interface object that needs to be created or updated.
43435           required: true
43436           schema:
43437             $ref: "#/patchDefinitions/p-interface"
43438     delete:
43439       tags:
43440         - Network
43441       summary: delete an existing p-interface
43442       description: delete an existing p-interface
43443       operationId: deleteNetworkPnfsPnfPInterfacesPInterface
43444       consumes:
43445         - application/json
43446         - application/xml
43447       produces:
43448         - application/json
43449         - application/xml
43450       responses:
43451         "default":
43452           description: Response codes found in [response codes](https://wiki.onap.org/).
43453       parameters:
43454         - name: pnf-name
43455           in: path
43456           description: unique name of Physical Network Function.
43457           required: true
43458           type: string
43459           example: __PNF-NAME__
43460         - name: interface-name
43461           in: path
43462           description: Name that identifies the physical interface
43463           required: true
43464           type: string
43465           example: __INTERFACE-NAME__
43466         - name: resource-version
43467           in: query
43468           description: resource-version for concurrency
43469           required: true
43470           type: string
43471   /network/pnfs/pnf/{pnf-name}/p-interfaces:
43472     get:
43473       tags:
43474         - Network
43475       summary: returns p-interfaces
43476       description: returns p-interfaces
43477       operationId: getNetworkPnfsPnfPInterfaces
43478       produces:
43479         - application/json
43480         - application/xml
43481       responses:
43482         "200":
43483           description: successful operation
43484           schema:
43485               $ref: "#/getDefinitions/p-interfaces"
43486         "default":
43487           description: Response codes found in [response codes](https://wiki.onap.org/).
43488       parameters:
43489         - name: pnf-name
43490           in: path
43491           description: unique name of Physical Network Function.
43492           required: true
43493           type: string
43494           example: __PNF-NAME__
43495         - name: inv-status
43496           in: query
43497           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
43498           required: false
43499           type: string
43500   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
43501     put:
43502       tags:
43503         - Network
43504       summary: see node definition for valid relationships
43505       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship
43506       consumes:
43507         - application/json
43508         - application/xml
43509       produces:
43510         - application/json
43511         - application/xml
43512       responses:
43513         "default":
43514           description: Response codes found in [response codes](https://wiki.onap.org/).
43515       parameters:
43516         - name: pnf-name
43517           in: path
43518           description: unique name of Physical Network Function.
43519           required: true
43520           type: string
43521           example: __PNF-NAME__
43522         - name: interface-name
43523           in: path
43524           description: Name that identifies the link aggregate interface
43525           required: true
43526           type: string
43527           example: __INTERFACE-NAME__
43528         - name: body
43529           in: body
43530           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterface.json)
43531           required: true
43532           schema:
43533             $ref: "#/definitions/relationship"
43534     delete:
43535       tags:
43536         - Network
43537       summary: delete an existing relationship
43538       description: delete an existing relationship
43539       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship
43540       consumes:
43541         - application/json
43542         - application/xml
43543       produces:
43544         - application/json
43545         - application/xml
43546       responses:
43547         "default":
43548           description: Response codes found in [response codes](https://wiki.onap.org/).
43549       parameters:
43550         - name: pnf-name
43551           in: path
43552           description: unique name of Physical Network Function.
43553           required: true
43554           type: string
43555           example: __PNF-NAME__
43556         - name: interface-name
43557           in: path
43558           description: Name that identifies the link aggregate interface
43559           required: true
43560           type: string
43561           example: __INTERFACE-NAME__
43562   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
43563     put:
43564       tags:
43565         - Network
43566       summary: see node definition for valid relationships
43567       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
43568       consumes:
43569         - application/json
43570         - application/xml
43571       produces:
43572         - application/json
43573         - application/xml
43574       responses:
43575         "default":
43576           description: Response codes found in [response codes](https://wiki.onap.org/).
43577       parameters:
43578         - name: pnf-name
43579           in: path
43580           description: unique name of Physical Network Function.
43581           required: true
43582           type: string
43583           example: __PNF-NAME__
43584         - name: interface-name
43585           in: path
43586           description: Name that identifies the link aggregate interface
43587           required: true
43588           type: string
43589           example: __INTERFACE-NAME__
43590         - name: interface-name
43591           in: path
43592           description: Name given to the interface
43593           required: true
43594           type: string
43595           example: __INTERFACE-NAME__
43596         - name: vlan-interface
43597           in: path
43598           description: String that identifies the interface
43599           required: true
43600           type: string
43601           example: __VLAN-INTERFACE__
43602         - name: body
43603           in: body
43604           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
43605           required: true
43606           schema:
43607             $ref: "#/definitions/relationship"
43608     delete:
43609       tags:
43610         - Network
43611       summary: delete an existing relationship
43612       description: delete an existing relationship
43613       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
43614       consumes:
43615         - application/json
43616         - application/xml
43617       produces:
43618         - application/json
43619         - application/xml
43620       responses:
43621         "default":
43622           description: Response codes found in [response codes](https://wiki.onap.org/).
43623       parameters:
43624         - name: pnf-name
43625           in: path
43626           description: unique name of Physical Network Function.
43627           required: true
43628           type: string
43629           example: __PNF-NAME__
43630         - name: interface-name
43631           in: path
43632           description: Name that identifies the link aggregate interface
43633           required: true
43634           type: string
43635           example: __INTERFACE-NAME__
43636         - name: interface-name
43637           in: path
43638           description: Name given to the interface
43639           required: true
43640           type: string
43641           example: __INTERFACE-NAME__
43642         - name: vlan-interface
43643           in: path
43644           description: String that identifies the interface
43645           required: true
43646           type: string
43647           example: __VLAN-INTERFACE__
43648   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
43649     put:
43650       tags:
43651         - Network
43652       summary: see node definition for valid relationships
43653       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
43654       consumes:
43655         - application/json
43656         - application/xml
43657       produces:
43658         - application/json
43659         - application/xml
43660       responses:
43661         "default":
43662           description: Response codes found in [response codes](https://wiki.onap.org/).
43663       parameters:
43664         - name: pnf-name
43665           in: path
43666           description: unique name of Physical Network Function.
43667           required: true
43668           type: string
43669           example: __PNF-NAME__
43670         - name: interface-name
43671           in: path
43672           description: Name that identifies the link aggregate interface
43673           required: true
43674           type: string
43675           example: __INTERFACE-NAME__
43676         - name: interface-name
43677           in: path
43678           description: Name given to the interface
43679           required: true
43680           type: string
43681           example: __INTERFACE-NAME__
43682         - name: vlan-interface
43683           in: path
43684           description: String that identifies the interface
43685           required: true
43686           type: string
43687           example: __VLAN-INTERFACE__
43688         - name: l3-interface-ipv4-address
43689           in: path
43690           description: IP address
43691           required: true
43692           type: string
43693           example: __L3-INTERFACE-IPV4-ADDRESS__
43694         - name: body
43695           in: body
43696           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
43697           required: true
43698           schema:
43699             $ref: "#/definitions/relationship"
43700     delete:
43701       tags:
43702         - Network
43703       summary: delete an existing relationship
43704       description: delete an existing relationship
43705       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
43706       consumes:
43707         - application/json
43708         - application/xml
43709       produces:
43710         - application/json
43711         - application/xml
43712       responses:
43713         "default":
43714           description: Response codes found in [response codes](https://wiki.onap.org/).
43715       parameters:
43716         - name: pnf-name
43717           in: path
43718           description: unique name of Physical Network Function.
43719           required: true
43720           type: string
43721           example: __PNF-NAME__
43722         - name: interface-name
43723           in: path
43724           description: Name that identifies the link aggregate interface
43725           required: true
43726           type: string
43727           example: __INTERFACE-NAME__
43728         - name: interface-name
43729           in: path
43730           description: Name given to the interface
43731           required: true
43732           type: string
43733           example: __INTERFACE-NAME__
43734         - name: vlan-interface
43735           in: path
43736           description: String that identifies the interface
43737           required: true
43738           type: string
43739           example: __VLAN-INTERFACE__
43740         - name: l3-interface-ipv4-address
43741           in: path
43742           description: IP address
43743           required: true
43744           type: string
43745           example: __L3-INTERFACE-IPV4-ADDRESS__
43746   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
43747     get:
43748       tags:
43749         - Network
43750       summary: returns l3-interface-ipv4-address-list
43751       description: returns l3-interface-ipv4-address-list
43752       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
43753       produces:
43754         - application/json
43755         - application/xml
43756       responses:
43757         "200":
43758           description: successful operation
43759           schema:
43760               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
43761         "default":
43762           description: Response codes found in [response codes](https://wiki.onap.org/).
43763       parameters:
43764         - name: pnf-name
43765           in: path
43766           description: unique name of Physical Network Function.
43767           required: true
43768           type: string
43769           example: __PNF-NAME__
43770         - name: interface-name
43771           in: path
43772           description: Name that identifies the link aggregate interface
43773           required: true
43774           type: string
43775           example: __INTERFACE-NAME__
43776         - name: interface-name
43777           in: path
43778           description: Name given to the interface
43779           required: true
43780           type: string
43781           example: __INTERFACE-NAME__
43782         - name: vlan-interface
43783           in: path
43784           description: String that identifies the interface
43785           required: true
43786           type: string
43787           example: __VLAN-INTERFACE__
43788         - name: l3-interface-ipv4-address
43789           in: path
43790           description: IP address
43791           required: true
43792           type: string
43793           example: __L3-INTERFACE-IPV4-ADDRESS__
43794         - name: inv-status
43795           in: query
43796           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
43797           required: false
43798           type: string
43799         - name: interface-id
43800           in: query
43801           description: ID of interface
43802           required: false
43803           type: string
43804         - name: interface-role
43805           in: query
43806           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
43807           required: false
43808           type: string
43809         - name: interface-id
43810           in: query
43811           description: ID of interface
43812           required: false
43813           type: string
43814         - name: macaddr
43815           in: query
43816           description: MAC address for the interface
43817           required: false
43818           type: string
43819         - name: network-name
43820           in: query
43821           description: Name of the network
43822           required: false
43823           type: string
43824         - name: vlan-id-inner
43825           in: query
43826           description: Inner VLAN tag
43827           required: false
43828           type: integer
43829           format: int64
43830         - name: vpn-id
43831           in: query
43832           description: This indicates the customers VPN ID associated with this vlan
43833           required: false
43834           type: string
43835         - name: vlan-id-inner
43836           in: query
43837           description: Inner VLAN tag
43838           required: false
43839           type: integer
43840           format: int64
43841         - name: neutron-network-id
43842           in: query
43843           description: Neutron network id of the interface that address belongs to
43844           required: false
43845           type: string
43846         - name: neutron-subnet-id
43847           in: query
43848           description: Neutron id of subnet that address belongs to
43849           required: false
43850           type: string
43851     put:
43852       tags:
43853         - Network
43854       summary: create or update an existing l3-interface-ipv4-address-list
43855       description: |
43856         Create or update an existing l3-interface-ipv4-address-list.
43857         #
43858         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
43859       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
43860       consumes:
43861         - application/json
43862         - application/xml
43863       produces:
43864         - application/json
43865         - application/xml
43866       responses:
43867         "default":
43868           description: Response codes found in [response codes](https://wiki.onap.org/).
43869       parameters:
43870         - name: pnf-name
43871           in: path
43872           description: unique name of Physical Network Function.
43873           required: true
43874           type: string
43875           example: __PNF-NAME__
43876         - name: interface-name
43877           in: path
43878           description: Name that identifies the link aggregate interface
43879           required: true
43880           type: string
43881           example: __INTERFACE-NAME__
43882         - name: interface-name
43883           in: path
43884           description: Name given to the interface
43885           required: true
43886           type: string
43887           example: __INTERFACE-NAME__
43888         - name: vlan-interface
43889           in: path
43890           description: String that identifies the interface
43891           required: true
43892           type: string
43893           example: __VLAN-INTERFACE__
43894         - name: l3-interface-ipv4-address
43895           in: path
43896           description: IP address
43897           required: true
43898           type: string
43899           example: __L3-INTERFACE-IPV4-ADDRESS__
43900         - name: body
43901           in: body
43902           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
43903           required: true
43904           schema:
43905             $ref: "#/definitions/l3-interface-ipv4-address-list"
43906     patch:
43907       tags:
43908         - Network
43909       summary: update an existing l3-interface-ipv4-address-list
43910       description: |
43911         Update an existing l3-interface-ipv4-address-list
43912         #
43913         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43914         The PUT operation will entirely replace an existing object.
43915         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
43916         #
43917         Other differences between PUT and PATCH are:
43918         #
43919         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
43920         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43921         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43922       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
43923       consumes:
43924         - application/json
43925         - application/xml
43926       produces:
43927         - application/json
43928         - application/xml
43929       responses:
43930         "default":
43931           description: Response codes found in [response codes](https://wiki.onap.org/).
43932       parameters:
43933         - name: pnf-name
43934           in: path
43935           description: unique name of Physical Network Function.
43936           required: true
43937           type: string
43938           example: __PNF-NAME__
43939         - name: interface-name
43940           in: path
43941           description: Name that identifies the link aggregate interface
43942           required: true
43943           type: string
43944           example: __INTERFACE-NAME__
43945         - name: interface-name
43946           in: path
43947           description: Name given to the interface
43948           required: true
43949           type: string
43950           example: __INTERFACE-NAME__
43951         - name: vlan-interface
43952           in: path
43953           description: String that identifies the interface
43954           required: true
43955           type: string
43956           example: __VLAN-INTERFACE__
43957         - name: l3-interface-ipv4-address
43958           in: path
43959           description: IP address
43960           required: true
43961           type: string
43962           example: __L3-INTERFACE-IPV4-ADDRESS__
43963         - name: body
43964           in: body
43965           description: l3-interface-ipv4-address-list object that needs to be created or updated.
43966           required: true
43967           schema:
43968             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
43969     delete:
43970       tags:
43971         - Network
43972       summary: delete an existing l3-interface-ipv4-address-list
43973       description: delete an existing l3-interface-ipv4-address-list
43974       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
43975       consumes:
43976         - application/json
43977         - application/xml
43978       produces:
43979         - application/json
43980         - application/xml
43981       responses:
43982         "default":
43983           description: Response codes found in [response codes](https://wiki.onap.org/).
43984       parameters:
43985         - name: pnf-name
43986           in: path
43987           description: unique name of Physical Network Function.
43988           required: true
43989           type: string
43990           example: __PNF-NAME__
43991         - name: interface-name
43992           in: path
43993           description: Name that identifies the link aggregate interface
43994           required: true
43995           type: string
43996           example: __INTERFACE-NAME__
43997         - name: interface-name
43998           in: path
43999           description: Name given to the interface
44000           required: true
44001           type: string
44002           example: __INTERFACE-NAME__
44003         - name: vlan-interface
44004           in: path
44005           description: String that identifies the interface
44006           required: true
44007           type: string
44008           example: __VLAN-INTERFACE__
44009         - name: l3-interface-ipv4-address
44010           in: path
44011           description: IP address
44012           required: true
44013           type: string
44014           example: __L3-INTERFACE-IPV4-ADDRESS__
44015         - name: resource-version
44016           in: query
44017           description: resource-version for concurrency
44018           required: true
44019           type: string
44020   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
44021     put:
44022       tags:
44023         - Network
44024       summary: see node definition for valid relationships
44025       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
44026       consumes:
44027         - application/json
44028         - application/xml
44029       produces:
44030         - application/json
44031         - application/xml
44032       responses:
44033         "default":
44034           description: Response codes found in [response codes](https://wiki.onap.org/).
44035       parameters:
44036         - name: pnf-name
44037           in: path
44038           description: unique name of Physical Network Function.
44039           required: true
44040           type: string
44041           example: __PNF-NAME__
44042         - name: interface-name
44043           in: path
44044           description: Name that identifies the link aggregate interface
44045           required: true
44046           type: string
44047           example: __INTERFACE-NAME__
44048         - name: interface-name
44049           in: path
44050           description: Name given to the interface
44051           required: true
44052           type: string
44053           example: __INTERFACE-NAME__
44054         - name: vlan-interface
44055           in: path
44056           description: String that identifies the interface
44057           required: true
44058           type: string
44059           example: __VLAN-INTERFACE__
44060         - name: l3-interface-ipv6-address
44061           in: path
44062           description: IP address
44063           required: true
44064           type: string
44065           example: __L3-INTERFACE-IPV6-ADDRESS__
44066         - name: body
44067           in: body
44068           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
44069           required: true
44070           schema:
44071             $ref: "#/definitions/relationship"
44072     delete:
44073       tags:
44074         - Network
44075       summary: delete an existing relationship
44076       description: delete an existing relationship
44077       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
44078       consumes:
44079         - application/json
44080         - application/xml
44081       produces:
44082         - application/json
44083         - application/xml
44084       responses:
44085         "default":
44086           description: Response codes found in [response codes](https://wiki.onap.org/).
44087       parameters:
44088         - name: pnf-name
44089           in: path
44090           description: unique name of Physical Network Function.
44091           required: true
44092           type: string
44093           example: __PNF-NAME__
44094         - name: interface-name
44095           in: path
44096           description: Name that identifies the link aggregate interface
44097           required: true
44098           type: string
44099           example: __INTERFACE-NAME__
44100         - name: interface-name
44101           in: path
44102           description: Name given to the interface
44103           required: true
44104           type: string
44105           example: __INTERFACE-NAME__
44106         - name: vlan-interface
44107           in: path
44108           description: String that identifies the interface
44109           required: true
44110           type: string
44111           example: __VLAN-INTERFACE__
44112         - name: l3-interface-ipv6-address
44113           in: path
44114           description: IP address
44115           required: true
44116           type: string
44117           example: __L3-INTERFACE-IPV6-ADDRESS__
44118   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
44119     get:
44120       tags:
44121         - Network
44122       summary: returns l3-interface-ipv6-address-list
44123       description: returns l3-interface-ipv6-address-list
44124       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
44125       produces:
44126         - application/json
44127         - application/xml
44128       responses:
44129         "200":
44130           description: successful operation
44131           schema:
44132               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
44133         "default":
44134           description: Response codes found in [response codes](https://wiki.onap.org/).
44135       parameters:
44136         - name: pnf-name
44137           in: path
44138           description: unique name of Physical Network Function.
44139           required: true
44140           type: string
44141           example: __PNF-NAME__
44142         - name: interface-name
44143           in: path
44144           description: Name that identifies the link aggregate interface
44145           required: true
44146           type: string
44147           example: __INTERFACE-NAME__
44148         - name: interface-name
44149           in: path
44150           description: Name given to the interface
44151           required: true
44152           type: string
44153           example: __INTERFACE-NAME__
44154         - name: vlan-interface
44155           in: path
44156           description: String that identifies the interface
44157           required: true
44158           type: string
44159           example: __VLAN-INTERFACE__
44160         - name: l3-interface-ipv6-address
44161           in: path
44162           description: IP address
44163           required: true
44164           type: string
44165           example: __L3-INTERFACE-IPV6-ADDRESS__
44166         - name: inv-status
44167           in: query
44168           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
44169           required: false
44170           type: string
44171         - name: interface-id
44172           in: query
44173           description: ID of interface
44174           required: false
44175           type: string
44176         - name: interface-role
44177           in: query
44178           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
44179           required: false
44180           type: string
44181         - name: interface-id
44182           in: query
44183           description: ID of interface
44184           required: false
44185           type: string
44186         - name: macaddr
44187           in: query
44188           description: MAC address for the interface
44189           required: false
44190           type: string
44191         - name: network-name
44192           in: query
44193           description: Name of the network
44194           required: false
44195           type: string
44196         - name: vlan-id-inner
44197           in: query
44198           description: Inner VLAN tag
44199           required: false
44200           type: integer
44201           format: int64
44202         - name: vpn-id
44203           in: query
44204           description: This indicates the customers VPN ID associated with this vlan
44205           required: false
44206           type: string
44207         - name: vlan-id-inner
44208           in: query
44209           description: Inner VLAN tag
44210           required: false
44211           type: integer
44212           format: int64
44213         - name: neutron-network-id
44214           in: query
44215           description: Neutron network id of the interface that address belongs to
44216           required: false
44217           type: string
44218         - name: neutron-subnet-id
44219           in: query
44220           description: Neutron id of subnet that address belongs to
44221           required: false
44222           type: string
44223     put:
44224       tags:
44225         - Network
44226       summary: create or update an existing l3-interface-ipv6-address-list
44227       description: |
44228         Create or update an existing l3-interface-ipv6-address-list.
44229         #
44230         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
44231       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
44232       consumes:
44233         - application/json
44234         - application/xml
44235       produces:
44236         - application/json
44237         - application/xml
44238       responses:
44239         "default":
44240           description: Response codes found in [response codes](https://wiki.onap.org/).
44241       parameters:
44242         - name: pnf-name
44243           in: path
44244           description: unique name of Physical Network Function.
44245           required: true
44246           type: string
44247           example: __PNF-NAME__
44248         - name: interface-name
44249           in: path
44250           description: Name that identifies the link aggregate interface
44251           required: true
44252           type: string
44253           example: __INTERFACE-NAME__
44254         - name: interface-name
44255           in: path
44256           description: Name given to the interface
44257           required: true
44258           type: string
44259           example: __INTERFACE-NAME__
44260         - name: vlan-interface
44261           in: path
44262           description: String that identifies the interface
44263           required: true
44264           type: string
44265           example: __VLAN-INTERFACE__
44266         - name: l3-interface-ipv6-address
44267           in: path
44268           description: IP address
44269           required: true
44270           type: string
44271           example: __L3-INTERFACE-IPV6-ADDRESS__
44272         - name: body
44273           in: body
44274           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
44275           required: true
44276           schema:
44277             $ref: "#/definitions/l3-interface-ipv6-address-list"
44278     patch:
44279       tags:
44280         - Network
44281       summary: update an existing l3-interface-ipv6-address-list
44282       description: |
44283         Update an existing l3-interface-ipv6-address-list
44284         #
44285         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44286         The PUT operation will entirely replace an existing object.
44287         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
44288         #
44289         Other differences between PUT and PATCH are:
44290         #
44291         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
44292         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44293         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44294       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
44295       consumes:
44296         - application/json
44297         - application/xml
44298       produces:
44299         - application/json
44300         - application/xml
44301       responses:
44302         "default":
44303           description: Response codes found in [response codes](https://wiki.onap.org/).
44304       parameters:
44305         - name: pnf-name
44306           in: path
44307           description: unique name of Physical Network Function.
44308           required: true
44309           type: string
44310           example: __PNF-NAME__
44311         - name: interface-name
44312           in: path
44313           description: Name that identifies the link aggregate interface
44314           required: true
44315           type: string
44316           example: __INTERFACE-NAME__
44317         - name: interface-name
44318           in: path
44319           description: Name given to the interface
44320           required: true
44321           type: string
44322           example: __INTERFACE-NAME__
44323         - name: vlan-interface
44324           in: path
44325           description: String that identifies the interface
44326           required: true
44327           type: string
44328           example: __VLAN-INTERFACE__
44329         - name: l3-interface-ipv6-address
44330           in: path
44331           description: IP address
44332           required: true
44333           type: string
44334           example: __L3-INTERFACE-IPV6-ADDRESS__
44335         - name: body
44336           in: body
44337           description: l3-interface-ipv6-address-list object that needs to be created or updated.
44338           required: true
44339           schema:
44340             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
44341     delete:
44342       tags:
44343         - Network
44344       summary: delete an existing l3-interface-ipv6-address-list
44345       description: delete an existing l3-interface-ipv6-address-list
44346       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
44347       consumes:
44348         - application/json
44349         - application/xml
44350       produces:
44351         - application/json
44352         - application/xml
44353       responses:
44354         "default":
44355           description: Response codes found in [response codes](https://wiki.onap.org/).
44356       parameters:
44357         - name: pnf-name
44358           in: path
44359           description: unique name of Physical Network Function.
44360           required: true
44361           type: string
44362           example: __PNF-NAME__
44363         - name: interface-name
44364           in: path
44365           description: Name that identifies the link aggregate interface
44366           required: true
44367           type: string
44368           example: __INTERFACE-NAME__
44369         - name: interface-name
44370           in: path
44371           description: Name given to the interface
44372           required: true
44373           type: string
44374           example: __INTERFACE-NAME__
44375         - name: vlan-interface
44376           in: path
44377           description: String that identifies the interface
44378           required: true
44379           type: string
44380           example: __VLAN-INTERFACE__
44381         - name: l3-interface-ipv6-address
44382           in: path
44383           description: IP address
44384           required: true
44385           type: string
44386           example: __L3-INTERFACE-IPV6-ADDRESS__
44387         - name: resource-version
44388           in: query
44389           description: resource-version for concurrency
44390           required: true
44391           type: string
44392   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
44393     get:
44394       tags:
44395         - Network
44396       summary: returns vlan
44397       description: returns vlan
44398       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
44399       produces:
44400         - application/json
44401         - application/xml
44402       responses:
44403         "200":
44404           description: successful operation
44405           schema:
44406               $ref: "#/getDefinitions/vlan"
44407         "default":
44408           description: Response codes found in [response codes](https://wiki.onap.org/).
44409       parameters:
44410         - name: pnf-name
44411           in: path
44412           description: unique name of Physical Network Function.
44413           required: true
44414           type: string
44415           example: __PNF-NAME__
44416         - name: interface-name
44417           in: path
44418           description: Name that identifies the link aggregate interface
44419           required: true
44420           type: string
44421           example: __INTERFACE-NAME__
44422         - name: interface-name
44423           in: path
44424           description: Name given to the interface
44425           required: true
44426           type: string
44427           example: __INTERFACE-NAME__
44428         - name: vlan-interface
44429           in: path
44430           description: String that identifies the interface
44431           required: true
44432           type: string
44433           example: __VLAN-INTERFACE__
44434         - name: inv-status
44435           in: query
44436           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
44437           required: false
44438           type: string
44439         - name: interface-id
44440           in: query
44441           description: ID of interface
44442           required: false
44443           type: string
44444         - name: interface-role
44445           in: query
44446           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
44447           required: false
44448           type: string
44449         - name: interface-id
44450           in: query
44451           description: ID of interface
44452           required: false
44453           type: string
44454         - name: macaddr
44455           in: query
44456           description: MAC address for the interface
44457           required: false
44458           type: string
44459         - name: network-name
44460           in: query
44461           description: Name of the network
44462           required: false
44463           type: string
44464         - name: vlan-id-inner
44465           in: query
44466           description: Inner VLAN tag
44467           required: false
44468           type: integer
44469           format: int64
44470         - name: vpn-id
44471           in: query
44472           description: This indicates the customers VPN ID associated with this vlan
44473           required: false
44474           type: string
44475     put:
44476       tags:
44477         - Network
44478       summary: create or update an existing vlan
44479       description: |
44480         Create or update an existing vlan.
44481         #
44482         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
44483       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
44484       consumes:
44485         - application/json
44486         - application/xml
44487       produces:
44488         - application/json
44489         - application/xml
44490       responses:
44491         "default":
44492           description: Response codes found in [response codes](https://wiki.onap.org/).
44493       parameters:
44494         - name: pnf-name
44495           in: path
44496           description: unique name of Physical Network Function.
44497           required: true
44498           type: string
44499           example: __PNF-NAME__
44500         - name: interface-name
44501           in: path
44502           description: Name that identifies the link aggregate interface
44503           required: true
44504           type: string
44505           example: __INTERFACE-NAME__
44506         - name: interface-name
44507           in: path
44508           description: Name given to the interface
44509           required: true
44510           type: string
44511           example: __INTERFACE-NAME__
44512         - name: vlan-interface
44513           in: path
44514           description: String that identifies the interface
44515           required: true
44516           type: string
44517           example: __VLAN-INTERFACE__
44518         - name: body
44519           in: body
44520           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
44521           required: true
44522           schema:
44523             $ref: "#/definitions/vlan"
44524     patch:
44525       tags:
44526         - Network
44527       summary: update an existing vlan
44528       description: |
44529         Update an existing vlan
44530         #
44531         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44532         The PUT operation will entirely replace an existing object.
44533         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
44534         #
44535         Other differences between PUT and PATCH are:
44536         #
44537         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
44538         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44539         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44540       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
44541       consumes:
44542         - application/json
44543         - application/xml
44544       produces:
44545         - application/json
44546         - application/xml
44547       responses:
44548         "default":
44549           description: Response codes found in [response codes](https://wiki.onap.org/).
44550       parameters:
44551         - name: pnf-name
44552           in: path
44553           description: unique name of Physical Network Function.
44554           required: true
44555           type: string
44556           example: __PNF-NAME__
44557         - name: interface-name
44558           in: path
44559           description: Name that identifies the link aggregate interface
44560           required: true
44561           type: string
44562           example: __INTERFACE-NAME__
44563         - name: interface-name
44564           in: path
44565           description: Name given to the interface
44566           required: true
44567           type: string
44568           example: __INTERFACE-NAME__
44569         - name: vlan-interface
44570           in: path
44571           description: String that identifies the interface
44572           required: true
44573           type: string
44574           example: __VLAN-INTERFACE__
44575         - name: body
44576           in: body
44577           description: vlan object that needs to be created or updated.
44578           required: true
44579           schema:
44580             $ref: "#/patchDefinitions/vlan"
44581     delete:
44582       tags:
44583         - Network
44584       summary: delete an existing vlan
44585       description: delete an existing vlan
44586       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
44587       consumes:
44588         - application/json
44589         - application/xml
44590       produces:
44591         - application/json
44592         - application/xml
44593       responses:
44594         "default":
44595           description: Response codes found in [response codes](https://wiki.onap.org/).
44596       parameters:
44597         - name: pnf-name
44598           in: path
44599           description: unique name of Physical Network Function.
44600           required: true
44601           type: string
44602           example: __PNF-NAME__
44603         - name: interface-name
44604           in: path
44605           description: Name that identifies the link aggregate interface
44606           required: true
44607           type: string
44608           example: __INTERFACE-NAME__
44609         - name: interface-name
44610           in: path
44611           description: Name given to the interface
44612           required: true
44613           type: string
44614           example: __INTERFACE-NAME__
44615         - name: vlan-interface
44616           in: path
44617           description: String that identifies the interface
44618           required: true
44619           type: string
44620           example: __VLAN-INTERFACE__
44621         - name: resource-version
44622           in: query
44623           description: resource-version for concurrency
44624           required: true
44625           type: string
44626   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
44627     get:
44628       tags:
44629         - Network
44630       summary: returns vlans
44631       description: returns vlans
44632       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
44633       produces:
44634         - application/json
44635         - application/xml
44636       responses:
44637         "200":
44638           description: successful operation
44639           schema:
44640               $ref: "#/getDefinitions/vlans"
44641         "default":
44642           description: Response codes found in [response codes](https://wiki.onap.org/).
44643       parameters:
44644         - name: pnf-name
44645           in: path
44646           description: unique name of Physical Network Function.
44647           required: true
44648           type: string
44649           example: __PNF-NAME__
44650         - name: interface-name
44651           in: path
44652           description: Name that identifies the link aggregate interface
44653           required: true
44654           type: string
44655           example: __INTERFACE-NAME__
44656         - name: interface-name
44657           in: path
44658           description: Name given to the interface
44659           required: true
44660           type: string
44661           example: __INTERFACE-NAME__
44662         - name: inv-status
44663           in: query
44664           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
44665           required: false
44666           type: string
44667         - name: interface-id
44668           in: query
44669           description: ID of interface
44670           required: false
44671           type: string
44672         - name: interface-role
44673           in: query
44674           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
44675           required: false
44676           type: string
44677         - name: interface-id
44678           in: query
44679           description: ID of interface
44680           required: false
44681           type: string
44682         - name: macaddr
44683           in: query
44684           description: MAC address for the interface
44685           required: false
44686           type: string
44687         - name: network-name
44688           in: query
44689           description: Name of the network
44690           required: false
44691           type: string
44692   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
44693     put:
44694       tags:
44695         - Network
44696       summary: see node definition for valid relationships
44697       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
44698       consumes:
44699         - application/json
44700         - application/xml
44701       produces:
44702         - application/json
44703         - application/xml
44704       responses:
44705         "default":
44706           description: Response codes found in [response codes](https://wiki.onap.org/).
44707       parameters:
44708         - name: pnf-name
44709           in: path
44710           description: unique name of Physical Network Function.
44711           required: true
44712           type: string
44713           example: __PNF-NAME__
44714         - name: interface-name
44715           in: path
44716           description: Name that identifies the link aggregate interface
44717           required: true
44718           type: string
44719           example: __INTERFACE-NAME__
44720         - name: interface-name
44721           in: path
44722           description: Name given to the interface
44723           required: true
44724           type: string
44725           example: __INTERFACE-NAME__
44726         - name: pci-id
44727           in: path
44728           description: PCI ID used to identify the sriov-vf
44729           required: true
44730           type: string
44731           example: __PCI-ID__
44732         - name: body
44733           in: body
44734           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
44735           required: true
44736           schema:
44737             $ref: "#/definitions/relationship"
44738     delete:
44739       tags:
44740         - Network
44741       summary: delete an existing relationship
44742       description: delete an existing relationship
44743       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
44744       consumes:
44745         - application/json
44746         - application/xml
44747       produces:
44748         - application/json
44749         - application/xml
44750       responses:
44751         "default":
44752           description: Response codes found in [response codes](https://wiki.onap.org/).
44753       parameters:
44754         - name: pnf-name
44755           in: path
44756           description: unique name of Physical Network Function.
44757           required: true
44758           type: string
44759           example: __PNF-NAME__
44760         - name: interface-name
44761           in: path
44762           description: Name that identifies the link aggregate interface
44763           required: true
44764           type: string
44765           example: __INTERFACE-NAME__
44766         - name: interface-name
44767           in: path
44768           description: Name given to the interface
44769           required: true
44770           type: string
44771           example: __INTERFACE-NAME__
44772         - name: pci-id
44773           in: path
44774           description: PCI ID used to identify the sriov-vf
44775           required: true
44776           type: string
44777           example: __PCI-ID__
44778   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
44779     get:
44780       tags:
44781         - Network
44782       summary: returns sriov-vf
44783       description: returns sriov-vf
44784       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
44785       produces:
44786         - application/json
44787         - application/xml
44788       responses:
44789         "200":
44790           description: successful operation
44791           schema:
44792               $ref: "#/getDefinitions/sriov-vf"
44793         "default":
44794           description: Response codes found in [response codes](https://wiki.onap.org/).
44795       parameters:
44796         - name: pnf-name
44797           in: path
44798           description: unique name of Physical Network Function.
44799           required: true
44800           type: string
44801           example: __PNF-NAME__
44802         - name: interface-name
44803           in: path
44804           description: Name that identifies the link aggregate interface
44805           required: true
44806           type: string
44807           example: __INTERFACE-NAME__
44808         - name: interface-name
44809           in: path
44810           description: Name given to the interface
44811           required: true
44812           type: string
44813           example: __INTERFACE-NAME__
44814         - name: pci-id
44815           in: path
44816           description: PCI ID used to identify the sriov-vf
44817           required: true
44818           type: string
44819           example: __PCI-ID__
44820         - name: inv-status
44821           in: query
44822           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
44823           required: false
44824           type: string
44825         - name: interface-id
44826           in: query
44827           description: ID of interface
44828           required: false
44829           type: string
44830         - name: interface-role
44831           in: query
44832           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
44833           required: false
44834           type: string
44835         - name: interface-id
44836           in: query
44837           description: ID of interface
44838           required: false
44839           type: string
44840         - name: macaddr
44841           in: query
44842           description: MAC address for the interface
44843           required: false
44844           type: string
44845         - name: network-name
44846           in: query
44847           description: Name of the network
44848           required: false
44849           type: string
44850         - name: vf-vlan-filter
44851           in: query
44852           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
44853           required: false
44854           type: string
44855         - name: vf-mac-filter
44856           in: query
44857           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
44858           required: false
44859           type: string
44860         - name: vf-vlan-strip
44861           in: query
44862           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
44863           required: false
44864           type: boolean
44865         - name: neutron-network-id
44866           in: query
44867           description: Neutron network id of the interface
44868           required: false
44869           type: string
44870     put:
44871       tags:
44872         - Network
44873       summary: create or update an existing sriov-vf
44874       description: |
44875         Create or update an existing sriov-vf.
44876         #
44877         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
44878       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
44879       consumes:
44880         - application/json
44881         - application/xml
44882       produces:
44883         - application/json
44884         - application/xml
44885       responses:
44886         "default":
44887           description: Response codes found in [response codes](https://wiki.onap.org/).
44888       parameters:
44889         - name: pnf-name
44890           in: path
44891           description: unique name of Physical Network Function.
44892           required: true
44893           type: string
44894           example: __PNF-NAME__
44895         - name: interface-name
44896           in: path
44897           description: Name that identifies the link aggregate interface
44898           required: true
44899           type: string
44900           example: __INTERFACE-NAME__
44901         - name: interface-name
44902           in: path
44903           description: Name given to the interface
44904           required: true
44905           type: string
44906           example: __INTERFACE-NAME__
44907         - name: pci-id
44908           in: path
44909           description: PCI ID used to identify the sriov-vf
44910           required: true
44911           type: string
44912           example: __PCI-ID__
44913         - name: body
44914           in: body
44915           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
44916           required: true
44917           schema:
44918             $ref: "#/definitions/sriov-vf"
44919     patch:
44920       tags:
44921         - Network
44922       summary: update an existing sriov-vf
44923       description: |
44924         Update an existing sriov-vf
44925         #
44926         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44927         The PUT operation will entirely replace an existing object.
44928         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
44929         #
44930         Other differences between PUT and PATCH are:
44931         #
44932         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
44933         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44934         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44935       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
44936       consumes:
44937         - application/json
44938         - application/xml
44939       produces:
44940         - application/json
44941         - application/xml
44942       responses:
44943         "default":
44944           description: Response codes found in [response codes](https://wiki.onap.org/).
44945       parameters:
44946         - name: pnf-name
44947           in: path
44948           description: unique name of Physical Network Function.
44949           required: true
44950           type: string
44951           example: __PNF-NAME__
44952         - name: interface-name
44953           in: path
44954           description: Name that identifies the link aggregate interface
44955           required: true
44956           type: string
44957           example: __INTERFACE-NAME__
44958         - name: interface-name
44959           in: path
44960           description: Name given to the interface
44961           required: true
44962           type: string
44963           example: __INTERFACE-NAME__
44964         - name: pci-id
44965           in: path
44966           description: PCI ID used to identify the sriov-vf
44967           required: true
44968           type: string
44969           example: __PCI-ID__
44970         - name: body
44971           in: body
44972           description: sriov-vf object that needs to be created or updated.
44973           required: true
44974           schema:
44975             $ref: "#/patchDefinitions/sriov-vf"
44976     delete:
44977       tags:
44978         - Network
44979       summary: delete an existing sriov-vf
44980       description: delete an existing sriov-vf
44981       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
44982       consumes:
44983         - application/json
44984         - application/xml
44985       produces:
44986         - application/json
44987         - application/xml
44988       responses:
44989         "default":
44990           description: Response codes found in [response codes](https://wiki.onap.org/).
44991       parameters:
44992         - name: pnf-name
44993           in: path
44994           description: unique name of Physical Network Function.
44995           required: true
44996           type: string
44997           example: __PNF-NAME__
44998         - name: interface-name
44999           in: path
45000           description: Name that identifies the link aggregate interface
45001           required: true
45002           type: string
45003           example: __INTERFACE-NAME__
45004         - name: interface-name
45005           in: path
45006           description: Name given to the interface
45007           required: true
45008           type: string
45009           example: __INTERFACE-NAME__
45010         - name: pci-id
45011           in: path
45012           description: PCI ID used to identify the sriov-vf
45013           required: true
45014           type: string
45015           example: __PCI-ID__
45016         - name: resource-version
45017           in: query
45018           description: resource-version for concurrency
45019           required: true
45020           type: string
45021   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
45022     get:
45023       tags:
45024         - Network
45025       summary: returns sriov-vfs
45026       description: returns sriov-vfs
45027       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
45028       produces:
45029         - application/json
45030         - application/xml
45031       responses:
45032         "200":
45033           description: successful operation
45034           schema:
45035               $ref: "#/getDefinitions/sriov-vfs"
45036         "default":
45037           description: Response codes found in [response codes](https://wiki.onap.org/).
45038       parameters:
45039         - name: pnf-name
45040           in: path
45041           description: unique name of Physical Network Function.
45042           required: true
45043           type: string
45044           example: __PNF-NAME__
45045         - name: interface-name
45046           in: path
45047           description: Name that identifies the link aggregate interface
45048           required: true
45049           type: string
45050           example: __INTERFACE-NAME__
45051         - name: interface-name
45052           in: path
45053           description: Name given to the interface
45054           required: true
45055           type: string
45056           example: __INTERFACE-NAME__
45057         - name: inv-status
45058           in: query
45059           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
45060           required: false
45061           type: string
45062         - name: interface-id
45063           in: query
45064           description: ID of interface
45065           required: false
45066           type: string
45067         - name: interface-role
45068           in: query
45069           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
45070           required: false
45071           type: string
45072         - name: interface-id
45073           in: query
45074           description: ID of interface
45075           required: false
45076           type: string
45077         - name: macaddr
45078           in: query
45079           description: MAC address for the interface
45080           required: false
45081           type: string
45082         - name: network-name
45083           in: query
45084           description: Name of the network
45085           required: false
45086           type: string
45087   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
45088     put:
45089       tags:
45090         - Network
45091       summary: see node definition for valid relationships
45092       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
45093       consumes:
45094         - application/json
45095         - application/xml
45096       produces:
45097         - application/json
45098         - application/xml
45099       responses:
45100         "default":
45101           description: Response codes found in [response codes](https://wiki.onap.org/).
45102       parameters:
45103         - name: pnf-name
45104           in: path
45105           description: unique name of Physical Network Function.
45106           required: true
45107           type: string
45108           example: __PNF-NAME__
45109         - name: interface-name
45110           in: path
45111           description: Name that identifies the link aggregate interface
45112           required: true
45113           type: string
45114           example: __INTERFACE-NAME__
45115         - name: interface-name
45116           in: path
45117           description: Name given to the interface
45118           required: true
45119           type: string
45120           example: __INTERFACE-NAME__
45121         - name: body
45122           in: body
45123           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
45124           required: true
45125           schema:
45126             $ref: "#/definitions/relationship"
45127     delete:
45128       tags:
45129         - Network
45130       summary: delete an existing relationship
45131       description: delete an existing relationship
45132       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
45133       consumes:
45134         - application/json
45135         - application/xml
45136       produces:
45137         - application/json
45138         - application/xml
45139       responses:
45140         "default":
45141           description: Response codes found in [response codes](https://wiki.onap.org/).
45142       parameters:
45143         - name: pnf-name
45144           in: path
45145           description: unique name of Physical Network Function.
45146           required: true
45147           type: string
45148           example: __PNF-NAME__
45149         - name: interface-name
45150           in: path
45151           description: Name that identifies the link aggregate interface
45152           required: true
45153           type: string
45154           example: __INTERFACE-NAME__
45155         - name: interface-name
45156           in: path
45157           description: Name given to the interface
45158           required: true
45159           type: string
45160           example: __INTERFACE-NAME__
45161   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
45162     put:
45163       tags:
45164         - Network
45165       summary: see node definition for valid relationships
45166       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
45167       consumes:
45168         - application/json
45169         - application/xml
45170       produces:
45171         - application/json
45172         - application/xml
45173       responses:
45174         "default":
45175           description: Response codes found in [response codes](https://wiki.onap.org/).
45176       parameters:
45177         - name: pnf-name
45178           in: path
45179           description: unique name of Physical Network Function.
45180           required: true
45181           type: string
45182           example: __PNF-NAME__
45183         - name: interface-name
45184           in: path
45185           description: Name that identifies the link aggregate interface
45186           required: true
45187           type: string
45188           example: __INTERFACE-NAME__
45189         - name: interface-name
45190           in: path
45191           description: Name given to the interface
45192           required: true
45193           type: string
45194           example: __INTERFACE-NAME__
45195         - name: l3-interface-ipv4-address
45196           in: path
45197           description: IP address
45198           required: true
45199           type: string
45200           example: __L3-INTERFACE-IPV4-ADDRESS__
45201         - name: body
45202           in: body
45203           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
45204           required: true
45205           schema:
45206             $ref: "#/definitions/relationship"
45207     delete:
45208       tags:
45209         - Network
45210       summary: delete an existing relationship
45211       description: delete an existing relationship
45212       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
45213       consumes:
45214         - application/json
45215         - application/xml
45216       produces:
45217         - application/json
45218         - application/xml
45219       responses:
45220         "default":
45221           description: Response codes found in [response codes](https://wiki.onap.org/).
45222       parameters:
45223         - name: pnf-name
45224           in: path
45225           description: unique name of Physical Network Function.
45226           required: true
45227           type: string
45228           example: __PNF-NAME__
45229         - name: interface-name
45230           in: path
45231           description: Name that identifies the link aggregate interface
45232           required: true
45233           type: string
45234           example: __INTERFACE-NAME__
45235         - name: interface-name
45236           in: path
45237           description: Name given to the interface
45238           required: true
45239           type: string
45240           example: __INTERFACE-NAME__
45241         - name: l3-interface-ipv4-address
45242           in: path
45243           description: IP address
45244           required: true
45245           type: string
45246           example: __L3-INTERFACE-IPV4-ADDRESS__
45247   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
45248     get:
45249       tags:
45250         - Network
45251       summary: returns l3-interface-ipv4-address-list
45252       description: returns l3-interface-ipv4-address-list
45253       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
45254       produces:
45255         - application/json
45256         - application/xml
45257       responses:
45258         "200":
45259           description: successful operation
45260           schema:
45261               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
45262         "default":
45263           description: Response codes found in [response codes](https://wiki.onap.org/).
45264       parameters:
45265         - name: pnf-name
45266           in: path
45267           description: unique name of Physical Network Function.
45268           required: true
45269           type: string
45270           example: __PNF-NAME__
45271         - name: interface-name
45272           in: path
45273           description: Name that identifies the link aggregate interface
45274           required: true
45275           type: string
45276           example: __INTERFACE-NAME__
45277         - name: interface-name
45278           in: path
45279           description: Name given to the interface
45280           required: true
45281           type: string
45282           example: __INTERFACE-NAME__
45283         - name: l3-interface-ipv4-address
45284           in: path
45285           description: IP address
45286           required: true
45287           type: string
45288           example: __L3-INTERFACE-IPV4-ADDRESS__
45289         - name: inv-status
45290           in: query
45291           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
45292           required: false
45293           type: string
45294         - name: interface-id
45295           in: query
45296           description: ID of interface
45297           required: false
45298           type: string
45299         - name: interface-role
45300           in: query
45301           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
45302           required: false
45303           type: string
45304         - name: interface-id
45305           in: query
45306           description: ID of interface
45307           required: false
45308           type: string
45309         - name: macaddr
45310           in: query
45311           description: MAC address for the interface
45312           required: false
45313           type: string
45314         - name: network-name
45315           in: query
45316           description: Name of the network
45317           required: false
45318           type: string
45319         - name: vlan-id-inner
45320           in: query
45321           description: Inner VLAN tag
45322           required: false
45323           type: integer
45324           format: int64
45325         - name: neutron-network-id
45326           in: query
45327           description: Neutron network id of the interface that address belongs to
45328           required: false
45329           type: string
45330         - name: neutron-subnet-id
45331           in: query
45332           description: Neutron id of subnet that address belongs to
45333           required: false
45334           type: string
45335     put:
45336       tags:
45337         - Network
45338       summary: create or update an existing l3-interface-ipv4-address-list
45339       description: |
45340         Create or update an existing l3-interface-ipv4-address-list.
45341         #
45342         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
45343       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
45344       consumes:
45345         - application/json
45346         - application/xml
45347       produces:
45348         - application/json
45349         - application/xml
45350       responses:
45351         "default":
45352           description: Response codes found in [response codes](https://wiki.onap.org/).
45353       parameters:
45354         - name: pnf-name
45355           in: path
45356           description: unique name of Physical Network Function.
45357           required: true
45358           type: string
45359           example: __PNF-NAME__
45360         - name: interface-name
45361           in: path
45362           description: Name that identifies the link aggregate interface
45363           required: true
45364           type: string
45365           example: __INTERFACE-NAME__
45366         - name: interface-name
45367           in: path
45368           description: Name given to the interface
45369           required: true
45370           type: string
45371           example: __INTERFACE-NAME__
45372         - name: l3-interface-ipv4-address
45373           in: path
45374           description: IP address
45375           required: true
45376           type: string
45377           example: __L3-INTERFACE-IPV4-ADDRESS__
45378         - name: body
45379           in: body
45380           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
45381           required: true
45382           schema:
45383             $ref: "#/definitions/l3-interface-ipv4-address-list"
45384     patch:
45385       tags:
45386         - Network
45387       summary: update an existing l3-interface-ipv4-address-list
45388       description: |
45389         Update an existing l3-interface-ipv4-address-list
45390         #
45391         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
45392         The PUT operation will entirely replace an existing object.
45393         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
45394         #
45395         Other differences between PUT and PATCH are:
45396         #
45397         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
45398         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
45399         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
45400       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
45401       consumes:
45402         - application/json
45403         - application/xml
45404       produces:
45405         - application/json
45406         - application/xml
45407       responses:
45408         "default":
45409           description: Response codes found in [response codes](https://wiki.onap.org/).
45410       parameters:
45411         - name: pnf-name
45412           in: path
45413           description: unique name of Physical Network Function.
45414           required: true
45415           type: string
45416           example: __PNF-NAME__
45417         - name: interface-name
45418           in: path
45419           description: Name that identifies the link aggregate interface
45420           required: true
45421           type: string
45422           example: __INTERFACE-NAME__
45423         - name: interface-name
45424           in: path
45425           description: Name given to the interface
45426           required: true
45427           type: string
45428           example: __INTERFACE-NAME__
45429         - name: l3-interface-ipv4-address
45430           in: path
45431           description: IP address
45432           required: true
45433           type: string
45434           example: __L3-INTERFACE-IPV4-ADDRESS__
45435         - name: body
45436           in: body
45437           description: l3-interface-ipv4-address-list object that needs to be created or updated.
45438           required: true
45439           schema:
45440             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
45441     delete:
45442       tags:
45443         - Network
45444       summary: delete an existing l3-interface-ipv4-address-list
45445       description: delete an existing l3-interface-ipv4-address-list
45446       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
45447       consumes:
45448         - application/json
45449         - application/xml
45450       produces:
45451         - application/json
45452         - application/xml
45453       responses:
45454         "default":
45455           description: Response codes found in [response codes](https://wiki.onap.org/).
45456       parameters:
45457         - name: pnf-name
45458           in: path
45459           description: unique name of Physical Network Function.
45460           required: true
45461           type: string
45462           example: __PNF-NAME__
45463         - name: interface-name
45464           in: path
45465           description: Name that identifies the link aggregate interface
45466           required: true
45467           type: string
45468           example: __INTERFACE-NAME__
45469         - name: interface-name
45470           in: path
45471           description: Name given to the interface
45472           required: true
45473           type: string
45474           example: __INTERFACE-NAME__
45475         - name: l3-interface-ipv4-address
45476           in: path
45477           description: IP address
45478           required: true
45479           type: string
45480           example: __L3-INTERFACE-IPV4-ADDRESS__
45481         - name: resource-version
45482           in: query
45483           description: resource-version for concurrency
45484           required: true
45485           type: string
45486   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
45487     put:
45488       tags:
45489         - Network
45490       summary: see node definition for valid relationships
45491       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
45492       consumes:
45493         - application/json
45494         - application/xml
45495       produces:
45496         - application/json
45497         - application/xml
45498       responses:
45499         "default":
45500           description: Response codes found in [response codes](https://wiki.onap.org/).
45501       parameters:
45502         - name: pnf-name
45503           in: path
45504           description: unique name of Physical Network Function.
45505           required: true
45506           type: string
45507           example: __PNF-NAME__
45508         - name: interface-name
45509           in: path
45510           description: Name that identifies the link aggregate interface
45511           required: true
45512           type: string
45513           example: __INTERFACE-NAME__
45514         - name: interface-name
45515           in: path
45516           description: Name given to the interface
45517           required: true
45518           type: string
45519           example: __INTERFACE-NAME__
45520         - name: l3-interface-ipv6-address
45521           in: path
45522           description: IP address
45523           required: true
45524           type: string
45525           example: __L3-INTERFACE-IPV6-ADDRESS__
45526         - name: body
45527           in: body
45528           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
45529           required: true
45530           schema:
45531             $ref: "#/definitions/relationship"
45532     delete:
45533       tags:
45534         - Network
45535       summary: delete an existing relationship
45536       description: delete an existing relationship
45537       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
45538       consumes:
45539         - application/json
45540         - application/xml
45541       produces:
45542         - application/json
45543         - application/xml
45544       responses:
45545         "default":
45546           description: Response codes found in [response codes](https://wiki.onap.org/).
45547       parameters:
45548         - name: pnf-name
45549           in: path
45550           description: unique name of Physical Network Function.
45551           required: true
45552           type: string
45553           example: __PNF-NAME__
45554         - name: interface-name
45555           in: path
45556           description: Name that identifies the link aggregate interface
45557           required: true
45558           type: string
45559           example: __INTERFACE-NAME__
45560         - name: interface-name
45561           in: path
45562           description: Name given to the interface
45563           required: true
45564           type: string
45565           example: __INTERFACE-NAME__
45566         - name: l3-interface-ipv6-address
45567           in: path
45568           description: IP address
45569           required: true
45570           type: string
45571           example: __L3-INTERFACE-IPV6-ADDRESS__
45572   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
45573     get:
45574       tags:
45575         - Network
45576       summary: returns l3-interface-ipv6-address-list
45577       description: returns l3-interface-ipv6-address-list
45578       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
45579       produces:
45580         - application/json
45581         - application/xml
45582       responses:
45583         "200":
45584           description: successful operation
45585           schema:
45586               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
45587         "default":
45588           description: Response codes found in [response codes](https://wiki.onap.org/).
45589       parameters:
45590         - name: pnf-name
45591           in: path
45592           description: unique name of Physical Network Function.
45593           required: true
45594           type: string
45595           example: __PNF-NAME__
45596         - name: interface-name
45597           in: path
45598           description: Name that identifies the link aggregate interface
45599           required: true
45600           type: string
45601           example: __INTERFACE-NAME__
45602         - name: interface-name
45603           in: path
45604           description: Name given to the interface
45605           required: true
45606           type: string
45607           example: __INTERFACE-NAME__
45608         - name: l3-interface-ipv6-address
45609           in: path
45610           description: IP address
45611           required: true
45612           type: string
45613           example: __L3-INTERFACE-IPV6-ADDRESS__
45614         - name: inv-status
45615           in: query
45616           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
45617           required: false
45618           type: string
45619         - name: interface-id
45620           in: query
45621           description: ID of interface
45622           required: false
45623           type: string
45624         - name: interface-role
45625           in: query
45626           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
45627           required: false
45628           type: string
45629         - name: interface-id
45630           in: query
45631           description: ID of interface
45632           required: false
45633           type: string
45634         - name: macaddr
45635           in: query
45636           description: MAC address for the interface
45637           required: false
45638           type: string
45639         - name: network-name
45640           in: query
45641           description: Name of the network
45642           required: false
45643           type: string
45644         - name: vlan-id-inner
45645           in: query
45646           description: Inner VLAN tag
45647           required: false
45648           type: integer
45649           format: int64
45650         - name: neutron-network-id
45651           in: query
45652           description: Neutron network id of the interface that address belongs to
45653           required: false
45654           type: string
45655         - name: neutron-subnet-id
45656           in: query
45657           description: Neutron id of subnet that address belongs to
45658           required: false
45659           type: string
45660     put:
45661       tags:
45662         - Network
45663       summary: create or update an existing l3-interface-ipv6-address-list
45664       description: |
45665         Create or update an existing l3-interface-ipv6-address-list.
45666         #
45667         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
45668       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
45669       consumes:
45670         - application/json
45671         - application/xml
45672       produces:
45673         - application/json
45674         - application/xml
45675       responses:
45676         "default":
45677           description: Response codes found in [response codes](https://wiki.onap.org/).
45678       parameters:
45679         - name: pnf-name
45680           in: path
45681           description: unique name of Physical Network Function.
45682           required: true
45683           type: string
45684           example: __PNF-NAME__
45685         - name: interface-name
45686           in: path
45687           description: Name that identifies the link aggregate interface
45688           required: true
45689           type: string
45690           example: __INTERFACE-NAME__
45691         - name: interface-name
45692           in: path
45693           description: Name given to the interface
45694           required: true
45695           type: string
45696           example: __INTERFACE-NAME__
45697         - name: l3-interface-ipv6-address
45698           in: path
45699           description: IP address
45700           required: true
45701           type: string
45702           example: __L3-INTERFACE-IPV6-ADDRESS__
45703         - name: body
45704           in: body
45705           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
45706           required: true
45707           schema:
45708             $ref: "#/definitions/l3-interface-ipv6-address-list"
45709     patch:
45710       tags:
45711         - Network
45712       summary: update an existing l3-interface-ipv6-address-list
45713       description: |
45714         Update an existing l3-interface-ipv6-address-list
45715         #
45716         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
45717         The PUT operation will entirely replace an existing object.
45718         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
45719         #
45720         Other differences between PUT and PATCH are:
45721         #
45722         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
45723         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
45724         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
45725       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
45726       consumes:
45727         - application/json
45728         - application/xml
45729       produces:
45730         - application/json
45731         - application/xml
45732       responses:
45733         "default":
45734           description: Response codes found in [response codes](https://wiki.onap.org/).
45735       parameters:
45736         - name: pnf-name
45737           in: path
45738           description: unique name of Physical Network Function.
45739           required: true
45740           type: string
45741           example: __PNF-NAME__
45742         - name: interface-name
45743           in: path
45744           description: Name that identifies the link aggregate interface
45745           required: true
45746           type: string
45747           example: __INTERFACE-NAME__
45748         - name: interface-name
45749           in: path
45750           description: Name given to the interface
45751           required: true
45752           type: string
45753           example: __INTERFACE-NAME__
45754         - name: l3-interface-ipv6-address
45755           in: path
45756           description: IP address
45757           required: true
45758           type: string
45759           example: __L3-INTERFACE-IPV6-ADDRESS__
45760         - name: body
45761           in: body
45762           description: l3-interface-ipv6-address-list object that needs to be created or updated.
45763           required: true
45764           schema:
45765             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
45766     delete:
45767       tags:
45768         - Network
45769       summary: delete an existing l3-interface-ipv6-address-list
45770       description: delete an existing l3-interface-ipv6-address-list
45771       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
45772       consumes:
45773         - application/json
45774         - application/xml
45775       produces:
45776         - application/json
45777         - application/xml
45778       responses:
45779         "default":
45780           description: Response codes found in [response codes](https://wiki.onap.org/).
45781       parameters:
45782         - name: pnf-name
45783           in: path
45784           description: unique name of Physical Network Function.
45785           required: true
45786           type: string
45787           example: __PNF-NAME__
45788         - name: interface-name
45789           in: path
45790           description: Name that identifies the link aggregate interface
45791           required: true
45792           type: string
45793           example: __INTERFACE-NAME__
45794         - name: interface-name
45795           in: path
45796           description: Name given to the interface
45797           required: true
45798           type: string
45799           example: __INTERFACE-NAME__
45800         - name: l3-interface-ipv6-address
45801           in: path
45802           description: IP address
45803           required: true
45804           type: string
45805           example: __L3-INTERFACE-IPV6-ADDRESS__
45806         - name: resource-version
45807           in: query
45808           description: resource-version for concurrency
45809           required: true
45810           type: string
45811   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
45812     get:
45813       tags:
45814         - Network
45815       summary: returns l-interface
45816       description: returns l-interface
45817       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
45818       produces:
45819         - application/json
45820         - application/xml
45821       responses:
45822         "200":
45823           description: successful operation
45824           schema:
45825               $ref: "#/getDefinitions/l-interface"
45826         "default":
45827           description: Response codes found in [response codes](https://wiki.onap.org/).
45828       parameters:
45829         - name: pnf-name
45830           in: path
45831           description: unique name of Physical Network Function.
45832           required: true
45833           type: string
45834           example: __PNF-NAME__
45835         - name: interface-name
45836           in: path
45837           description: Name that identifies the link aggregate interface
45838           required: true
45839           type: string
45840           example: __INTERFACE-NAME__
45841         - name: interface-name
45842           in: path
45843           description: Name given to the interface
45844           required: true
45845           type: string
45846           example: __INTERFACE-NAME__
45847         - name: inv-status
45848           in: query
45849           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
45850           required: false
45851           type: string
45852         - name: interface-id
45853           in: query
45854           description: ID of interface
45855           required: false
45856           type: string
45857         - name: interface-role
45858           in: query
45859           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
45860           required: false
45861           type: string
45862         - name: interface-id
45863           in: query
45864           description: ID of interface
45865           required: false
45866           type: string
45867         - name: macaddr
45868           in: query
45869           description: MAC address for the interface
45870           required: false
45871           type: string
45872         - name: network-name
45873           in: query
45874           description: Name of the network
45875           required: false
45876           type: string
45877     put:
45878       tags:
45879         - Network
45880       summary: create or update an existing l-interface
45881       description: |
45882         Create or update an existing l-interface.
45883         #
45884         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
45885       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
45886       consumes:
45887         - application/json
45888         - application/xml
45889       produces:
45890         - application/json
45891         - application/xml
45892       responses:
45893         "default":
45894           description: Response codes found in [response codes](https://wiki.onap.org/).
45895       parameters:
45896         - name: pnf-name
45897           in: path
45898           description: unique name of Physical Network Function.
45899           required: true
45900           type: string
45901           example: __PNF-NAME__
45902         - name: interface-name
45903           in: path
45904           description: Name that identifies the link aggregate interface
45905           required: true
45906           type: string
45907           example: __INTERFACE-NAME__
45908         - name: interface-name
45909           in: path
45910           description: Name given to the interface
45911           required: true
45912           type: string
45913           example: __INTERFACE-NAME__
45914         - name: body
45915           in: body
45916           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
45917           required: true
45918           schema:
45919             $ref: "#/definitions/l-interface"
45920     patch:
45921       tags:
45922         - Network
45923       summary: update an existing l-interface
45924       description: |
45925         Update an existing l-interface
45926         #
45927         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
45928         The PUT operation will entirely replace an existing object.
45929         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
45930         #
45931         Other differences between PUT and PATCH are:
45932         #
45933         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
45934         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
45935         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
45936       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
45937       consumes:
45938         - application/json
45939         - application/xml
45940       produces:
45941         - application/json
45942         - application/xml
45943       responses:
45944         "default":
45945           description: Response codes found in [response codes](https://wiki.onap.org/).
45946       parameters:
45947         - name: pnf-name
45948           in: path
45949           description: unique name of Physical Network Function.
45950           required: true
45951           type: string
45952           example: __PNF-NAME__
45953         - name: interface-name
45954           in: path
45955           description: Name that identifies the link aggregate interface
45956           required: true
45957           type: string
45958           example: __INTERFACE-NAME__
45959         - name: interface-name
45960           in: path
45961           description: Name given to the interface
45962           required: true
45963           type: string
45964           example: __INTERFACE-NAME__
45965         - name: body
45966           in: body
45967           description: l-interface object that needs to be created or updated.
45968           required: true
45969           schema:
45970             $ref: "#/patchDefinitions/l-interface"
45971     delete:
45972       tags:
45973         - Network
45974       summary: delete an existing l-interface
45975       description: delete an existing l-interface
45976       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
45977       consumes:
45978         - application/json
45979         - application/xml
45980       produces:
45981         - application/json
45982         - application/xml
45983       responses:
45984         "default":
45985           description: Response codes found in [response codes](https://wiki.onap.org/).
45986       parameters:
45987         - name: pnf-name
45988           in: path
45989           description: unique name of Physical Network Function.
45990           required: true
45991           type: string
45992           example: __PNF-NAME__
45993         - name: interface-name
45994           in: path
45995           description: Name that identifies the link aggregate interface
45996           required: true
45997           type: string
45998           example: __INTERFACE-NAME__
45999         - name: interface-name
46000           in: path
46001           description: Name given to the interface
46002           required: true
46003           type: string
46004           example: __INTERFACE-NAME__
46005         - name: resource-version
46006           in: query
46007           description: resource-version for concurrency
46008           required: true
46009           type: string
46010   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
46011     get:
46012       tags:
46013         - Network
46014       summary: returns l-interfaces
46015       description: returns l-interfaces
46016       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfaces
46017       produces:
46018         - application/json
46019         - application/xml
46020       responses:
46021         "200":
46022           description: successful operation
46023           schema:
46024               $ref: "#/getDefinitions/l-interfaces"
46025         "default":
46026           description: Response codes found in [response codes](https://wiki.onap.org/).
46027       parameters:
46028         - name: pnf-name
46029           in: path
46030           description: unique name of Physical Network Function.
46031           required: true
46032           type: string
46033           example: __PNF-NAME__
46034         - name: interface-name
46035           in: path
46036           description: Name that identifies the link aggregate interface
46037           required: true
46038           type: string
46039           example: __INTERFACE-NAME__
46040         - name: inv-status
46041           in: query
46042           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
46043           required: false
46044           type: string
46045         - name: interface-id
46046           in: query
46047           description: ID of interface
46048           required: false
46049           type: string
46050         - name: interface-role
46051           in: query
46052           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
46053           required: false
46054           type: string
46055   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}:
46056     get:
46057       tags:
46058         - Network
46059       summary: returns lag-interface
46060       description: returns lag-interface
46061       operationId: getNetworkPnfsPnfLagInterfacesLagInterface
46062       produces:
46063         - application/json
46064         - application/xml
46065       responses:
46066         "200":
46067           description: successful operation
46068           schema:
46069               $ref: "#/getDefinitions/lag-interface"
46070         "default":
46071           description: Response codes found in [response codes](https://wiki.onap.org/).
46072       parameters:
46073         - name: pnf-name
46074           in: path
46075           description: unique name of Physical Network Function.
46076           required: true
46077           type: string
46078           example: __PNF-NAME__
46079         - name: interface-name
46080           in: path
46081           description: Name that identifies the link aggregate interface
46082           required: true
46083           type: string
46084           example: __INTERFACE-NAME__
46085         - name: inv-status
46086           in: query
46087           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
46088           required: false
46089           type: string
46090         - name: interface-id
46091           in: query
46092           description: ID of interface
46093           required: false
46094           type: string
46095         - name: interface-role
46096           in: query
46097           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
46098           required: false
46099           type: string
46100     put:
46101       tags:
46102         - Network
46103       summary: create or update an existing lag-interface
46104       description: |
46105         Create or update an existing lag-interface.
46106         #
46107         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
46108       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterface
46109       consumes:
46110         - application/json
46111         - application/xml
46112       produces:
46113         - application/json
46114         - application/xml
46115       responses:
46116         "default":
46117           description: Response codes found in [response codes](https://wiki.onap.org/).
46118       parameters:
46119         - name: pnf-name
46120           in: path
46121           description: unique name of Physical Network Function.
46122           required: true
46123           type: string
46124           example: __PNF-NAME__
46125         - name: interface-name
46126           in: path
46127           description: Name that identifies the link aggregate interface
46128           required: true
46129           type: string
46130           example: __INTERFACE-NAME__
46131         - name: body
46132           in: body
46133           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterface.json)
46134           required: true
46135           schema:
46136             $ref: "#/definitions/lag-interface"
46137     patch:
46138       tags:
46139         - Network
46140       summary: update an existing lag-interface
46141       description: |
46142         Update an existing lag-interface
46143         #
46144         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
46145         The PUT operation will entirely replace an existing object.
46146         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
46147         #
46148         Other differences between PUT and PATCH are:
46149         #
46150         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
46151         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
46152         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
46153       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterface
46154       consumes:
46155         - application/json
46156         - application/xml
46157       produces:
46158         - application/json
46159         - application/xml
46160       responses:
46161         "default":
46162           description: Response codes found in [response codes](https://wiki.onap.org/).
46163       parameters:
46164         - name: pnf-name
46165           in: path
46166           description: unique name of Physical Network Function.
46167           required: true
46168           type: string
46169           example: __PNF-NAME__
46170         - name: interface-name
46171           in: path
46172           description: Name that identifies the link aggregate interface
46173           required: true
46174           type: string
46175           example: __INTERFACE-NAME__
46176         - name: body
46177           in: body
46178           description: lag-interface object that needs to be created or updated.
46179           required: true
46180           schema:
46181             $ref: "#/patchDefinitions/lag-interface"
46182     delete:
46183       tags:
46184         - Network
46185       summary: delete an existing lag-interface
46186       description: delete an existing lag-interface
46187       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterface
46188       consumes:
46189         - application/json
46190         - application/xml
46191       produces:
46192         - application/json
46193         - application/xml
46194       responses:
46195         "default":
46196           description: Response codes found in [response codes](https://wiki.onap.org/).
46197       parameters:
46198         - name: pnf-name
46199           in: path
46200           description: unique name of Physical Network Function.
46201           required: true
46202           type: string
46203           example: __PNF-NAME__
46204         - name: interface-name
46205           in: path
46206           description: Name that identifies the link aggregate interface
46207           required: true
46208           type: string
46209           example: __INTERFACE-NAME__
46210         - name: resource-version
46211           in: query
46212           description: resource-version for concurrency
46213           required: true
46214           type: string
46215   /network/pnfs/pnf/{pnf-name}/lag-interfaces:
46216     get:
46217       tags:
46218         - Network
46219       summary: returns lag-interfaces
46220       description: returns lag-interfaces
46221       operationId: getNetworkPnfsPnfLagInterfaces
46222       produces:
46223         - application/json
46224         - application/xml
46225       responses:
46226         "200":
46227           description: successful operation
46228           schema:
46229               $ref: "#/getDefinitions/lag-interfaces"
46230         "default":
46231           description: Response codes found in [response codes](https://wiki.onap.org/).
46232       parameters:
46233         - name: pnf-name
46234           in: path
46235           description: unique name of Physical Network Function.
46236           required: true
46237           type: string
46238           example: __PNF-NAME__
46239         - name: inv-status
46240           in: query
46241           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
46242           required: false
46243           type: string
46244   /network/pnfs/pnf/{pnf-name}:
46245     get:
46246       tags:
46247         - Network
46248       summary: returns pnf
46249       description: returns pnf
46250       operationId: getNetworkPnfsPnf
46251       produces:
46252         - application/json
46253         - application/xml
46254       responses:
46255         "200":
46256           description: successful operation
46257           schema:
46258               $ref: "#/getDefinitions/pnf"
46259         "default":
46260           description: Response codes found in [response codes](https://wiki.onap.org/).
46261       parameters:
46262         - name: pnf-name
46263           in: path
46264           description: unique name of Physical Network Function.
46265           required: true
46266           type: string
46267           example: __PNF-NAME__
46268         - name: inv-status
46269           in: query
46270           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
46271           required: false
46272           type: string
46273     put:
46274       tags:
46275         - Network
46276       summary: create or update an existing pnf
46277       description: |
46278         Create or update an existing pnf.
46279         #
46280         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
46281       operationId: createOrUpdateNetworkPnfsPnf
46282       consumes:
46283         - application/json
46284         - application/xml
46285       produces:
46286         - application/json
46287         - application/xml
46288       responses:
46289         "default":
46290           description: Response codes found in [response codes](https://wiki.onap.org/).
46291       parameters:
46292         - name: pnf-name
46293           in: path
46294           description: unique name of Physical Network Function.
46295           required: true
46296           type: string
46297           example: __PNF-NAME__
46298         - name: body
46299           in: body
46300           description: pnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnf.json)
46301           required: true
46302           schema:
46303             $ref: "#/definitions/pnf"
46304     patch:
46305       tags:
46306         - Network
46307       summary: update an existing pnf
46308       description: |
46309         Update an existing pnf
46310         #
46311         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
46312         The PUT operation will entirely replace an existing object.
46313         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
46314         #
46315         Other differences between PUT and PATCH are:
46316         #
46317         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
46318         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
46319         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
46320       operationId: UpdateNetworkPnfsPnf
46321       consumes:
46322         - application/json
46323         - application/xml
46324       produces:
46325         - application/json
46326         - application/xml
46327       responses:
46328         "default":
46329           description: Response codes found in [response codes](https://wiki.onap.org/).
46330       parameters:
46331         - name: pnf-name
46332           in: path
46333           description: unique name of Physical Network Function.
46334           required: true
46335           type: string
46336           example: __PNF-NAME__
46337         - name: body
46338           in: body
46339           description: pnf object that needs to be created or updated.
46340           required: true
46341           schema:
46342             $ref: "#/patchDefinitions/pnf"
46343     delete:
46344       tags:
46345         - Network
46346       summary: delete an existing pnf
46347       description: delete an existing pnf
46348       operationId: deleteNetworkPnfsPnf
46349       consumes:
46350         - application/json
46351         - application/xml
46352       produces:
46353         - application/json
46354         - application/xml
46355       responses:
46356         "default":
46357           description: Response codes found in [response codes](https://wiki.onap.org/).
46358       parameters:
46359         - name: pnf-name
46360           in: path
46361           description: unique name of Physical Network Function.
46362           required: true
46363           type: string
46364           example: __PNF-NAME__
46365         - name: resource-version
46366           in: query
46367           description: resource-version for concurrency
46368           required: true
46369           type: string
46370   /network/pnfs:
46371     get:
46372       tags:
46373         - Network
46374       summary: returns pnfs
46375       description: returns pnfs
46376       operationId: getNetworkPnfs
46377       produces:
46378         - application/json
46379         - application/xml
46380       responses:
46381         "200":
46382           description: successful operation
46383           schema:
46384               $ref: "#/getDefinitions/pnfs"
46385         "default":
46386           description: Response codes found in [response codes](https://wiki.onap.org/).
46387   /network/physical-links/physical-link/{link-name}/relationship-list/relationship:
46388     put:
46389       tags:
46390         - Network
46391       summary: see node definition for valid relationships
46392       operationId: createOrUpdateNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship
46393       consumes:
46394         - application/json
46395         - application/xml
46396       produces:
46397         - application/json
46398         - application/xml
46399       responses:
46400         "default":
46401           description: Response codes found in [response codes](https://wiki.onap.org/).
46402       parameters:
46403         - name: link-name
46404           in: path
46405           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
46406           required: true
46407           type: string
46408           example: __LINK-NAME__
46409         - name: body
46410           in: body
46411           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPhysicalLinksPhysicalLink.json)
46412           required: true
46413           schema:
46414             $ref: "#/definitions/relationship"
46415     delete:
46416       tags:
46417         - Network
46418       summary: delete an existing relationship
46419       description: delete an existing relationship
46420       operationId: deleteNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship
46421       consumes:
46422         - application/json
46423         - application/xml
46424       produces:
46425         - application/json
46426         - application/xml
46427       responses:
46428         "default":
46429           description: Response codes found in [response codes](https://wiki.onap.org/).
46430       parameters:
46431         - name: link-name
46432           in: path
46433           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
46434           required: true
46435           type: string
46436           example: __LINK-NAME__
46437   /network/physical-links/physical-link/{link-name}:
46438     get:
46439       tags:
46440         - Network
46441       summary: returns physical-link
46442       description: returns physical-link
46443       operationId: getNetworkPhysicalLinksPhysicalLink
46444       produces:
46445         - application/json
46446         - application/xml
46447       responses:
46448         "200":
46449           description: successful operation
46450           schema:
46451               $ref: "#/getDefinitions/physical-link"
46452         "default":
46453           description: Response codes found in [response codes](https://wiki.onap.org/).
46454       parameters:
46455         - name: link-name
46456           in: path
46457           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
46458           required: true
46459           type: string
46460           example: __LINK-NAME__
46461         - name: circuit-id
46462           in: query
46463           description: Circuit it
46464           required: false
46465           type: string
46466     put:
46467       tags:
46468         - Network
46469       summary: create or update an existing physical-link
46470       description: |
46471         Create or update an existing physical-link.
46472         #
46473         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
46474       operationId: createOrUpdateNetworkPhysicalLinksPhysicalLink
46475       consumes:
46476         - application/json
46477         - application/xml
46478       produces:
46479         - application/json
46480         - application/xml
46481       responses:
46482         "default":
46483           description: Response codes found in [response codes](https://wiki.onap.org/).
46484       parameters:
46485         - name: link-name
46486           in: path
46487           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
46488           required: true
46489           type: string
46490           example: __LINK-NAME__
46491         - name: body
46492           in: body
46493           description: physical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPhysicalLinksPhysicalLink.json)
46494           required: true
46495           schema:
46496             $ref: "#/definitions/physical-link"
46497     patch:
46498       tags:
46499         - Network
46500       summary: update an existing physical-link
46501       description: |
46502         Update an existing physical-link
46503         #
46504         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
46505         The PUT operation will entirely replace an existing object.
46506         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
46507         #
46508         Other differences between PUT and PATCH are:
46509         #
46510         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
46511         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
46512         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
46513       operationId: UpdateNetworkPhysicalLinksPhysicalLink
46514       consumes:
46515         - application/json
46516         - application/xml
46517       produces:
46518         - application/json
46519         - application/xml
46520       responses:
46521         "default":
46522           description: Response codes found in [response codes](https://wiki.onap.org/).
46523       parameters:
46524         - name: link-name
46525           in: path
46526           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
46527           required: true
46528           type: string
46529           example: __LINK-NAME__
46530         - name: body
46531           in: body
46532           description: physical-link object that needs to be created or updated.
46533           required: true
46534           schema:
46535             $ref: "#/patchDefinitions/physical-link"
46536     delete:
46537       tags:
46538         - Network
46539       summary: delete an existing physical-link
46540       description: delete an existing physical-link
46541       operationId: deleteNetworkPhysicalLinksPhysicalLink
46542       consumes:
46543         - application/json
46544         - application/xml
46545       produces:
46546         - application/json
46547         - application/xml
46548       responses:
46549         "default":
46550           description: Response codes found in [response codes](https://wiki.onap.org/).
46551       parameters:
46552         - name: link-name
46553           in: path
46554           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
46555           required: true
46556           type: string
46557           example: __LINK-NAME__
46558         - name: resource-version
46559           in: query
46560           description: resource-version for concurrency
46561           required: true
46562           type: string
46563   /network/physical-links:
46564     get:
46565       tags:
46566         - Network
46567       summary: returns physical-links
46568       description: returns physical-links
46569       operationId: getNetworkPhysicalLinks
46570       produces:
46571         - application/json
46572         - application/xml
46573       responses:
46574         "200":
46575           description: successful operation
46576           schema:
46577               $ref: "#/getDefinitions/physical-links"
46578         "default":
46579           description: Response codes found in [response codes](https://wiki.onap.org/).
46580   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship:
46581     put:
46582       tags:
46583         - Network
46584       summary: see node definition for valid relationships
46585       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship
46586       consumes:
46587         - application/json
46588         - application/xml
46589       produces:
46590         - application/json
46591         - application/xml
46592       responses:
46593         "default":
46594           description: Response codes found in [response codes](https://wiki.onap.org/).
46595       parameters:
46596         - name: ipsec-configuration-id
46597           in: path
46598           description: UUID of this configuration
46599           required: true
46600           type: string
46601           example: __IPSEC-CONFIGURATION-ID__
46602         - name: body
46603           in: body
46604           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkIpsecConfigurationsIpsecConfiguration.json)
46605           required: true
46606           schema:
46607             $ref: "#/definitions/relationship"
46608     delete:
46609       tags:
46610         - Network
46611       summary: delete an existing relationship
46612       description: delete an existing relationship
46613       operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship
46614       consumes:
46615         - application/json
46616         - application/xml
46617       produces:
46618         - application/json
46619         - application/xml
46620       responses:
46621         "default":
46622           description: Response codes found in [response codes](https://wiki.onap.org/).
46623       parameters:
46624         - name: ipsec-configuration-id
46625           in: path
46626           description: UUID of this configuration
46627           required: true
46628           type: string
46629           example: __IPSEC-CONFIGURATION-ID__
46630   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship:
46631     put:
46632       tags:
46633         - Network
46634       summary: see node definition for valid relationships
46635       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship
46636       consumes:
46637         - application/json
46638         - application/xml
46639       produces:
46640         - application/json
46641         - application/xml
46642       responses:
46643         "default":
46644           description: Response codes found in [response codes](https://wiki.onap.org/).
46645       parameters:
46646         - name: ipsec-configuration-id
46647           in: path
46648           description: UUID of this configuration
46649           required: true
46650           type: string
46651           example: __IPSEC-CONFIGURATION-ID__
46652         - name: vig-address-type
46653           in: path
46654           description: indicates whether the VIG is for AVPN or INTERNET
46655           required: true
46656           type: string
46657           example: __VIG-ADDRESS-TYPE__
46658         - name: body
46659           in: body
46660           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
46661           required: true
46662           schema:
46663             $ref: "#/definitions/relationship"
46664     delete:
46665       tags:
46666         - Network
46667       summary: delete an existing relationship
46668       description: delete an existing relationship
46669       operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship
46670       consumes:
46671         - application/json
46672         - application/xml
46673       produces:
46674         - application/json
46675         - application/xml
46676       responses:
46677         "default":
46678           description: Response codes found in [response codes](https://wiki.onap.org/).
46679       parameters:
46680         - name: ipsec-configuration-id
46681           in: path
46682           description: UUID of this configuration
46683           required: true
46684           type: string
46685           example: __IPSEC-CONFIGURATION-ID__
46686         - name: vig-address-type
46687           in: path
46688           description: indicates whether the VIG is for AVPN or INTERNET
46689           required: true
46690           type: string
46691           example: __VIG-ADDRESS-TYPE__
46692   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}:
46693     get:
46694       tags:
46695         - Network
46696       summary: returns vig-server
46697       description: returns vig-server
46698       operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
46699       produces:
46700         - application/json
46701         - application/xml
46702       responses:
46703         "200":
46704           description: successful operation
46705           schema:
46706               $ref: "#/getDefinitions/vig-server"
46707         "default":
46708           description: Response codes found in [response codes](https://wiki.onap.org/).
46709       parameters:
46710         - name: ipsec-configuration-id
46711           in: path
46712           description: UUID of this configuration
46713           required: true
46714           type: string
46715           example: __IPSEC-CONFIGURATION-ID__
46716         - name: vig-address-type
46717           in: path
46718           description: indicates whether the VIG is for AVPN or INTERNET
46719           required: true
46720           type: string
46721           example: __VIG-ADDRESS-TYPE__
46722     put:
46723       tags:
46724         - Network
46725       summary: create or update an existing vig-server
46726       description: |
46727         Create or update an existing vig-server.
46728         #
46729         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
46730       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
46731       consumes:
46732         - application/json
46733         - application/xml
46734       produces:
46735         - application/json
46736         - application/xml
46737       responses:
46738         "default":
46739           description: Response codes found in [response codes](https://wiki.onap.org/).
46740       parameters:
46741         - name: ipsec-configuration-id
46742           in: path
46743           description: UUID of this configuration
46744           required: true
46745           type: string
46746           example: __IPSEC-CONFIGURATION-ID__
46747         - name: vig-address-type
46748           in: path
46749           description: indicates whether the VIG is for AVPN or INTERNET
46750           required: true
46751           type: string
46752           example: __VIG-ADDRESS-TYPE__
46753         - name: body
46754           in: body
46755           description: vig-server object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
46756           required: true
46757           schema:
46758             $ref: "#/definitions/vig-server"
46759     patch:
46760       tags:
46761         - Network
46762       summary: update an existing vig-server
46763       description: |
46764         Update an existing vig-server
46765         #
46766         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
46767         The PUT operation will entirely replace an existing object.
46768         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
46769         #
46770         Other differences between PUT and PATCH are:
46771         #
46772         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
46773         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
46774         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
46775       operationId: UpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
46776       consumes:
46777         - application/json
46778         - application/xml
46779       produces:
46780         - application/json
46781         - application/xml
46782       responses:
46783         "default":
46784           description: Response codes found in [response codes](https://wiki.onap.org/).
46785       parameters:
46786         - name: ipsec-configuration-id
46787           in: path
46788           description: UUID of this configuration
46789           required: true
46790           type: string
46791           example: __IPSEC-CONFIGURATION-ID__
46792         - name: vig-address-type
46793           in: path
46794           description: indicates whether the VIG is for AVPN or INTERNET
46795           required: true
46796           type: string
46797           example: __VIG-ADDRESS-TYPE__
46798         - name: body
46799           in: body
46800           description: vig-server object that needs to be created or updated.
46801           required: true
46802           schema:
46803             $ref: "#/patchDefinitions/vig-server"
46804     delete:
46805       tags:
46806         - Network
46807       summary: delete an existing vig-server
46808       description: delete an existing vig-server
46809       operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
46810       consumes:
46811         - application/json
46812         - application/xml
46813       produces:
46814         - application/json
46815         - application/xml
46816       responses:
46817         "default":
46818           description: Response codes found in [response codes](https://wiki.onap.org/).
46819       parameters:
46820         - name: ipsec-configuration-id
46821           in: path
46822           description: UUID of this configuration
46823           required: true
46824           type: string
46825           example: __IPSEC-CONFIGURATION-ID__
46826         - name: vig-address-type
46827           in: path
46828           description: indicates whether the VIG is for AVPN or INTERNET
46829           required: true
46830           type: string
46831           example: __VIG-ADDRESS-TYPE__
46832         - name: resource-version
46833           in: query
46834           description: resource-version for concurrency
46835           required: true
46836           type: string
46837   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers:
46838     get:
46839       tags:
46840         - Network
46841       summary: returns vig-servers
46842       description: returns vig-servers
46843       operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServers
46844       produces:
46845         - application/json
46846         - application/xml
46847       responses:
46848         "200":
46849           description: successful operation
46850           schema:
46851               $ref: "#/getDefinitions/vig-servers"
46852         "default":
46853           description: Response codes found in [response codes](https://wiki.onap.org/).
46854       parameters:
46855         - name: ipsec-configuration-id
46856           in: path
46857           description: UUID of this configuration
46858           required: true
46859           type: string
46860           example: __IPSEC-CONFIGURATION-ID__
46861   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}:
46862     get:
46863       tags:
46864         - Network
46865       summary: returns ipsec-configuration
46866       description: returns ipsec-configuration
46867       operationId: getNetworkIpsecConfigurationsIpsecConfiguration
46868       produces:
46869         - application/json
46870         - application/xml
46871       responses:
46872         "200":
46873           description: successful operation
46874           schema:
46875               $ref: "#/getDefinitions/ipsec-configuration"
46876         "default":
46877           description: Response codes found in [response codes](https://wiki.onap.org/).
46878       parameters:
46879         - name: ipsec-configuration-id
46880           in: path
46881           description: UUID of this configuration
46882           required: true
46883           type: string
46884           example: __IPSEC-CONFIGURATION-ID__
46885     put:
46886       tags:
46887         - Network
46888       summary: create or update an existing ipsec-configuration
46889       description: |
46890         Create or update an existing ipsec-configuration.
46891         #
46892         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
46893       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfiguration
46894       consumes:
46895         - application/json
46896         - application/xml
46897       produces:
46898         - application/json
46899         - application/xml
46900       responses:
46901         "default":
46902           description: Response codes found in [response codes](https://wiki.onap.org/).
46903       parameters:
46904         - name: ipsec-configuration-id
46905           in: path
46906           description: UUID of this configuration
46907           required: true
46908           type: string
46909           example: __IPSEC-CONFIGURATION-ID__
46910         - name: body
46911           in: body
46912           description: ipsec-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkIpsecConfigurationsIpsecConfiguration.json)
46913           required: true
46914           schema:
46915             $ref: "#/definitions/ipsec-configuration"
46916     patch:
46917       tags:
46918         - Network
46919       summary: update an existing ipsec-configuration
46920       description: |
46921         Update an existing ipsec-configuration
46922         #
46923         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
46924         The PUT operation will entirely replace an existing object.
46925         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
46926         #
46927         Other differences between PUT and PATCH are:
46928         #
46929         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
46930         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
46931         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
46932       operationId: UpdateNetworkIpsecConfigurationsIpsecConfiguration
46933       consumes:
46934         - application/json
46935         - application/xml
46936       produces:
46937         - application/json
46938         - application/xml
46939       responses:
46940         "default":
46941           description: Response codes found in [response codes](https://wiki.onap.org/).
46942       parameters:
46943         - name: ipsec-configuration-id
46944           in: path
46945           description: UUID of this configuration
46946           required: true
46947           type: string
46948           example: __IPSEC-CONFIGURATION-ID__
46949         - name: body
46950           in: body
46951           description: ipsec-configuration object that needs to be created or updated.
46952           required: true
46953           schema:
46954             $ref: "#/patchDefinitions/ipsec-configuration"
46955     delete:
46956       tags:
46957         - Network
46958       summary: delete an existing ipsec-configuration
46959       description: delete an existing ipsec-configuration
46960       operationId: deleteNetworkIpsecConfigurationsIpsecConfiguration
46961       consumes:
46962         - application/json
46963         - application/xml
46964       produces:
46965         - application/json
46966         - application/xml
46967       responses:
46968         "default":
46969           description: Response codes found in [response codes](https://wiki.onap.org/).
46970       parameters:
46971         - name: ipsec-configuration-id
46972           in: path
46973           description: UUID of this configuration
46974           required: true
46975           type: string
46976           example: __IPSEC-CONFIGURATION-ID__
46977         - name: resource-version
46978           in: query
46979           description: resource-version for concurrency
46980           required: true
46981           type: string
46982   /network/ipsec-configurations:
46983     get:
46984       tags:
46985         - Network
46986       summary: returns ipsec-configurations
46987       description: returns ipsec-configurations
46988       operationId: getNetworkIpsecConfigurations
46989       produces:
46990         - application/json
46991         - application/xml
46992       responses:
46993         "200":
46994           description: successful operation
46995           schema:
46996               $ref: "#/getDefinitions/ipsec-configurations"
46997         "default":
46998           description: Response codes found in [response codes](https://wiki.onap.org/).
46999   /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship:
47000     put:
47001       tags:
47002         - Network
47003       summary: see node definition for valid relationships
47004       operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship
47005       consumes:
47006         - application/json
47007         - application/xml
47008       produces:
47009         - application/json
47010         - application/xml
47011       responses:
47012         "default":
47013           description: Response codes found in [response codes](https://wiki.onap.org/).
47014       parameters:
47015         - name: route-table-reference-id
47016           in: path
47017           description: Route Table Reference id, UUID assigned to this instance.
47018           required: true
47019           type: string
47020           example: __ROUTE-TABLE-REFERENCE-ID__
47021         - name: body
47022           in: body
47023           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkRouteTableReferencesRouteTableReference.json)
47024           required: true
47025           schema:
47026             $ref: "#/definitions/relationship"
47027     delete:
47028       tags:
47029         - Network
47030       summary: delete an existing relationship
47031       description: delete an existing relationship
47032       operationId: deleteNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship
47033       consumes:
47034         - application/json
47035         - application/xml
47036       produces:
47037         - application/json
47038         - application/xml
47039       responses:
47040         "default":
47041           description: Response codes found in [response codes](https://wiki.onap.org/).
47042       parameters:
47043         - name: route-table-reference-id
47044           in: path
47045           description: Route Table Reference id, UUID assigned to this instance.
47046           required: true
47047           type: string
47048           example: __ROUTE-TABLE-REFERENCE-ID__
47049   /network/route-table-references/route-table-reference/{route-table-reference-id}:
47050     get:
47051       tags:
47052         - Network
47053       summary: returns route-table-reference
47054       description: returns route-table-reference
47055       operationId: getNetworkRouteTableReferencesRouteTableReference
47056       produces:
47057         - application/json
47058         - application/xml
47059       responses:
47060         "200":
47061           description: successful operation
47062           schema:
47063               $ref: "#/getDefinitions/route-table-reference"
47064         "default":
47065           description: Response codes found in [response codes](https://wiki.onap.org/).
47066       parameters:
47067         - name: route-table-reference-id
47068           in: path
47069           description: Route Table Reference id, UUID assigned to this instance.
47070           required: true
47071           type: string
47072           example: __ROUTE-TABLE-REFERENCE-ID__
47073         - name: route-table-reference-fqdn
47074           in: query
47075           description: FQDN entry in the route table.
47076           required: false
47077           type: string
47078     put:
47079       tags:
47080         - Network
47081       summary: create or update an existing route-table-reference
47082       description: |
47083         Create or update an existing route-table-reference.
47084         #
47085         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
47086       operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReference
47087       consumes:
47088         - application/json
47089         - application/xml
47090       produces:
47091         - application/json
47092         - application/xml
47093       responses:
47094         "default":
47095           description: Response codes found in [response codes](https://wiki.onap.org/).
47096       parameters:
47097         - name: route-table-reference-id
47098           in: path
47099           description: Route Table Reference id, UUID assigned to this instance.
47100           required: true
47101           type: string
47102           example: __ROUTE-TABLE-REFERENCE-ID__
47103         - name: body
47104           in: body
47105           description: route-table-reference object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkRouteTableReferencesRouteTableReference.json)
47106           required: true
47107           schema:
47108             $ref: "#/definitions/route-table-reference"
47109     patch:
47110       tags:
47111         - Network
47112       summary: update an existing route-table-reference
47113       description: |
47114         Update an existing route-table-reference
47115         #
47116         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
47117         The PUT operation will entirely replace an existing object.
47118         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
47119         #
47120         Other differences between PUT and PATCH are:
47121         #
47122         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
47123         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
47124         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
47125       operationId: UpdateNetworkRouteTableReferencesRouteTableReference
47126       consumes:
47127         - application/json
47128         - application/xml
47129       produces:
47130         - application/json
47131         - application/xml
47132       responses:
47133         "default":
47134           description: Response codes found in [response codes](https://wiki.onap.org/).
47135       parameters:
47136         - name: route-table-reference-id
47137           in: path
47138           description: Route Table Reference id, UUID assigned to this instance.
47139           required: true
47140           type: string
47141           example: __ROUTE-TABLE-REFERENCE-ID__
47142         - name: body
47143           in: body
47144           description: route-table-reference object that needs to be created or updated.
47145           required: true
47146           schema:
47147             $ref: "#/patchDefinitions/route-table-reference"
47148     delete:
47149       tags:
47150         - Network
47151       summary: delete an existing route-table-reference
47152       description: delete an existing route-table-reference
47153       operationId: deleteNetworkRouteTableReferencesRouteTableReference
47154       consumes:
47155         - application/json
47156         - application/xml
47157       produces:
47158         - application/json
47159         - application/xml
47160       responses:
47161         "default":
47162           description: Response codes found in [response codes](https://wiki.onap.org/).
47163       parameters:
47164         - name: route-table-reference-id
47165           in: path
47166           description: Route Table Reference id, UUID assigned to this instance.
47167           required: true
47168           type: string
47169           example: __ROUTE-TABLE-REFERENCE-ID__
47170         - name: resource-version
47171           in: query
47172           description: resource-version for concurrency
47173           required: true
47174           type: string
47175   /network/route-table-references:
47176     get:
47177       tags:
47178         - Network
47179       summary: returns route-table-references
47180       description: returns route-table-references
47181       operationId: getNetworkRouteTableReferences
47182       produces:
47183         - application/json
47184         - application/xml
47185       responses:
47186         "200":
47187           description: successful operation
47188           schema:
47189               $ref: "#/getDefinitions/route-table-references"
47190         "default":
47191           description: Response codes found in [response codes](https://wiki.onap.org/).
47192   /network/instance-groups/instance-group/{id}/relationship-list/relationship:
47193     put:
47194       tags:
47195         - Network
47196       summary: see node definition for valid relationships
47197       operationId: createOrUpdateNetworkInstanceGroupsInstanceGroupRelationshipListRelationship
47198       consumes:
47199         - application/json
47200         - application/xml
47201       produces:
47202         - application/json
47203         - application/xml
47204       responses:
47205         "default":
47206           description: Response codes found in [response codes](https://wiki.onap.org/).
47207       parameters:
47208         - name: id
47209           in: path
47210           description: Instance Group ID, UUID assigned to this instance.
47211           required: true
47212           type: string
47213           example: __ID__
47214         - name: body
47215           in: body
47216           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkInstanceGroupsInstanceGroup.json)
47217           required: true
47218           schema:
47219             $ref: "#/definitions/relationship"
47220     delete:
47221       tags:
47222         - Network
47223       summary: delete an existing relationship
47224       description: delete an existing relationship
47225       operationId: deleteNetworkInstanceGroupsInstanceGroupRelationshipListRelationship
47226       consumes:
47227         - application/json
47228         - application/xml
47229       produces:
47230         - application/json
47231         - application/xml
47232       responses:
47233         "default":
47234           description: Response codes found in [response codes](https://wiki.onap.org/).
47235       parameters:
47236         - name: id
47237           in: path
47238           description: Instance Group ID, UUID assigned to this instance.
47239           required: true
47240           type: string
47241           example: __ID__
47242   /network/instance-groups/instance-group/{id}:
47243     get:
47244       tags:
47245         - Network
47246       summary: returns instance-group
47247       description: returns instance-group
47248       operationId: getNetworkInstanceGroupsInstanceGroup
47249       produces:
47250         - application/json
47251         - application/xml
47252       responses:
47253         "200":
47254           description: successful operation
47255           schema:
47256               $ref: "#/getDefinitions/instance-group"
47257         "default":
47258           description: Response codes found in [response codes](https://wiki.onap.org/).
47259       parameters:
47260         - name: id
47261           in: path
47262           description: Instance Group ID, UUID assigned to this instance.
47263           required: true
47264           type: string
47265           example: __ID__
47266         - name: description
47267           in: query
47268           description: Descriptive text to help identify the usage of this instance-group
47269           required: false
47270           type: string
47271         - name: type
47272           in: query
47273           description: Only valid value today is lower case ha for high availability
47274           required: false
47275           type: string
47276         - name: sub-type
47277           in: query
47278           description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
47279           required: false
47280           type: string
47281     put:
47282       tags:
47283         - Network
47284       summary: create or update an existing instance-group
47285       description: |
47286         Create or update an existing instance-group.
47287         #
47288         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
47289       operationId: createOrUpdateNetworkInstanceGroupsInstanceGroup
47290       consumes:
47291         - application/json
47292         - application/xml
47293       produces:
47294         - application/json
47295         - application/xml
47296       responses:
47297         "default":
47298           description: Response codes found in [response codes](https://wiki.onap.org/).
47299       parameters:
47300         - name: id
47301           in: path
47302           description: Instance Group ID, UUID assigned to this instance.
47303           required: true
47304           type: string
47305           example: __ID__
47306         - name: body
47307           in: body
47308           description: instance-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkInstanceGroupsInstanceGroup.json)
47309           required: true
47310           schema:
47311             $ref: "#/definitions/instance-group"
47312     patch:
47313       tags:
47314         - Network
47315       summary: update an existing instance-group
47316       description: |
47317         Update an existing instance-group
47318         #
47319         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
47320         The PUT operation will entirely replace an existing object.
47321         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
47322         #
47323         Other differences between PUT and PATCH are:
47324         #
47325         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
47326         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
47327         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
47328       operationId: UpdateNetworkInstanceGroupsInstanceGroup
47329       consumes:
47330         - application/json
47331         - application/xml
47332       produces:
47333         - application/json
47334         - application/xml
47335       responses:
47336         "default":
47337           description: Response codes found in [response codes](https://wiki.onap.org/).
47338       parameters:
47339         - name: id
47340           in: path
47341           description: Instance Group ID, UUID assigned to this instance.
47342           required: true
47343           type: string
47344           example: __ID__
47345         - name: body
47346           in: body
47347           description: instance-group object that needs to be created or updated.
47348           required: true
47349           schema:
47350             $ref: "#/patchDefinitions/instance-group"
47351     delete:
47352       tags:
47353         - Network
47354       summary: delete an existing instance-group
47355       description: delete an existing instance-group
47356       operationId: deleteNetworkInstanceGroupsInstanceGroup
47357       consumes:
47358         - application/json
47359         - application/xml
47360       produces:
47361         - application/json
47362         - application/xml
47363       responses:
47364         "default":
47365           description: Response codes found in [response codes](https://wiki.onap.org/).
47366       parameters:
47367         - name: id
47368           in: path
47369           description: Instance Group ID, UUID assigned to this instance.
47370           required: true
47371           type: string
47372           example: __ID__
47373         - name: resource-version
47374           in: query
47375           description: resource-version for concurrency
47376           required: true
47377           type: string
47378   /network/instance-groups:
47379     get:
47380       tags:
47381         - Network
47382       summary: returns instance-groups
47383       description: returns instance-groups
47384       operationId: getNetworkInstanceGroups
47385       produces:
47386         - application/json
47387         - application/xml
47388       responses:
47389         "200":
47390           description: successful operation
47391           schema:
47392               $ref: "#/getDefinitions/instance-groups"
47393         "default":
47394           description: Response codes found in [response codes](https://wiki.onap.org/).
47395   /network/zones/zone/{zone-id}/relationship-list/relationship:
47396     put:
47397       tags:
47398         - Network
47399       summary: see node definition for valid relationships
47400       operationId: createOrUpdateNetworkZonesZoneRelationshipListRelationship
47401       consumes:
47402         - application/json
47403         - application/xml
47404       produces:
47405         - application/json
47406         - application/xml
47407       responses:
47408         "default":
47409           description: Response codes found in [response codes](https://wiki.onap.org/).
47410       parameters:
47411         - name: zone-id
47412           in: path
47413           description: Code assigned by AIC to the zone
47414           required: true
47415           type: string
47416           example: __ZONE-ID__
47417         - name: body
47418           in: body
47419           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkZonesZone.json)
47420           required: true
47421           schema:
47422             $ref: "#/definitions/relationship"
47423     delete:
47424       tags:
47425         - Network
47426       summary: delete an existing relationship
47427       description: delete an existing relationship
47428       operationId: deleteNetworkZonesZoneRelationshipListRelationship
47429       consumes:
47430         - application/json
47431         - application/xml
47432       produces:
47433         - application/json
47434         - application/xml
47435       responses:
47436         "default":
47437           description: Response codes found in [response codes](https://wiki.onap.org/).
47438       parameters:
47439         - name: zone-id
47440           in: path
47441           description: Code assigned by AIC to the zone
47442           required: true
47443           type: string
47444           example: __ZONE-ID__
47445   /network/zones/zone/{zone-id}:
47446     get:
47447       tags:
47448         - Network
47449       summary: returns zone
47450       description: returns zone
47451       operationId: getNetworkZonesZone
47452       produces:
47453         - application/json
47454         - application/xml
47455       responses:
47456         "200":
47457           description: successful operation
47458           schema:
47459               $ref: "#/getDefinitions/zone"
47460         "default":
47461           description: Response codes found in [response codes](https://wiki.onap.org/).
47462       parameters:
47463         - name: zone-id
47464           in: path
47465           description: Code assigned by AIC to the zone
47466           required: true
47467           type: string
47468           example: __ZONE-ID__
47469         - name: design-type
47470           in: query
47471           description: Design of zone [Medium/Large?]
47472           required: false
47473           type: string
47474         - name: zone-context
47475           in: query
47476           description: Context of zone [production/test]
47477           required: false
47478           type: string
47479     put:
47480       tags:
47481         - Network
47482       summary: create or update an existing zone
47483       description: |
47484         Create or update an existing zone.
47485         #
47486         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
47487       operationId: createOrUpdateNetworkZonesZone
47488       consumes:
47489         - application/json
47490         - application/xml
47491       produces:
47492         - application/json
47493         - application/xml
47494       responses:
47495         "default":
47496           description: Response codes found in [response codes](https://wiki.onap.org/).
47497       parameters:
47498         - name: zone-id
47499           in: path
47500           description: Code assigned by AIC to the zone
47501           required: true
47502           type: string
47503           example: __ZONE-ID__
47504         - name: body
47505           in: body
47506           description: zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkZonesZone.json)
47507           required: true
47508           schema:
47509             $ref: "#/definitions/zone"
47510     patch:
47511       tags:
47512         - Network
47513       summary: update an existing zone
47514       description: |
47515         Update an existing zone
47516         #
47517         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
47518         The PUT operation will entirely replace an existing object.
47519         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
47520         #
47521         Other differences between PUT and PATCH are:
47522         #
47523         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
47524         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
47525         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
47526       operationId: UpdateNetworkZonesZone
47527       consumes:
47528         - application/json
47529         - application/xml
47530       produces:
47531         - application/json
47532         - application/xml
47533       responses:
47534         "default":
47535           description: Response codes found in [response codes](https://wiki.onap.org/).
47536       parameters:
47537         - name: zone-id
47538           in: path
47539           description: Code assigned by AIC to the zone
47540           required: true
47541           type: string
47542           example: __ZONE-ID__
47543         - name: body
47544           in: body
47545           description: zone object that needs to be created or updated.
47546           required: true
47547           schema:
47548             $ref: "#/patchDefinitions/zone"
47549     delete:
47550       tags:
47551         - Network
47552       summary: delete an existing zone
47553       description: delete an existing zone
47554       operationId: deleteNetworkZonesZone
47555       consumes:
47556         - application/json
47557         - application/xml
47558       produces:
47559         - application/json
47560         - application/xml
47561       responses:
47562         "default":
47563           description: Response codes found in [response codes](https://wiki.onap.org/).
47564       parameters:
47565         - name: zone-id
47566           in: path
47567           description: Code assigned by AIC to the zone
47568           required: true
47569           type: string
47570           example: __ZONE-ID__
47571         - name: resource-version
47572           in: query
47573           description: resource-version for concurrency
47574           required: true
47575           type: string
47576   /network/zones:
47577     get:
47578       tags:
47579         - Network
47580       summary: returns zones
47581       description: returns zones
47582       operationId: getNetworkZones
47583       produces:
47584         - application/json
47585         - application/xml
47586       responses:
47587         "200":
47588           description: successful operation
47589           schema:
47590               $ref: "#/getDefinitions/zones"
47591         "default":
47592           description: Response codes found in [response codes](https://wiki.onap.org/).
47593 definitions:
47594   aai-internal:
47595     properties:
47596       property-name:
47597         type: string
47598       property-value:
47599         type: string
47600   action:
47601     properties:
47602       action-type:
47603         type: string
47604       action-data:
47605         type: array
47606         items:
47607           $ref: "#/definitions/action-data"
47608   action-data:
47609     properties:
47610       property-name:
47611         type: string
47612       property-value:
47613         type: string
47614   actions:
47615     description: |
47616       APIs that are more action related than REST (e.g., notify, update).
47617     properties:
47618       update:
47619         type: object
47620         $ref: "#/definitions/update"
47621       notify:
47622         type: object
47623         $ref: "#/definitions/notify"
47624   allotted-resource:
47625     description: |
47626       Represents a slice or partial piece of a resource that gets separately allotted
47627       ###### Related Nodes
47628       - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
47629       - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
47630       - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
47631       - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
47632       - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
47633       - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
47634       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
47635       - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT
47636     required:
47637     - id
47638     properties:
47639       id:
47640         type: string
47641         description: Allotted Resource id UUID assigned to this instance.
47642       description:
47643         type: string
47644         description: The descriptive information assigned to this allotted resource instance
47645       selflink:
47646         type: string
47647         description: Link back to more information in the controller
47648       persona-model-id:
47649         type: string
47650         description: the ASDC model id for this resource or service model.
47651       persona-model-version:
47652         type: string
47653         description: the ASDC model version for this resource or service model.
47654       model-version-id:
47655         type: string
47656         description: the ASDC model version for this resource or service model.
47657       persona-model-customization-id:
47658         type: string
47659         description: captures the id of all the configuration used to customize the resource for the service.
47660       resource-version:
47661         type: string
47662         description: Concurrency value
47663       tunnel-xconnects:
47664         type: array
47665         items:
47666           $ref: "#/definitions/tunnel-xconnect"
47667       relationship-list:
47668         type: array
47669         items:
47670           $ref: "#/definitions/relationship"
47671   allotted-resources:
47672     description: |
47673       This object is used to store slices of services being offered
47674     properties:
47675       allotted-resource:
47676         type: array
47677         items:
47678           $ref: "#/definitions/allotted-resource"
47679   availability-zone:
47680     description: |
47681       Availability zone, a collection of compute hosts/pservers
47682       ###### Related Nodes
47683       - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
47684       - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
47685       - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
47686       - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
47687       - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
47688       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
47689       - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
47690       - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
47691       - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
47692     required:
47693     - availability-zone-name
47694     - hypervisor-type
47695     properties:
47696       availability-zone-name:
47697         type: string
47698         description: Name of the availability zone.  Unique across a cloud region
47699       hypervisor-type:
47700         type: string
47701         description: Type of hypervisor.  Source of truth should define valid values.
47702       operational-state:
47703         type: string
47704         description: State that indicates whether the availability zone should be used, etc.  Source of truth should define valid values.
47705       resource-version:
47706         type: string
47707         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47708       relationship-list:
47709         type: array
47710         items:
47711           $ref: "#/definitions/relationship"
47712   availability-zones:
47713     description: |
47714       Collection of availability zones
47715     properties:
47716       availability-zone:
47717         type: array
47718         items:
47719           $ref: "#/definitions/availability-zone"
47720   az-and-dvs-switches:
47721     properties:
47722       dvs-switches:
47723         type: object
47724         $ref: "#/definitions/dvs-switches"
47725       availability-zone:
47726         type: object
47727         $ref: "#/definitions/availability-zone"
47728   business:
47729     description: |
47730       Namespace for business related constructs
47731     properties:
47732       connectors:
47733         type: array
47734         items:
47735           $ref: "#/definitions/connector"
47736       customers:
47737         type: array
47738         items:
47739           $ref: "#/definitions/customer"
47740   class-of-service:
47741     description: |
47742       ###### Related Nodes
47743       - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
47744     required:
47745     - cos
47746     properties:
47747       cos:
47748         type: string
47749         description: unique identifier of probe
47750       probe-id:
47751         type: string
47752         description: identifier of probe
47753       probe-type:
47754         type: string
47755         description: type of probe
47756       resource-version:
47757         type: string
47758         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47759       relationship-list:
47760         type: array
47761         items:
47762           $ref: "#/definitions/relationship"
47763   classes-of-service:
47764     description: |
47765       class-of-service of probe
47766     properties:
47767       class-of-service:
47768         type: array
47769         items:
47770           $ref: "#/definitions/class-of-service"
47771   cloud-infrastructure:
47772     description: |
47773       Namespace for cloud infrastructure.
47774     properties:
47775       complexes:
47776         type: array
47777         items:
47778           $ref: "#/definitions/complex"
47779       cloud-regions:
47780         type: array
47781         items:
47782           $ref: "#/definitions/cloud-region"
47783       network-profiles:
47784         type: array
47785         items:
47786           $ref: "#/definitions/network-profile"
47787       pservers:
47788         type: array
47789         items:
47790           $ref: "#/definitions/pserver"
47791       virtual-data-centers:
47792         type: array
47793         items:
47794           $ref: "#/definitions/virtual-data-center"
47795   cloud-region:
47796     description: |
47797       cloud-region designates an installation of a cloud cluster or region or instantiation.
47798       ###### Related Nodes
47799       - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
47800       - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
47801       - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
47802       - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
47803       - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
47804       - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
47805       - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
47806       - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
47807       - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
47808       - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
47809       - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
47810       - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
47811       - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
47812       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
47813       - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP
47814       - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
47815     required:
47816     - cloud-owner
47817     - cloud-region-id
47818     properties:
47819       cloud-owner:
47820         type: string
47821         description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
47822       cloud-region-id:
47823         type: string
47824         description: Identifier used by the vendor for the region. Second part of composite key
47825       cloud-type:
47826         type: string
47827         description: Type of the cloud (e.g., openstack)
47828       owner-defined-type:
47829         type: string
47830         description: Cloud-owner defined type indicator (e.g., dcp, lcp)
47831       cloud-region-version:
47832         type: string
47833         description: Software version employed at the site.  NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
47834       identity-url:
47835         type: string
47836         description: URL of the keystone identity service
47837       cloud-zone:
47838         type: string
47839         description: Zone where the cloud is homed.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
47840       complex-name:
47841         type: string
47842         description: complex name for cloud-region instance.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
47843       resource-version:
47844         type: string
47845         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47846       volume-groups:
47847         type: array
47848         items:
47849           $ref: "#/definitions/volume-group"
47850       tenants:
47851         type: array
47852         items:
47853           $ref: "#/definitions/tenant"
47854       flavors:
47855         type: array
47856         items:
47857           $ref: "#/definitions/flavor"
47858       group-assignments:
47859         type: array
47860         items:
47861           $ref: "#/definitions/group-assignment"
47862       snapshots:
47863         type: array
47864         items:
47865           $ref: "#/definitions/snapshot"
47866       images:
47867         type: array
47868         items:
47869           $ref: "#/definitions/image"
47870       dvs-switches:
47871         type: array
47872         items:
47873           $ref: "#/definitions/dvs-switch"
47874       oam-networks:
47875         type: array
47876         items:
47877           $ref: "#/definitions/oam-network"
47878       availability-zones:
47879         type: array
47880         items:
47881           $ref: "#/definitions/availability-zone"
47882       relationship-list:
47883         type: array
47884         items:
47885           $ref: "#/definitions/relationship"
47886   cloud-regions:
47887     properties:
47888       cloud-region:
47889         type: array
47890         items:
47891           $ref: "#/definitions/cloud-region"
47892   complex:
47893     description: |
47894       Collection of physical locations that can house cloud-regions.
47895       ###### Related Nodes
47896       - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
47897       - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
47898       - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
47899       - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
47900       - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
47901       - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
47902       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
47903       - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
47904       - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
47905       - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
47906       - FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
47907       - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
47908       - COMPLEX is DELETED when these are DELETED CTAG-POOL
47909     required:
47910     - physical-location-id
47911     - physical-location-type
47912     - street1
47913     - city
47914     - postal-code
47915     - country
47916     - region
47917     properties:
47918       physical-location-id:
47919         type: string
47920         description: Unique identifier for physical location, e.g., CLLI
47921       data-center-code:
47922         type: string
47923         description: Data center code which can be an alternate way to identify a complex
47924       complex-name:
47925         type: string
47926         description: Gamma complex name for LCP instance.
47927       identity-url:
47928         type: string
47929         description: URL of the keystone identity service
47930       resource-version:
47931         type: string
47932         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47933       physical-location-type:
47934         type: string
47935         description: Type, e.g., central office, data center.
47936       street1:
47937         type: string
47938       street2:
47939         type: string
47940       city:
47941         type: string
47942       state:
47943         type: string
47944       postal-code:
47945         type: string
47946       country:
47947         type: string
47948       region:
47949         type: string
47950       latitude:
47951         type: string
47952       longitude:
47953         type: string
47954       elevation:
47955         type: string
47956       lata:
47957         type: string
47958       ctag-pools:
47959         type: array
47960         items:
47961           $ref: "#/definitions/ctag-pool"
47962       relationship-list:
47963         type: array
47964         items:
47965           $ref: "#/definitions/relationship"
47966   complexes:
47967     description: |
47968       Collection of physical locations that can house cloud-regions.
47969     properties:
47970       complex:
47971         type: array
47972         items:
47973           $ref: "#/definitions/complex"
47974   configuration:
47975     description: |
47976       Port Mirror Configuration.
47977       ###### Related Nodes
47978       - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
47979       - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
47980       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
47981       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
47982       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
47983       - CONFIGURATION is DELETED when these are DELETED METADATUM
47984       - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
47985     required:
47986     - configuration-id
47987     - configuration-type
47988     - configuration-sub-type
47989     - orchestration-status
47990     - operational-status
47991     - configuration-selflink
47992     - model-customization-id
47993     properties:
47994       configuration-id:
47995         type: string
47996         description: UUID assigned to configuration.
47997       management-option:
47998         type: string
47999         description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
48000       configuration-name:
48001         type: string
48002         description: Name of the configuration.
48003       configuration-type:
48004         type: string
48005         description: port-mirroring-configuration.
48006       configuration-sub-type:
48007         type: string
48008         description: vprobe, pprobe.
48009       model-invariant-id:
48010         type: string
48011         description: the ASDC model id for this resource or service model.
48012       model-version-id:
48013         type: string
48014         description: the ASDC model version for this resource or service model.
48015       orchestration-status:
48016         type: string
48017         description: Orchestration status of the configuration.
48018       operational-status:
48019         type: string
48020         description: Indicator for whether the resource is considered operational.
48021       configuration-selflink:
48022         type: string
48023         description: URL to endpoint where AAI can get more details from SDN-GC.
48024       model-customization-id:
48025         type: string
48026         description: id of  the configuration used to customize the resource
48027       resource-version:
48028         type: string
48029         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48030       relationship-list:
48031         type: array
48032         items:
48033           $ref: "#/definitions/relationship"
48034       metadata:
48035         type: array
48036         items:
48037           $ref: "#/definitions/metadatum"
48038   configurations:
48039     description: |
48040       Collection of configurations
48041     properties:
48042       configuration:
48043         type: array
48044         items:
48045           $ref: "#/definitions/configuration"
48046   connector:
48047     description: |
48048       Collection of resource instances used to connect a variety of disparate inventory widgets
48049       ###### Related Nodes
48050       - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
48051       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
48052       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
48053       - CONNECTOR is DELETED when these are DELETED METADATUM
48054     required:
48055     - resource-instance-id
48056     properties:
48057       resource-instance-id:
48058         type: string
48059         description: Unique id of resource instance.
48060       resource-version:
48061         type: string
48062         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48063       persona-model-id:
48064         type: string
48065         description: the ASDC model id for this resource or service model.
48066       persona-model-version:
48067         type: string
48068         description: the ASDC model version for this resource or service model.
48069       model-version-id:
48070         type: string
48071         description: the ASDC model version for this resource or service model.
48072       widget-model-id:
48073         type: string
48074         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
48075       widget-model-version:
48076         type: string
48077         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
48078       relationship-list:
48079         type: array
48080         items:
48081           $ref: "#/definitions/relationship"
48082       metadata:
48083         type: array
48084         items:
48085           $ref: "#/definitions/metadatum"
48086   connectors:
48087     description: |
48088       Collection of resource instances used to connect a variety of disparate inventory widgets
48089     properties:
48090       connector:
48091         type: array
48092         items:
48093           $ref: "#/definitions/connector"
48094   constrained-element-set:
48095     description: |
48096       This is how we would capture constraints defining allowed sets of elements.
48097       ###### Related Nodes
48098       - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
48099       - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
48100       - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
48101       - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET
48102     required:
48103     - constrained-element-set-uuid
48104     - constraint-type
48105     - check-type
48106     properties:
48107       constrained-element-set-uuid:
48108         type: string
48109       constraint-type:
48110         type: string
48111       check-type:
48112         type: string
48113       resource-version:
48114         type: string
48115       element-choice-sets:
48116         type: array
48117         items:
48118           $ref: "#/definitions/element-choice-set"
48119       relationship-list:
48120         type: array
48121         items:
48122           $ref: "#/definitions/relationship"
48123   constrained-element-sets:
48124     properties:
48125       constrained-element-set:
48126         type: array
48127         items:
48128           $ref: "#/definitions/constrained-element-set"
48129   ctag-assignment:
48130     description: |
48131       ###### Related Nodes
48132       - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
48133       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
48134     required:
48135     - vlan-id-inner
48136     properties:
48137       vlan-id-inner:
48138         type: integer
48139         format: int64
48140         description: id.
48141       resource-version:
48142         type: string
48143         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48144       relationship-list:
48145         type: array
48146         items:
48147           $ref: "#/definitions/relationship"
48148   ctag-assignments:
48149     properties:
48150       ctag-assignment:
48151         type: array
48152         items:
48153           $ref: "#/definitions/ctag-assignment"
48154   ctag-pool:
48155     description: |
48156       A collection of C tags (vlan tags) grouped for a specific purpose.
48157       ###### Related Nodes
48158       - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
48159       - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
48160       - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
48161     required:
48162     - target-pe
48163     - availability-zone-name
48164     - ctag-pool-purpose
48165     properties:
48166       target-pe:
48167         type: string
48168         description: The Target provider edge router
48169       availability-zone-name:
48170         type: string
48171         description: Name of the availability zone
48172       ctag-pool-purpose:
48173         type: string
48174         description: Describes what the intended purpose of this pool is.
48175       ctag-values:
48176         type: string
48177         description: Comma separated list of ctags
48178       resource-version:
48179         type: string
48180         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48181       relationship-list:
48182         type: array
48183         items:
48184           $ref: "#/definitions/relationship"
48185   ctag-pools:
48186     properties:
48187       ctag-pool:
48188         type: array
48189         items:
48190           $ref: "#/definitions/ctag-pool"
48191   customer:
48192     description: |
48193       customer identifiers to provide linkage back to BSS information.
48194       ###### Related Nodes
48195       - FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
48196       - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION
48197     required:
48198     - global-customer-id
48199     - subscriber-name
48200     - subscriber-type
48201     properties:
48202       global-customer-id:
48203         type: string
48204         description: Global customer id used across ECOMP to uniquely identify customer.
48205       subscriber-name:
48206         type: string
48207         description: Subscriber name, an alternate way to retrieve a customer.
48208       subscriber-type:
48209         type: string
48210         description: Subscriber type, a way to provide VID with only the INFRA customers.
48211       resource-version:
48212         type: string
48213         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48214       service-subscriptions:
48215         type: array
48216         items:
48217           $ref: "#/definitions/service-subscription"
48218       relationship-list:
48219         type: array
48220         items:
48221           $ref: "#/definitions/relationship"
48222   customers:
48223     description: |
48224       Collection of customer identifiers to provide linkage back to BSS information.
48225     properties:
48226       customer:
48227         type: array
48228         items:
48229           $ref: "#/definitions/customer"
48230   cvlan-tag-entry:
48231     required:
48232     - cvlan-tag
48233     properties:
48234       cvlan-tag:
48235         type: integer
48236         format: int64
48237         description: See mis-na-virtualization-platform.yang
48238       resource-version:
48239         type: string
48240         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48241       relationship-list:
48242         type: array
48243         items:
48244           $ref: "#/definitions/relationship"
48245   cvlan-tags:
48246     properties:
48247       cvlan-tag-entry:
48248         type: array
48249         items:
48250           $ref: "#/definitions/cvlan-tag-entry"
48251   dvs-switch:
48252     description: |
48253       Digital virtual switch metadata, used by SDN-C to configure VCEs.  A&AI needs to receive this data from the PO deployment team and administer it using the provisioningTool.sh into A&AI.
48254       ###### Related Nodes
48255       - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48256       - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
48257     required:
48258     - switch-name
48259     - vcenter-url
48260     properties:
48261       switch-name:
48262         type: string
48263         description: DVS switch name
48264       vcenter-url:
48265         type: string
48266         description: URL used to reach the vcenter
48267       resource-version:
48268         type: string
48269         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48270       relationship-list:
48271         type: array
48272         items:
48273           $ref: "#/definitions/relationship"
48274   dvs-switches:
48275     description: |
48276       Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
48277     properties:
48278       dvs-switch:
48279         type: array
48280         items:
48281           $ref: "#/definitions/dvs-switch"
48282   edge-prop-names:
48283     description: |
48284       Internal map to define the properties of an edge and interpret the map EdgeRules
48285     properties:
48286       edgeLabel:
48287         type: string
48288       direction:
48289         type: string
48290       multiplicityRule:
48291         type: string
48292       isParent:
48293         type: boolean
48294       usesResource:
48295         type: boolean
48296       hasDelTarget:
48297         type: boolean
48298       SVC-INFRA:
48299         type: boolean
48300       SVC-INFRA-REV:
48301         type: boolean
48302   edge-tag-query-request:
48303     properties:
48304       edge-tag:
48305         type: string
48306       result-detail:
48307         type: string
48308       start-node-type:
48309         type: string
48310       start-node-filter:
48311         type: array
48312         items:
48313           $ref: "#/definitions/start-node-filter"
48314       include-node-filter:
48315         type: array
48316         items:
48317           $ref: "#/definitions/include-node-filter"
48318       secondary-filter:
48319         type: array
48320         items:
48321           $ref: "#/definitions/secondary-filter"
48322   edge-tag-query-result:
48323     properties:
48324       tagged-inventory-item-list:
48325         type: array
48326         items:
48327           $ref: "#/definitions/tagged-inventory-item-list"
48328   element-choice-set:
48329     description: |
48330       This is how we would capture constraints defining allowed sets of elements.
48331       ###### Related Nodes
48332       - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
48333       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
48334       - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT
48335     required:
48336     - element-choice-set-uuid
48337     - element-choice-set-name
48338     properties:
48339       element-choice-set-uuid:
48340         type: string
48341       element-choice-set-name:
48342         type: string
48343       cardinality:
48344         type: string
48345       resource-version:
48346         type: string
48347       model-elements:
48348         type: array
48349         items:
48350           $ref: "#/definitions/model-element"
48351       relationship-list:
48352         type: array
48353         items:
48354           $ref: "#/definitions/relationship"
48355   element-choice-sets:
48356     properties:
48357       element-choice-set:
48358         type: array
48359         items:
48360           $ref: "#/definitions/element-choice-set"
48361   entitlement:
48362     description: |
48363       Metadata for entitlement group.
48364       ###### Related Nodes
48365       - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
48366       - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
48367     required:
48368     - group-uuid
48369     - resource-uuid
48370     properties:
48371       group-uuid:
48372         type: string
48373         description: Unique ID for the entitlement group the resource comes from, should be uuid.
48374       resource-uuid:
48375         type: string
48376         description: Unique ID of an entitlement resource.
48377       resource-version:
48378         type: string
48379         description: Concurrency value
48380       relationship-list:
48381         type: array
48382         items:
48383           $ref: "#/definitions/relationship"
48384   entitlements:
48385     description: |
48386       Entitlements, keyed by group-uuid and resource-uuid, related to license management
48387     properties:
48388       entitlement:
48389         type: array
48390         items:
48391           $ref: "#/definitions/entitlement"
48392   esr-ems:
48393     description: |
48394       Persist EMS address information used by EMS driver.
48395       ###### Related Nodes
48396       - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)
48397       - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
48398     required:
48399     - ems-id
48400     properties:
48401       ems-id:
48402         type: string
48403         description: Unique ID of EMS.
48404       resource-version:
48405         type: string
48406         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48407       esr-system-info-list:
48408         type: object
48409         $ref: "#/definitions/esr-system-info-list"
48410       relationship-list:
48411         type: object
48412         $ref: "#/definitions/relationship-list"
48413   esr-ems-list:
48414     properties:
48415       esr-ems:
48416         type: array
48417         items:
48418           $ref: "#/definitions/esr-ems"
48419   esr-system-info:
48420     description: |
48421       Persist common address information of external systems.
48422       ###### Related Nodes
48423       - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)
48424       - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)
48425       - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)
48426       - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)
48427     required:
48428     - esr-system-info-id
48429     - user-name
48430     - password
48431     - system-type
48432     properties:
48433       esr-system-info-id:
48434         type: string
48435         description: Unique ID of esr system info.
48436       system-name:
48437         type: string
48438         description: name of external system.
48439       type:
48440         type: string
48441         description: type of external systems.
48442       vendor:
48443         type: string
48444         description: vendor of external systems.
48445       version:
48446         type: string
48447         description: version of external systems.
48448       service-url:
48449         type: string
48450         description: url used to access external systems.
48451       user-name:
48452         type: string
48453         description: username used to access external systems.
48454       password:
48455         type: string
48456         description: password used to access external systems.
48457       system-type:
48458         type: string
48459         description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
48460       protocol:
48461         type: string
48462         description: protocol of third party SDNC, for example netconf/snmp.
48463       ssl-cacert:
48464         type: string
48465         description: ca file content if enabled ssl on auth-url.
48466       ssl-insecure:
48467         type: boolean
48468         description: Whether to verify VIM's certificate.
48469       ip-address:
48470         type: string
48471         description: service IP of ftp server.
48472       port:
48473         type: string
48474         description: service port of ftp server.
48475       cloud-domain:
48476         type: string
48477         description: domain info for authentication.
48478       default-tenant:
48479         type: string
48480         description: default tenant of VIM.
48481       passive:
48482         type: boolean
48483         description: ftp passive mode or not.
48484       remote-path:
48485         type: string
48486         description: resource or performance data file path.
48487       system-status:
48488         type: string
48489         description: the status of external system.
48490       resource-version:
48491         type: string
48492         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48493       relationship-list:
48494         type: array
48495         items:
48496           $ref: "#/definitions/relationship"
48497   esr-system-info-list:
48498     description: |
48499       Collection of persistent block-level external system auth info.
48500     properties:
48501       esr-system-info:
48502         type: array
48503         items:
48504           $ref: "#/definitions/esr-system-info"
48505   esr-thirdparty-sdnc:
48506     description: |
48507       Persist SDNC address information used by ONAP SDNC.
48508       ###### Related Nodes
48509       - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)
48510       - TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
48511       - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
48512     required:
48513     - thirdparty-sdnc-id
48514     properties:
48515       thirdparty-sdnc-id:
48516         type: string
48517         description: Unique ID of SDNC.
48518       location:
48519         type: string
48520         description: used for DC type to indicate the location of SDNC, such as Core or Edge.
48521       product-name:
48522         type: string
48523         description: password used to access SDNC server.
48524       resource-version:
48525         type: string
48526         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48527       esr-system-info-list:
48528         type: object
48529         $ref: "#/definitions/esr-system-info-list"
48530       relationship-list:
48531         type: object
48532         $ref: "#/definitions/relationship-list"
48533   esr-thirdparty-sdnc-list:
48534     properties:
48535       esr-thirdparty-sdnc:
48536         type: array
48537         items:
48538           $ref: "#/definitions/esr-thirdparty-sdnc"
48539   esr-vnfm:
48540     description: |
48541       Persist VNFM address information used by VF-C.
48542       ###### Related Nodes
48543       - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)
48544       - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
48545     required:
48546     - vnfm-id
48547     properties:
48548       vnfm-id:
48549         type: string
48550         description: Unique ID of VNFM.
48551       vim-id:
48552         type: string
48553         description: indecate the VIM to deploy VNF.
48554       certificate-url:
48555         type: string
48556         description: certificate url of VNFM.
48557       resource-version:
48558         type: string
48559         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48560       esr-system-info-list:
48561         type: object
48562         $ref: "#/definitions/esr-system-info-list"
48563       relationship-list:
48564         type: object
48565         $ref: "#/definitions/relationship-list"
48566   esr-vnfm-list:
48567     properties:
48568       esr-vnfm:
48569         type: array
48570         items:
48571           $ref: "#/definitions/esr-vnfm"
48572   evc:
48573     description: |
48574       evc object is an optional child object of the Configuration object.
48575       ###### Related Nodes
48576       - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
48577     required:
48578     - evc-id
48579     properties:
48580       evc-id:
48581         type: string
48582         description: Unique/key field for the evc object
48583       forwarding-path-topology:
48584         type: string
48585         description: Point-to-Point, Multi-Point
48586       cir-value:
48587         type: string
48588         description: Commited Information Rate
48589       cir-units:
48590         type: string
48591         description: CIR units
48592       connection-diversity-group-id:
48593         type: string
48594         description: Diversity Group ID
48595       service-hours:
48596         type: string
48597         description: formerly Performance Group
48598       esp-evc-circuit-id:
48599         type: string
48600         description: EVC Circuit ID of ESP EVC
48601       esp-evc-cir-value:
48602         type: string
48603         description: Committed Information Rate (For ESP)
48604       esp-evc-cir-units:
48605         type: string
48606         description: CIR units (For ESP)
48607       esp-itu-code:
48608         type: string
48609         description: Identifies ESP
48610       collector-pop-clli:
48611         type: string
48612         description: Collector POP CLLI (from the hostname of the access pnf)
48613       inter-connect-type-ingress:
48614         type: string
48615         description: Interconnect type on ingress side of EVC.
48616       tagmode-access-ingress:
48617         type: string
48618         description: tagode for collector side of EVC
48619       tagmode-access-egress:
48620         type: string
48621         description: tagMode for network side of EVC
48622       relationship-list:
48623         type: array
48624         items:
48625           $ref: "#/definitions/relationship"
48626       resource-version:
48627         type: string
48628         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48629   evcs:
48630     properties:
48631       evc:
48632         type: array
48633         items:
48634           $ref: "#/definitions/evc"
48635   external-system:
48636     description: |
48637       Namespace for external system.
48638     properties:
48639       esr-ems-list:
48640         type: object
48641         $ref: "#/definitions/esr-ems-list"
48642       esr-vnfm-list:
48643         type: object
48644         $ref: "#/definitions/esr-vnfm-list"
48645       esr-thirdparty-sdnc-list:
48646         type: object
48647         $ref: "#/definitions/esr-thirdparty-sdnc-list"
48648   extra-properties:
48649     description: |
48650       Extra properties for inventory item for response list
48651   extra-property:
48652     properties:
48653       property-name:
48654         type: string
48655   flavor:
48656     description: |
48657       Openstack flavor.
48658       ###### Related Nodes
48659       - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48660       - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
48661       - FLAVOR cannot be deleted if linked to VSERVER
48662     required:
48663     - flavor-id
48664     - flavor-name
48665     - flavor-selflink
48666     properties:
48667       flavor-id:
48668         type: string
48669         description: Flavor id, expected to be unique across cloud-region.
48670       flavor-name:
48671         type: string
48672         description: Flavor name
48673       flavor-vcpus:
48674         type: integer
48675         format: int32
48676         description: Number of CPUs
48677       flavor-ram:
48678         type: integer
48679         format: int32
48680         description: Amount of memory
48681       flavor-disk:
48682         type: integer
48683         format: int32
48684         description: Disk space
48685       flavor-ephemeral:
48686         type: integer
48687         format: int32
48688         description: Amount of ephemeral disk space
48689       flavor-swap:
48690         type: string
48691         description: amount of swap space allocation
48692       flavor-is-public:
48693         type: boolean
48694         description: whether flavor is available to all users or private to the tenant it was created in.
48695       flavor-selflink:
48696         type: string
48697         description: URL to endpoint where AAI can get more details
48698       flavor-disabled:
48699         type: boolean
48700         description: Boolean as to whether this flavor is no longer enabled
48701       resource-version:
48702         type: string
48703         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48704       relationship-list:
48705         type: array
48706         items:
48707           $ref: "#/definitions/relationship"
48708   flavors:
48709     description: |
48710       Collection of openstack flavors.
48711     properties:
48712       flavor:
48713         type: array
48714         items:
48715           $ref: "#/definitions/flavor"
48716   forwarder:
48717     description: |
48718       Entity describing a sequenced segment of forwarding path
48719       ###### Related Nodes
48720       - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
48721       - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
48722       - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
48723       - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
48724       - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
48725       - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION
48726     required:
48727     - sequence
48728     properties:
48729       sequence:
48730         type: integer
48731         format: int32
48732         description: Unique ID of this segmentation
48733       forwarder-role:
48734         type: string
48735         description: ingress, intermediate, egress
48736       relationship-list:
48737         type: array
48738         items:
48739           $ref: "#/definitions/relationship"
48740       resource-version:
48741         type: string
48742         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48743   forwarder-evc:
48744     description: |
48745       forwarder object is an optional child object of the Configuration object.
48746       ###### Related Nodes
48747       - TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
48748     required:
48749     - forwarder-evc-id
48750     properties:
48751       forwarder-evc-id:
48752         type: string
48753         description: Key for forwarder-evc object
48754       circuit-id:
48755         type: string
48756         description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
48757       ivlan:
48758         type: string
48759         description: Internal VLAN.
48760       svlan:
48761         type: string
48762         description: SVLAN value for ingress of egress forwarder.
48763       cvlan:
48764         type: string
48765         description: CVLAN value for ingress of egress forwarder.
48766       relationship-list:
48767         type: array
48768         items:
48769           $ref: "#/definitions/relationship"
48770       resource-version:
48771         type: string
48772         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48773   forwarder-evcs:
48774     properties:
48775       forwarder-evc:
48776         type: array
48777         items:
48778           $ref: "#/definitions/forwarder-evc"
48779   forwarders:
48780     properties:
48781       forwarder:
48782         type: array
48783         items:
48784           $ref: "#/definitions/forwarder"
48785   forwarding-path:
48786     description: |
48787       Entity that describes the sequenced forwarding path between interfaces of services or resources
48788       ###### Related Nodes
48789       - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
48790       - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
48791       - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
48792       - FORWARDING-PATH is DELETED when these are DELETED FORWARDER
48793       - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION
48794     required:
48795     - forwarding-path-id
48796     - forwarding-path-name
48797     properties:
48798       forwarding-path-id:
48799         type: string
48800         description: Unique ID of this FP
48801       forwarding-path-name:
48802         type: string
48803         description: Name of the FP
48804       relationship-list:
48805         type: array
48806         items:
48807           $ref: "#/definitions/relationship"
48808       resource-version:
48809         type: string
48810         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48811       selflink:
48812         type: string
48813         description: the self link for this FP
48814       forwarders:
48815         type: array
48816         items:
48817           $ref: "#/definitions/forwarder"
48818   forwarding-paths:
48819     properties:
48820       forwarding-path:
48821         type: array
48822         items:
48823           $ref: "#/definitions/forwarding-path"
48824   generic-vnf:
48825     description: |
48826       General purpose VNF
48827       ###### Related Nodes
48828       - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
48829       - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
48830       - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
48831       - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
48832       - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY)
48833       - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
48834       - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
48835       - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
48836       - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
48837       - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
48838       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
48839       - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
48840       - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
48841       - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
48842       - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
48843       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
48844       - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
48845       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
48846       - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
48847       - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
48848       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
48849       - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE
48850     required:
48851     - vnf-id
48852     - vnf-name
48853     - vnf-type
48854     - in-maint
48855     - is-closed-loop-disabled
48856     properties:
48857       vnf-id:
48858         type: string
48859         description: Unique id of VNF.  This is unique across the graph.
48860       vnf-name:
48861         type: string
48862         description: Name of VNF.
48863       vnf-name2:
48864         type: string
48865         description: Alternate name of VNF.
48866       vnf-type:
48867         type: string
48868         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
48869       service-id:
48870         type: string
48871         description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
48872       regional-resource-zone:
48873         type: string
48874         description: Regional way of organizing pservers, source of truth should define values
48875       prov-status:
48876         type: string
48877         description: Trigger for operational monitoring of this resource by Service Assurance systems.
48878       operational-state:
48879         type: string
48880         description: Indicator for whether the resource is considered operational.  Valid values are in-service-path and out-of-service-path.
48881       license-key:
48882         type: string
48883         description: OBSOLETE -  do not use
48884       equipment-role:
48885         type: string
48886         description: Client should send valid enumerated value
48887       orchestration-status:
48888         type: string
48889         description: Orchestration status of this VNF, used by MSO.
48890       heat-stack-id:
48891         type: string
48892         description: Heat stack id corresponding to this instance, managed by MSO
48893       mso-catalog-key:
48894         type: string
48895         description: Corresponds to the SDN-C catalog id used to configure this VCE
48896       management-option:
48897         type: string
48898         description: identifier of managed by company or customer
48899       ipv4-oam-address:
48900         type: string
48901         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
48902       ipv4-loopback0-address:
48903         type: string
48904         description: v4 Loopback0 address
48905       nm-lan-v6-address:
48906         type: string
48907         description: v6 Loopback address
48908       management-v6-address:
48909         type: string
48910         description: v6 management address
48911       vcpu:
48912         type: integer
48913         format: int64
48914         description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
48915       vcpu-units:
48916         type: string
48917         description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only in some usecases
48918       vmemory:
48919         type: integer
48920         format: int64
48921         description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
48922       vmemory-units:
48923         type: string
48924         description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only in some usecases
48925       vdisk:
48926         type: integer
48927         format: int64
48928         description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
48929       vdisk-units:
48930         type: string
48931         description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only in some usecases
48932       in-maint:
48933         type: boolean
48934       is-closed-loop-disabled:
48935         type: boolean
48936       resource-version:
48937         type: string
48938         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48939       summary-status:
48940         type: string
48941         description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.
48942       encrypted-access-flag:
48943         type: boolean
48944         description: indicates whether generic-vnf access uses SSH
48945       persona-model-id:
48946         type: string
48947         description: the ASDC model id for this resource or service model.
48948       persona-model-version:
48949         type: string
48950         description: the ASDC model version for this resource or service model.
48951       model-version-id:
48952         type: string
48953         description: the ASDC model version for this resource or service model.
48954       persona-model-customization-id:
48955         type: string
48956         description: captures the id of all the configuration used to customize the resource for the service.
48957       widget-model-id:
48958         type: string
48959         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
48960       widget-model-version:
48961         type: string
48962         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
48963       as-number:
48964         type: string
48965         description: as-number of the VNF
48966       regional-resource-subzone:
48967         type: string
48968         description: represents sub zone of the rr plane
48969       selflink:
48970         type: string
48971         description: Path to the controller object.
48972       relationship-list:
48973         type: array
48974         items:
48975           $ref: "#/definitions/relationship"
48976       l-interfaces:
48977         type: array
48978         items:
48979           $ref: "#/definitions/l-interface"
48980       lag-interfaces:
48981         type: array
48982         items:
48983           $ref: "#/definitions/lag-interface"
48984       vf-modules:
48985         type: array
48986         items:
48987           $ref: "#/definitions/vf-module"
48988       licenses:
48989         type: array
48990         items:
48991           $ref: "#/definitions/license"
48992       entitlements:
48993         type: array
48994         items:
48995           $ref: "#/definitions/entitlement"
48996   generic-vnfs:
48997     description: |
48998       Collection of VNFs
48999     properties:
49000       generic-vnf:
49001         type: array
49002         items:
49003           $ref: "#/definitions/generic-vnf"
49004   group-assignment:
49005     description: |
49006       Openstack group-assignment used to store exclusivity groups (EG).
49007       ###### Related Nodes
49008       - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
49009       - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
49010       - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
49011     required:
49012     - group-id
49013     - group-type
49014     - group-name
49015     properties:
49016       group-id:
49017         type: string
49018         description: Group id, expected to be unique across cloud-region.
49019       group-type:
49020         type: string
49021         description: Group type - the type of group this instance refers to
49022       group-name:
49023         type: string
49024         description: Group name - name assigned to the group
49025       group-description:
49026         type: string
49027         description: Group description - description of the group
49028       resource-version:
49029         type: string
49030         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49031       relationship-list:
49032         type: array
49033         items:
49034           $ref: "#/definitions/relationship"
49035   group-assignments:
49036     description: |
49037       Collection of openstack group assignments
49038     properties:
49039       group-assignment:
49040         type: array
49041         items:
49042           $ref: "#/definitions/group-assignment"
49043   host-route:
49044     description: |
49045       ###### Related Nodes
49046       - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
49047     required:
49048     - host-route-id
49049     - route-prefix
49050     - next-hop
49051     properties:
49052       host-route-id:
49053         type: string
49054         description: host-route id
49055       route-prefix:
49056         type: string
49057         description: subnet prefix
49058       next-hop:
49059         type: string
49060         description: Could be ip-address, hostname, or service-instance
49061       next-hop-type:
49062         type: string
49063         description: Should be ip-address, hostname, or service-instance to match next-hop
49064       resource-version:
49065         type: string
49066         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49067       relationship-list:
49068         type: array
49069         items:
49070           $ref: "#/definitions/relationship"
49071   host-routes:
49072     properties:
49073       host-route:
49074         type: array
49075         items:
49076           $ref: "#/definitions/host-route"
49077   hpa-capabilities:
49078     description: |
49079       Collection of HPA Capabilities
49080     properties:
49081       hpa-capability:
49082         type: array
49083         items:
49084           $ref: "#/definitions/hpa-capability"
49085   hpa-capability:
49086     description: |
49087       Represents a HPA capability
49088       ###### Related Nodes
49089       - TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE)
49090       - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
49091       - FROM hpa-feature-attributes( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE)
49092       - HPA-CAPABILITY is DELETED when these are DELETED HPA-FEATURE-ATTRIBUTES
49093     required:
49094     - hpa-capability-id
49095     - hpa-feature
49096     properties:
49097       hpa-capability-id:
49098         type: string
49099         description: UUID to uniquely identify a HPA capability
49100       hpa-feature:
49101         type: string
49102         description: Name of the HPACapability
49103       hpa-version:
49104         type: string
49105         description: HPA schema version
49106       hpa-hw-arch:
49107         type: string
49108         description: Hardware architecture
49109       resource-version:
49110         type: string
49111         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49112       relationship-list:
49113         type: array
49114         items:
49115           $ref: "#/definitions/relationship"
49116       hpa-feature-attributes:
49117         type: array
49118         items:
49119           $ref: "#/definitions/hpa-feature-attributes"
49120   hpa-feature-attributes:
49121     description: |
49122       HPA Capability Feature attributes
49123       ###### Related Nodes
49124       - TO hpa-capability( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE)
49125     properties:
49126       hpa-attr-key:
49127         type: string
49128         description: name of the specific HPA attribute
49129       hpa-attr-value:
49130         type: string
49131         description: JSON string specifying the value, unit and type of the specific HPA attribute
49132       resource-version:
49133         type: string
49134         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49135       relationship-list:
49136         type: array
49137         items:
49138           $ref: "#/definitions/relationship"
49139   image:
49140     description: |
49141       Openstack image.
49142       ###### Related Nodes
49143       - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
49144       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
49145       - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
49146       - IMAGE cannot be deleted if linked to VSERVER
49147       - IMAGE is DELETED when these are DELETED METADATUM
49148     required:
49149     - image-id
49150     - image-name
49151     - image-os-distro
49152     - image-os-version
49153     - image-selflink
49154     properties:
49155       image-id:
49156         type: string
49157         description: Image id, expected to be unique across cloud region
49158       image-name:
49159         type: string
49160         description: Image name
49161       image-architecture:
49162         type: string
49163         description: Operating system architecture.
49164       image-os-distro:
49165         type: string
49166         description: The common name of the operating system distribution in lowercase
49167       image-os-version:
49168         type: string
49169         description: The operating system version as specified by the distributor.
49170       application:
49171         type: string
49172         description: The application that the image instantiates.
49173       application-vendor:
49174         type: string
49175         description: The vendor of the application.
49176       application-version:
49177         type: string
49178         description: The version of the application.
49179       image-selflink:
49180         type: string
49181         description: URL to endpoint where AAI can get more details
49182       resource-version:
49183         type: string
49184         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49185       relationship-list:
49186         type: array
49187         items:
49188           $ref: "#/definitions/relationship"
49189       metadata:
49190         type: array
49191         items:
49192           $ref: "#/definitions/metadatum"
49193   images:
49194     description: |
49195       Collectio of Openstack images.
49196     properties:
49197       image:
49198         type: array
49199         items:
49200           $ref: "#/definitions/image"
49201   include-node-filter:
49202     properties:
49203       include-node-type:
49204         type: string
49205   instance-filter:
49206     description: |
49207       InstanceFilter for performing a named-query or model query
49208   instance-filters:
49209     description: |
49210       InstanceFilters for performing a named-query or model query
49211     properties:
49212       instance-filter:
49213         type: array
49214         items:
49215           $ref: "#/definitions/instance-filter"
49216   instance-group:
49217     description: |
49218       General mechanism for grouping instances
49219       ###### Related Nodes
49220       - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
49221       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
49222       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
49223       - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
49224       - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
49225     required:
49226     - id
49227     - description
49228     - type
49229     properties:
49230       id:
49231         type: string
49232         description: Instance Group ID, UUID assigned to this instance.
49233       description:
49234         type: string
49235         description: Descriptive text to help identify the usage of this instance-group
49236       type:
49237         type: string
49238         description: Only valid value today is lower case ha for high availability
49239       sub-type:
49240         type: string
49241         description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
49242       resource-version:
49243         type: string
49244         description: Concurrency value
49245       relationship-list:
49246         type: array
49247         items:
49248           $ref: "#/definitions/relationship"
49249   instance-groups:
49250     description: |
49251       Collection of openstack route table references
49252     properties:
49253       instance-group:
49254         type: array
49255         items:
49256           $ref: "#/definitions/instance-group"
49257   inventory:
49258     properties:
49259       search:
49260         type: object
49261         $ref: "#/definitions/search"
49262       actions:
49263         type: object
49264         $ref: "#/definitions/actions"
49265       cloud-infrastructure:
49266         type: object
49267         $ref: "#/definitions/cloud-infrastructure"
49268       business:
49269         type: object
49270         $ref: "#/definitions/business"
49271       service-design-and-creation:
49272         type: object
49273         $ref: "#/definitions/service-design-and-creation"
49274       network:
49275         type: object
49276         $ref: "#/definitions/network"
49277       aai-internal:
49278         type: object
49279         $ref: "#/definitions/aai-internal"
49280       nodes:
49281         type: array
49282         items:
49283           $ref: "#/definitions/aai-internal"
49284   inventory-item:
49285     properties:
49286       inventory-item-type:
49287         type: string
49288       inventory-item-link:
49289         type: string
49290       inventory-item-data:
49291         type: array
49292         items:
49293           $ref: "#/definitions/inventory-item-data"
49294       tagged-inventory-item-list:
49295         type: array
49296         items:
49297           $ref: "#/definitions/tagged-inventory-item-list"
49298   inventory-item-data:
49299     properties:
49300       property-name:
49301         type: string
49302       property-value:
49303         type: string
49304   inventory-response-item:
49305     description: |
49306       Inventory item for response list
49307     properties:
49308       model-name:
49309         type: string
49310       extra-properties:
49311         type: object
49312         $ref: "#/definitions/extra-properties"
49313       inventory-response-items:
49314         type: object
49315         $ref: "#/definitions/inventory-response-items"
49316   inventory-response-items:
49317     description: |
49318       Container for inventory items in response list
49319     properties:
49320       inventory-response-item:
49321         type: array
49322         items:
49323           $ref: "#/definitions/inventory-response-item"
49324   ipsec-configuration:
49325     description: |
49326       IPSec configuration node will contain various configuration data for the NMTE VNF. This node will have an edge to the generic-vnf (vnf type = TE). Starting 1607, this data will be populated by SDN-C
49327       ###### Related Nodes
49328       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
49329       - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
49330       - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER
49331     required:
49332     - ipsec-configuration-id
49333     properties:
49334       ipsec-configuration-id:
49335         type: string
49336         description: UUID of this configuration
49337       requested-vig-address-type:
49338         type: string
49339         description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
49340       requested-encryption-strength:
49341         type: string
49342         description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
49343       requested-dmz-type:
49344         type: string
49345         description: can offer a shared DMZ or a DMZ specific to a customer
49346       shared-dmz-network-address:
49347         type: string
49348         description: Network address of shared DMZ
49349       requested-customer-name:
49350         type: string
49351         description: If the DMZ is a custom DMZ, this field will indicate the customer information
49352       ike-version:
49353         type: string
49354         description: can be 1 or 2
49355       ikev1-authentication:
49356         type: string
49357         description: Contains values like md5, sha1, sha256, sha384
49358       ikev1-encryption:
49359         type: string
49360         description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
49361       ikev1-dh-group:
49362         type: string
49363         description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
49364       ikev1-am-group-id:
49365         type: string
49366         description: Group name defined in VIG for clients using aggressive mode
49367       ikev1-am-password:
49368         type: string
49369         description: pre-shared key for the above group name
49370       ikev1-sa-lifetime:
49371         type: string
49372         description: Lifetime for IKEv1 SA
49373       ipsec-authentication:
49374         type: string
49375         description: md5, sha1, sha256, sha384
49376       ipsec-encryption:
49377         type: string
49378         description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
49379       ipsec-sa-lifetime:
49380         type: string
49381         description: Life time for IPSec SA
49382       ipsec-pfs:
49383         type: string
49384         description: enable PFS or not
49385       xauth-userid:
49386         type: string
49387         description: user ID for xAuth, sm-user, ,nmteHostName
49388       xauth-user-password:
49389         type: string
49390         description: Encrypted using the Juniper $9$ algorithm
49391       dpd-interval:
49392         type: string
49393         description: The time between DPD probe
49394       dpd-frequency:
49395         type: string
49396         description: Maximum number of DPD before claiming the tunnel is down
49397       resource-version:
49398         type: string
49399         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49400       relationship-list:
49401         type: array
49402         items:
49403           $ref: "#/definitions/relationship"
49404       vig-servers:
49405         type: array
49406         items:
49407           $ref: "#/definitions/vig-server"
49408   ipsec-configurations:
49409     properties:
49410       ipsec-configuration:
49411         type: array
49412         items:
49413           $ref: "#/definitions/ipsec-configuration"
49414   key-data:
49415     properties:
49416       key-name:
49417         type: string
49418       key-value:
49419         type: string
49420   l-interface:
49421     description: |
49422       Logical interfaces, e.g., a vnic.
49423       ###### Related Nodes
49424       - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
49425       - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
49426       - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
49427       - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
49428       - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
49429       - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
49430       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
49431       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
49432       - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
49433       - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
49434       - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN
49435       - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
49436     required:
49437     - interface-name
49438     properties:
49439       interface-name:
49440         type: string
49441         description: Name given to the interface
49442       interface-role:
49443         type: string
49444         description: E.g., CUSTOMER, UPLINK, etc.
49445       v6-wan-link-ip:
49446         type: string
49447         description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
49448       selflink:
49449         type: string
49450         description: URL to endpoint where AAI can get more details
49451       interface-id:
49452         type: string
49453         description: ID of interface
49454       macaddr:
49455         type: string
49456         description: MAC address for the interface
49457       network-name:
49458         type: string
49459         description: Name of the network
49460       management-option:
49461         type: string
49462         description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
49463       interface-description:
49464         type: string
49465         description: Human friendly text regarding this interface.
49466       resource-version:
49467         type: string
49468         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49469       vlans:
49470         type: array
49471         items:
49472           $ref: "#/definitions/vlan"
49473       sriov-vfs:
49474         type: array
49475         items:
49476           $ref: "#/definitions/sriov-vf"
49477       relationship-list:
49478         type: array
49479         items:
49480           $ref: "#/definitions/relationship"
49481       l3-interface-ipv4-address-list:
49482         type: array
49483         items:
49484           $ref: "#/definitions/l3-interface-ipv4-address-list"
49485       l3-interface-ipv6-address-list:
49486         type: array
49487         items:
49488           $ref: "#/definitions/l3-interface-ipv6-address-list"
49489   l-interfaces:
49490     description: |
49491       Collection of logical interfaces.
49492     properties:
49493       l-interface:
49494         type: array
49495         items:
49496           $ref: "#/definitions/l-interface"
49497   l3-interface-ipv4-address-list:
49498     description: |
49499       IPv4 Address Range
49500       ###### Related Nodes
49501       - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
49502       - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
49503       - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
49504       - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
49505     required:
49506     - l3-interface-ipv4-address
49507     properties:
49508       l3-interface-ipv4-address:
49509         type: string
49510         description: IP address
49511       l3-interface-ipv4-prefix-length:
49512         type: integer
49513         format: int64
49514         description: Prefix length, 32 for single address
49515       vlan-id-inner:
49516         type: integer
49517         format: int64
49518         description: Inner VLAN tag
49519       vlan-id-outer:
49520         type: integer
49521         format: int64
49522         description: Outer VLAN tag
49523       is-floating:
49524         type: boolean
49525         description: Indicator of fixed or floating address
49526       resource-version:
49527         type: string
49528         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49529       neutron-network-id:
49530         type: string
49531         description: Neutron network id of the interface that address belongs to
49532       neutron-subnet-id:
49533         type: string
49534         description: Neutron id of subnet that address belongs to
49535       relationship-list:
49536         type: array
49537         items:
49538           $ref: "#/definitions/relationship"
49539   l3-interface-ipv6-address-list:
49540     description: |
49541       IPv6 Address Range
49542       ###### Related Nodes
49543       - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
49544       - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
49545       - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
49546       - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
49547     required:
49548     - l3-interface-ipv6-address
49549     properties:
49550       l3-interface-ipv6-address:
49551         type: string
49552         description: IP address
49553       l3-interface-ipv6-prefix-length:
49554         type: integer
49555         format: int64
49556         description: Prefix length, 128 for single address
49557       vlan-id-inner:
49558         type: integer
49559         format: int64
49560         description: Inner VLAN tag
49561       vlan-id-outer:
49562         type: integer
49563         format: int64
49564         description: Outer VLAN tag
49565       is-floating:
49566         type: boolean
49567         description: Indicator of fixed or floating address
49568       resource-version:
49569         type: string
49570         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49571       neutron-network-id:
49572         type: string
49573         description: Neutron network id of the interface that address belongs to
49574       neutron-subnet-id:
49575         type: string
49576         description: Neutron id of subnet that address belongs to
49577       relationship-list:
49578         type: array
49579         items:
49580           $ref: "#/definitions/relationship"
49581   l3-network:
49582     description: |
49583       Generic network definition
49584       ###### Related Nodes
49585       - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
49586       - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
49587       - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
49588       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
49589       - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
49590       - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
49591       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
49592       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
49593       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
49594       - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
49595       - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
49596       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
49597       - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
49598       - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
49599       - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
49600       - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET
49601     required:
49602     - network-id
49603     - network-name
49604     - is-bound-to-vpn
49605     - is-provider-network
49606     - is-shared-network
49607     - is-external-network
49608     properties:
49609       network-id:
49610         type: string
49611         description: Network ID, should be uuid. Unique across A&AI.
49612       network-name:
49613         type: string
49614         description: Name of the network, governed by some naming convention..
49615       network-type:
49616         type: string
49617         description: Type of the network - who defines these values?
49618       network-role:
49619         type: string
49620         description: Role the network plans - who defines these values?
49621       network-technology:
49622         type: string
49623         description: Network technology - who defines these values?
49624       neutron-network-id:
49625         type: string
49626         description: Neutron network id of this Interface
49627       is-bound-to-vpn:
49628         type: boolean
49629       service-id:
49630         type: string
49631         description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
49632       network-role-instance:
49633         type: integer
49634         format: int64
49635         description: network role instance
49636       resource-version:
49637         type: string
49638         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49639       orchestration-status:
49640         type: string
49641         description: Orchestration status of this VNF, mastered by MSO
49642       heat-stack-id:
49643         type: string
49644         description: Heat stack id corresponding to this instance, managed by MSO
49645       mso-catalog-key:
49646         type: string
49647         description: Corresponds to the SDN-C catalog id used to configure this VCE
49648       contrail-network-fqdn:
49649         type: string
49650         description: Contrail FQDN for the network
49651       persona-model-id:
49652         type: string
49653         description: the ASDC model id for this resource or service model.
49654       persona-model-version:
49655         type: string
49656         description: the ASDC model version for this resource or service model.
49657       model-version-id:
49658         type: string
49659         description: the ASDC model version for this resource or service model.
49660       persona-model-customization-id:
49661         type: string
49662         description: captures the id of all the configuration used to customize the resource for the service.
49663       widget-model-id:
49664         type: string
49665         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
49666       widget-model-version:
49667         type: string
49668         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
49669       physical-network-name:
49670         type: string
49671         description: Name associated with the physical network.
49672       is-provider-network:
49673         type: boolean
49674       is-shared-network:
49675         type: boolean
49676       is-external-network:
49677         type: boolean
49678       selflink:
49679         type: string
49680         description: Path to the controller object.
49681       subnets:
49682         type: array
49683         items:
49684           $ref: "#/definitions/subnet"
49685       ctag-assignments:
49686         type: array
49687         items:
49688           $ref: "#/definitions/ctag-assignment"
49689       segmentation-assignments:
49690         type: array
49691         items:
49692           $ref: "#/definitions/segmentation-assignment"
49693       relationship-list:
49694         type: array
49695         items:
49696           $ref: "#/definitions/relationship"
49697         description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
49698   l3-networks:
49699     properties:
49700       l3-network:
49701         type: array
49702         items:
49703           $ref: "#/definitions/l3-network"
49704   lag-interface:
49705     description: |
49706       Link aggregate interface
49707       ###### Related Nodes
49708       - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
49709       - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
49710       - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
49711       - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
49712       - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
49713       - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
49714       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
49715       - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE
49716       - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK
49717     required:
49718     - interface-name
49719     properties:
49720       interface-name:
49721         type: string
49722         description: Name that identifies the link aggregate interface
49723       interface-description:
49724         type: string
49725         description: Human friendly text regarding this interface.
49726       resource-version:
49727         type: string
49728         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49729       speed-value:
49730         type: string
49731         description: Captures the numeric part of the speed
49732       speed-units:
49733         type: string
49734         description: Captures the units corresponding to the speed
49735       interface-id:
49736         type: string
49737         description: ID of interface
49738       interface-role:
49739         type: string
49740         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
49741       prov-status:
49742         type: string
49743         description: Trigger for operational monitoring of this resource by Service Assurance systems.
49744       relationship-list:
49745         type: array
49746         items:
49747           $ref: "#/definitions/relationship"
49748       l-interfaces:
49749         type: array
49750         items:
49751           $ref: "#/definitions/l-interface"
49752   lag-interfaces:
49753     description: |
49754       Collection of link aggregate interfaces.
49755     properties:
49756       lag-interface:
49757         type: array
49758         items:
49759           $ref: "#/definitions/lag-interface"
49760   lag-link:
49761     description: |
49762       LAG links can connect lag-interfaces
49763       ###### Related Nodes
49764       - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
49765       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
49766     required:
49767     - link-name
49768     properties:
49769       link-name:
49770         type: string
49771         description: Alphabetical concatenation of lag-interface names
49772       resource-version:
49773         type: string
49774         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49775       relationship-list:
49776         type: array
49777         items:
49778           $ref: "#/definitions/relationship"
49779   lag-links:
49780     description: |
49781       Collection of link aggregation connections
49782     properties:
49783       lag-link:
49784         type: array
49785         items:
49786           $ref: "#/definitions/lag-link"
49787   license:
49788     description: |
49789       Metadata for license group.
49790       ###### Related Nodes
49791       - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
49792       - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
49793     required:
49794     - group-uuid
49795     - resource-uuid
49796     properties:
49797       group-uuid:
49798         type: string
49799         description: Unique ID for the license group the resource belongs to, should be uuid.
49800       resource-uuid:
49801         type: string
49802         description: Unique ID of a license resource.
49803       resource-version:
49804         type: string
49805         description: Concurrency value
49806       relationship-list:
49807         type: array
49808         items:
49809           $ref: "#/definitions/relationship"
49810   licenses:
49811     description: |
49812       Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
49813     properties:
49814       license:
49815         type: array
49816         items:
49817           $ref: "#/definitions/license"
49818   line-of-business:
49819     description: |
49820       describes a line-of-business
49821       ###### Related Nodes
49822       - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
49823     required:
49824     - line-of-business-name
49825     properties:
49826       line-of-business-name:
49827         type: string
49828         description: Name of the line-of-business (product)
49829       resource-version:
49830         type: string
49831         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49832       relationship-list:
49833         type: array
49834         items:
49835           $ref: "#/definitions/relationship"
49836   lines-of-business:
49837     description: |
49838       Collection of lines-of-business
49839     properties:
49840       line-of-business:
49841         type: array
49842         items:
49843           $ref: "#/definitions/line-of-business"
49844   logical-link:
49845     description: |
49846       Logical links generally connect l-interfaces but are used to express logical connectivity between two points
49847       ###### Related Nodes
49848       - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
49849       - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
49850       - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
49851       - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
49852       - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
49853       - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
49854       - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
49855       - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
49856       - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
49857       - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
49858       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
49859       - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
49860       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
49861     required:
49862     - link-name
49863     - link-type
49864     properties:
49865       link-name:
49866         type: string
49867         description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
49868       link-type:
49869         type: string
49870         description: Type of logical link, e.g., evc
49871       speed-value:
49872         type: string
49873         description: Captures the numeric part of the speed
49874       speed-units:
49875         type: string
49876         description: Captures the units corresponding to the speed
49877       ip-version:
49878         type: string
49879         description: v4, v6, or ds for dual stack
49880       routing-protocol:
49881         type: string
49882         description: For example, static or BGP
49883       resource-version:
49884         type: string
49885         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49886       persona-model-id:
49887         type: string
49888         description: the ASDC model id for this resource or service model.
49889       persona-model-version:
49890         type: string
49891         description: the ASDC model version for this resource or service model.
49892       model-version-id:
49893         type: string
49894         description: the ASDC model version for this resource or service model.
49895       widget-model-id:
49896         type: string
49897         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
49898       widget-model-version:
49899         type: string
49900         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
49901       operational-status:
49902         type: string
49903         description: Indication of operational status of the logical link.
49904       prov-status:
49905         type: string
49906         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
49907       link-role:
49908         type: string
49909         description: Indication of the network use of the logical link.
49910       link-name2:
49911         type: string
49912         description: Alias or alternate name (CLCI or D1 name).
49913       link-id:
49914         type: string
49915         description: UUID of the logical-link, SDNC generates this.
49916       circuit-id:
49917         type: string
49918         description: Circuit id
49919       purpose:
49920         type: string
49921         description: Reason for this entity, role it is playing
49922       relationship-list:
49923         type: array
49924         items:
49925           $ref: "#/definitions/relationship"
49926   logical-links:
49927     description: |
49928       Collection of logical connections
49929     properties:
49930       logical-link:
49931         type: array
49932         items:
49933           $ref: "#/definitions/logical-link"
49934   metadata:
49935     description: |
49936       Collection of metadatum (key/value pairs)
49937     properties:
49938       metadatum:
49939         type: array
49940         items:
49941           $ref: "#/definitions/metadatum"
49942   metadatum:
49943     description: |
49944       Key/value pairs
49945       ###### Related Nodes
49946       - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
49947       - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
49948       - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
49949       - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
49950     required:
49951     - metaname
49952     - metaval
49953     properties:
49954       metaname:
49955         type: string
49956       metaval:
49957         type: string
49958       resource-version:
49959         type: string
49960         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49961   model:
49962     description: |
49963       Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
49964       ###### Related Nodes
49965       - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
49966       - FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
49967       - FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
49968       - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
49969       - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
49970       - MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
49971       - MODEL is DELETED when these are DELETED MODEL-VER
49972     required:
49973     - model-invariant-id
49974     - model-type
49975     properties:
49976       model-invariant-id:
49977         type: string
49978         description: Unique identifier corresponding to the main definition of a model in ASDC
49979       model-type:
49980         type: string
49981         description: Type of the model, e.g., service, resource, widget, etc.
49982       resource-version:
49983         type: string
49984         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49985       model-vers:
49986         type: array
49987         items:
49988           $ref: "#/definitions/model-ver"
49989       relationship-list:
49990         type: array
49991         items:
49992           $ref: "#/definitions/relationship"
49993   model-and-named-query-search:
49994     description: |
49995       ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
49996     properties:
49997       query-parameters:
49998         type: object
49999         $ref: "#/definitions/query-parameters"
50000       instance-filters:
50001         type: object
50002         $ref: "#/definitions/instance-filters"
50003       secondary-filts:
50004         type: object
50005         $ref: "#/definitions/secondary-filts"
50006       top-node-type:
50007         type: string
50008       secondary-filter-cut-point:
50009         type: string
50010   model-constraint:
50011     description: |
50012       This is how we would capture constraints defining allowed sets of elements.
50013       ###### Related Nodes
50014       - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
50015       - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
50016       - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET
50017     required:
50018     - model-constraint-uuid
50019     - constrained-element-set-uuid-to-replace
50020     properties:
50021       model-constraint-uuid:
50022         type: string
50023       constrained-element-set-uuid-to-replace:
50024         type: string
50025       constrained-element-sets:
50026         type: array
50027         items:
50028           $ref: "#/definitions/constrained-element-set"
50029       resource-version:
50030         type: string
50031         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50032   model-constraints:
50033     properties:
50034       model-constraint:
50035         type: array
50036         items:
50037           $ref: "#/definitions/model-constraint"
50038   model-element:
50039     description: |
50040       Defines how other models combine to make up a higher-level model.
50041       ###### Related Nodes
50042       - TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
50043       - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
50044       - TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
50045       - TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
50046       - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
50047       - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
50048       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
50049       - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT
50050     required:
50051     - model-element-uuid
50052     - new-data-del-flag
50053     - cardinality
50054     properties:
50055       model-element-uuid:
50056         type: string
50057       new-data-del-flag:
50058         type: string
50059         description: Indicates whether this element was created as part of instantiation from this model
50060       cardinality:
50061         type: string
50062         description: How many of this type of element are required/allowed
50063       linkage-points:
50064         type: string
50065       resource-version:
50066         type: string
50067         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50068       model-elements:
50069         type: array
50070         items:
50071           $ref: "#/definitions/model-element"
50072         description: Defines how other models combine to make up a higher-level model
50073       model-constraints:
50074         type: array
50075         items:
50076           $ref: "#/definitions/model-constraint"
50077         description: Describes new constraints on this model element that are not part of that model's definition
50078       relationship-list:
50079         type: array
50080         items:
50081           $ref: "#/definitions/relationship"
50082   model-elements:
50083     properties:
50084       model-element:
50085         type: array
50086         items:
50087           $ref: "#/definitions/model-element"
50088   model-ver:
50089     description: |
50090       Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
50091       ###### Related Nodes
50092       - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
50093       - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
50094       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
50095       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
50096       - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT
50097       - MODEL-VER is DELETED when these are DELETED MODEL-ELEMENT,METADATUM
50098     required:
50099     - model-version-id
50100     - model-name
50101     - model-version
50102     properties:
50103       model-version-id:
50104         type: string
50105         description: Unique identifier corresponding to one version of a model in ASDC
50106       model-name:
50107         type: string
50108         description: Name of the model, which can change from version to version.
50109       model-version:
50110         type: string
50111         description: Version
50112       model-description:
50113         type: string
50114         description: Description
50115       resource-version:
50116         type: string
50117         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50118       model-elements:
50119         type: array
50120         items:
50121           $ref: "#/definitions/model-element"
50122       metadata:
50123         type: array
50124         items:
50125           $ref: "#/definitions/metadatum"
50126       relationship-list:
50127         type: array
50128         items:
50129           $ref: "#/definitions/relationship"
50130   model-vers:
50131     properties:
50132       model-ver:
50133         type: array
50134         items:
50135           $ref: "#/definitions/model-ver"
50136   models:
50137     description: |
50138       Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
50139     properties:
50140       model:
50141         type: array
50142         items:
50143           $ref: "#/definitions/model"
50144   multicast-configuration:
50145     description: |
50146       ###### Related Nodes
50147       - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
50148     required:
50149     - multicast-configuration-id
50150     - multicast-protocol
50151     - rp-type
50152     properties:
50153       multicast-configuration-id:
50154         type: string
50155         description: Unique id of multicast configuration.
50156       multicast-protocol:
50157         type: string
50158         description: protocol of multicast configuration
50159       rp-type:
50160         type: string
50161         description: rp type of multicast configuration
50162       resource-version:
50163         type: string
50164         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50165       relationship-list:
50166         type: array
50167         items:
50168           $ref: "#/definitions/relationship"
50169   multicast-configurations:
50170     description: |
50171       multicast configuration of generic-vnf ip-address
50172     properties:
50173       multicast-configuration:
50174         type: array
50175         items:
50176           $ref: "#/definitions/multicast-configuration"
50177   named-queries:
50178     properties:
50179       named-query:
50180         type: array
50181         items:
50182           $ref: "#/definitions/named-query"
50183   named-query:
50184     description: |
50185       TBD
50186       ###### Related Nodes
50187       - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
50188       - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
50189       - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
50190       - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT
50191     required:
50192     - named-query-uuid
50193     - named-query-name
50194     - named-query-version
50195     properties:
50196       named-query-uuid:
50197         type: string
50198       named-query-name:
50199         type: string
50200       named-query-version:
50201         type: string
50202       required-input-param:
50203         type: string
50204       description:
50205         type: string
50206       resource-version:
50207         type: string
50208       named-query-elements:
50209         type: array
50210         items:
50211           $ref: "#/definitions/named-query-element"
50212       relationship-list:
50213         type: array
50214         items:
50215           $ref: "#/definitions/relationship"
50216   named-query-element:
50217     description: |
50218       TBD
50219       ###### Related Nodes
50220       - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
50221       - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
50222       - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
50223       - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
50224       - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
50225       - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
50226       - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP
50227     required:
50228     - named-query-element-uuid
50229     properties:
50230       named-query-element-uuid:
50231         type: string
50232       property-collect-list:
50233         type: string
50234       resource-version:
50235         type: string
50236       property-limit-desc:
50237         type: string
50238       do-not-output:
50239         type: string
50240       named-query-elements:
50241         type: array
50242         items:
50243           $ref: "#/definitions/named-query-element"
50244       related-lookups:
50245         type: array
50246         items:
50247           $ref: "#/definitions/related-lookup"
50248       property-constraints:
50249         type: array
50250         items:
50251           $ref: "#/definitions/property-constraint"
50252       relationship-list:
50253         type: array
50254         items:
50255           $ref: "#/definitions/relationship"
50256   named-query-elements:
50257     properties:
50258       named-query-element:
50259         type: array
50260         items:
50261           $ref: "#/definitions/named-query-element"
50262   network:
50263     description: |
50264       Namespace for network inventory resources.
50265     properties:
50266       logical-links:
50267         type: array
50268         items:
50269           $ref: "#/definitions/logical-link"
50270       site-pair-sets:
50271         type: array
50272         items:
50273           $ref: "#/definitions/site-pair-set"
50274       vpn-bindings:
50275         type: array
50276         items:
50277           $ref: "#/definitions/vpn-binding"
50278       vpls-pes:
50279         type: array
50280         items:
50281           $ref: "#/definitions/vpls-pe"
50282       multicast-configurations:
50283         type: array
50284         items:
50285           $ref: "#/definitions/multicast-configuration"
50286       vces:
50287         type: array
50288         items:
50289           $ref: "#/definitions/vce"
50290       vnfcs:
50291         type: array
50292         items:
50293           $ref: "#/definitions/vnfc"
50294       l3-networks:
50295         type: array
50296         items:
50297           $ref: "#/definitions/l3-network"
50298       network-policies:
50299         type: array
50300         items:
50301           $ref: "#/definitions/network-policy"
50302       generic-vnfs:
50303         type: array
50304         items:
50305           $ref: "#/definitions/generic-vnf"
50306       lag-links:
50307         type: array
50308         items:
50309           $ref: "#/definitions/lag-link"
50310       newvces:
50311         type: array
50312         items:
50313           $ref: "#/definitions/newvce"
50314       pnfs:
50315         type: array
50316         items:
50317           $ref: "#/definitions/pnf"
50318       physical-links:
50319         type: array
50320         items:
50321           $ref: "#/definitions/physical-link"
50322       ipsec-configurations:
50323         type: array
50324         items:
50325           $ref: "#/definitions/ipsec-configuration"
50326       route-table-references:
50327         type: array
50328         items:
50329           $ref: "#/definitions/route-table-reference"
50330       instance-groups:
50331         type: array
50332         items:
50333           $ref: "#/definitions/instance-group"
50334       zones:
50335         type: array
50336         items:
50337           $ref: "#/definitions/zone"
50338   network-policies:
50339     properties:
50340       network-policy:
50341         type: array
50342         items:
50343           $ref: "#/definitions/network-policy"
50344   network-policy:
50345     description: |
50346       ###### Related Nodes
50347       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
50348     required:
50349     - network-policy-id
50350     properties:
50351       network-policy-id:
50352         type: string
50353         description: UUID representing unique key to this instance
50354       network-policy-fqdn:
50355         type: string
50356         description: Contrail FQDN for the policy
50357       heat-stack-id:
50358         type: string
50359         description: ID for the openStack Heat instance
50360       resource-version:
50361         type: string
50362         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50363       relationship-list:
50364         type: array
50365         items:
50366           $ref: "#/definitions/relationship"
50367   network-profile:
50368     description: |
50369       Network profile populated by SDN-GP for SNMP
50370       ###### Related Nodes
50371       - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
50372     required:
50373     - nm-profile-name
50374     properties:
50375       nm-profile-name:
50376         type: string
50377         description: Unique name of network profile.
50378       community-string:
50379         type: string
50380         description: Encrypted SNMP community string
50381       resource-version:
50382         type: string
50383         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50384       relationship-list:
50385         type: array
50386         items:
50387           $ref: "#/definitions/relationship"
50388   network-profiles:
50389     description: |
50390       Collection of network profiles
50391     properties:
50392       network-profile:
50393         type: array
50394         items:
50395           $ref: "#/definitions/network-profile"
50396   newvce:
50397     description: |
50398       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
50399       ###### Related Nodes
50400       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
50401       - NEWVCE is DELETED when these are DELETED L-INTERFACE
50402     required:
50403     - vnf-id2
50404     - vnf-name
50405     - vnf-type
50406     properties:
50407       vnf-id2:
50408         type: string
50409         description: Unique id of VNF, can't use same attribute name right now until we promote this new object
50410       vnf-name:
50411         type: string
50412         description: Name of VNF.
50413       vnf-name2:
50414         type: string
50415         description: Alternate name of VNF.
50416       vnf-type:
50417         type: string
50418         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
50419       prov-status:
50420         type: string
50421         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
50422       operational-state:
50423         type: string
50424         description: Indicator for whether the resource is considered operational
50425       license-key:
50426         type: string
50427         description: OBSOLETE -  do not use
50428       ipv4-oam-address:
50429         type: string
50430         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by VPE (v4-loopback0-ip-address).
50431       equipment-role:
50432         type: string
50433         description: Client should send valid enumerated value.
50434       resource-version:
50435         type: string
50436         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50437       ipv4-loopback0-address:
50438         type: string
50439         description: v4 Loopback0 address
50440       orchestration-status:
50441         type: string
50442         description: Orchestration status of this VNF, mastered by MSO.
50443       heat-stack-id:
50444         type: string
50445         description: Heat stack id corresponding to this instance, managed by MSO
50446       mso-catalog-key:
50447         type: string
50448         description: Corresponds to the SDN-C catalog id used to configure this VCE
50449       relationship-list:
50450         type: array
50451         items:
50452           $ref: "#/definitions/relationship"
50453       l-interfaces:
50454         type: array
50455         items:
50456           $ref: "#/definitions/l-interface"
50457   newvces:
50458     description: |
50459       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
50460     properties:
50461       newvce:
50462         type: array
50463         items:
50464           $ref: "#/definitions/newvce"
50465   notification-event:
50466     properties:
50467       cambria.partition:
50468         type: string
50469       notification-event-header:
50470         type: object
50471         $ref: "#/definitions/notification-event-header"
50472   notification-event-header:
50473     properties:
50474       id:
50475         type: string
50476       timestamp:
50477         type: string
50478       source-name:
50479         type: string
50480       domain:
50481         type: string
50482       sequence-number:
50483         type: string
50484       severity:
50485         type: string
50486       event-type:
50487         type: string
50488       version:
50489         type: string
50490       action:
50491         type: string
50492       entity-type:
50493         type: string
50494       top-entity-type:
50495         type: string
50496       entity-link:
50497         type: string
50498       status:
50499         type: string
50500   notify:
50501     required:
50502     - event-id
50503     properties:
50504       event-id:
50505         type: string
50506       node-type:
50507         type: string
50508       event-trigger:
50509         type: string
50510       key-data:
50511         type: array
50512         items:
50513           $ref: "#/definitions/key-data"
50514       selflink:
50515         type: string
50516   oam-network:
50517     description: |
50518       OAM network, to be deprecated shortly.  Do not use for new purposes.
50519       ###### Related Nodes
50520       - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
50521       - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
50522       - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
50523     required:
50524     - network-uuid
50525     - network-name
50526     - cvlan-tag
50527     properties:
50528       network-uuid:
50529         type: string
50530         description: UUID of the network. Unique across a cloud-region
50531       network-name:
50532         type: string
50533         description: Name of the network.
50534       cvlan-tag:
50535         type: integer
50536         format: int64
50537         description: cvlan-id
50538       ipv4-oam-gateway-address:
50539         type: string
50540         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
50541       ipv4-oam-gateway-address-prefix-length:
50542         type: integer
50543         format: int32
50544         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
50545       resource-version:
50546         type: string
50547         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50548       relationship-list:
50549         type: array
50550         items:
50551           $ref: "#/definitions/relationship"
50552   oam-networks:
50553     description: |
50554       Collection of OAM networks, to be deprecated shortly.  Do not use for new purposes.
50555     properties:
50556       oam-network:
50557         type: array
50558         items:
50559           $ref: "#/definitions/oam-network"
50560   operational-environment:
50561     description: |
50562       It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
50563       ###### Related Nodes
50564       - TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
50565       - FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
50566     required:
50567     - operational-environment-id
50568     - operational-environment-name
50569     - operational-environment-type
50570     - operational-environment-status
50571     - tenant-context
50572     - workload-context
50573     properties:
50574       operational-environment-id:
50575         type: string
50576         description: UUID of an operational environment
50577       operational-environment-name:
50578         type: string
50579         description: Operational Environment name
50580       operational-environment-type:
50581         type: string
50582         description: Operational Environment Type.
50583       operational-environment-status:
50584         type: string
50585         description: Status
50586       tenant-context:
50587         type: string
50588         description: Tenant Context.
50589       workload-context:
50590         type: string
50591         description: Workload Context.
50592       resource-version:
50593         type: string
50594         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50595       relationship-list:
50596         type: array
50597         items:
50598           $ref: "#/definitions/relationship"
50599   operational-environments:
50600     description: |
50601       a logical partition of the cloud which allows to have multiple environments in the production AIC.
50602     properties:
50603       operational-environment:
50604         type: array
50605         items:
50606           $ref: "#/definitions/operational-environment"
50607   overloaded-model:
50608     description: |
50609       Allows for legacy POST of old-style and new-style models
50610     required:
50611     - model-invariant-id
50612     - model-name-version-id
50613     - model-type
50614     - model-name
50615     - model-id
50616     - model-version
50617     properties:
50618       model-invariant-id:
50619         type: string
50620         description: Unique identifier corresponding to the main definition of a model in ASDC
50621       model-name-version-id:
50622         type: string
50623         description: Unique identifier corresponding to one version of a model in ASDC
50624       model-type:
50625         type: string
50626         description: Type of the model, e.g., service, resource, widget, etc.
50627       model-name:
50628         type: string
50629         description: Name of the model, which can change from version to version.
50630       model-id:
50631         type: string
50632         description: Invariant unique ID which does not change from version to version
50633       model-version:
50634         type: string
50635         description: Version
50636       model-description:
50637         type: string
50638         description: Description
50639       resource-version:
50640         type: string
50641         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50642       model-vers:
50643         type: object
50644         $ref: "#/definitions/model-vers"
50645       relationship-list:
50646         type: object
50647         $ref: "#/definitions/relationship-list"
50648   owning-entities:
50649     description: |
50650       Collection of owning-entities
50651     properties:
50652       owning-entity:
50653         type: array
50654         items:
50655           $ref: "#/definitions/owning-entity"
50656   owning-entity:
50657     description: |
50658       describes an owning-entity
50659       ###### Related Nodes
50660       - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
50661     required:
50662     - owning-entity-id
50663     - owning-entity-name
50664     properties:
50665       owning-entity-id:
50666         type: string
50667         description: UUID of an owning entity
50668       owning-entity-name:
50669         type: string
50670         description: Owning entity name
50671       resource-version:
50672         type: string
50673         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50674       relationship-list:
50675         type: array
50676         items:
50677           $ref: "#/definitions/relationship"
50678   p-interface:
50679     description: |
50680       Physical interface (e.g., nic)
50681       ###### Related Nodes
50682       - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
50683       - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
50684       - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
50685       - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
50686       - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
50687       - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
50688       - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
50689       - P-INTERFACE is DELETED when these are DELETED L-INTERFACE
50690       - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK
50691     required:
50692     - interface-name
50693     properties:
50694       interface-name:
50695         type: string
50696         description: Name that identifies the physical interface
50697       speed-value:
50698         type: string
50699         description: Captures the numeric part of the speed
50700       speed-units:
50701         type: string
50702         description: Captures the units corresponding to the speed
50703       port-description:
50704         type: string
50705         description: Nature of the services and connectivity on this port.
50706       equipment-identifier:
50707         type: string
50708         description: CLEI or other specification for p-interface hardware.
50709       interface-role:
50710         type: string
50711         description: Role specification for p-interface hardware.
50712       interface-type:
50713         type: string
50714         description: Indicates the physical properties of the interface.
50715       prov-status:
50716         type: string
50717         description: Trigger for operational monitoring of this resource by Service Assurance systems.
50718       resource-version:
50719         type: string
50720         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50721       relationship-list:
50722         type: array
50723         items:
50724           $ref: "#/definitions/relationship"
50725       l-interfaces:
50726         type: array
50727         items:
50728           $ref: "#/definitions/l-interface"
50729   p-interfaces:
50730     description: |
50731       Collection of physical interfaces.
50732     properties:
50733       p-interface:
50734         type: array
50735         items:
50736           $ref: "#/definitions/p-interface"
50737   physical-link:
50738     description: |
50739       Collection of physical connections, typically between p-interfaces
50740       ###### Related Nodes
50741       - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
50742     required:
50743     - link-name
50744     properties:
50745       link-name:
50746         type: string
50747         description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
50748       speed-value:
50749         type: string
50750         description: Captures the numeric part of the speed
50751       speed-units:
50752         type: string
50753         description: Captures the units corresponding to the speed
50754       circuit-id:
50755         type: string
50756         description: Circuit it
50757       dual-mode:
50758         type: string
50759         description: Dual access mode (e.g., primary, secondary
50760       management-option:
50761         type: string
50762         description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
50763       service-provider-name:
50764         type: string
50765         description: Name of the service Provider on this link.
50766       resource-version:
50767         type: string
50768         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50769       relationship-list:
50770         type: array
50771         items:
50772           $ref: "#/definitions/relationship"
50773   physical-links:
50774     description: |
50775       Collection of physical connections, typically between p-interfaces
50776     properties:
50777       physical-link:
50778         type: array
50779         items:
50780           $ref: "#/definitions/physical-link"
50781   platform:
50782     description: |
50783       describes a platform
50784       ###### Related Nodes
50785       - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
50786     required:
50787     - platform-name
50788     properties:
50789       platform-name:
50790         type: string
50791         description: Name of the platform
50792       resource-version:
50793         type: string
50794         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50795       relationship-list:
50796         type: array
50797         items:
50798           $ref: "#/definitions/relationship"
50799   platforms:
50800     description: |
50801       Collection of platforms
50802     properties:
50803       platform:
50804         type: array
50805         items:
50806           $ref: "#/definitions/platform"
50807   pnf:
50808     description: |
50809       PNF represents a physical network function. typically equipment used in the D1 world.
50810       ###### Related Nodes
50811       - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
50812       - TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
50813       - TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
50814       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
50815       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
50816       - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
50817       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
50818       - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
50819     required:
50820     - pnf-name
50821     - in-maint
50822     properties:
50823       pnf-name:
50824         type: string
50825         description: unique name of Physical Network Function.
50826       pnf-name2:
50827         type: string
50828         description: name of Physical Network Function.
50829       pnf-name2-source:
50830         type: string
50831         description: source of name2
50832       pnf-id:
50833         type: string
50834         description: id of pnf
50835       equip-type:
50836         type: string
50837         description: Equipment type.  Source of truth should define valid values.
50838       equip-vendor:
50839         type: string
50840         description: Equipment vendor.  Source of truth should define valid values.
50841       equip-model:
50842         type: string
50843         description: Equipment model.  Source of truth should define valid values.
50844       management-option:
50845         type: string
50846         description: identifier of managed by company or customer
50847       ipaddress-v4-oam:
50848         type: string
50849         description: ipv4-oam-address with new naming convention for IP addresses
50850       sw-version:
50851         type: string
50852         description: sw-version is the version of SW for the hosted application on the PNF.
50853       in-maint:
50854         type: boolean
50855       frame-id:
50856         type: string
50857         description: ID of the physical frame (relay rack) where pnf is installed.
50858       serial-number:
50859         type: string
50860         description: Serial number of the device
50861       ipaddress-v4-loopback-0:
50862         type: string
50863         description: IPV4 Loopback 0 address
50864       ipaddress-v6-loopback-0:
50865         type: string
50866         description: IPV6 Loopback 0 address
50867       ipaddress-v4-aim:
50868         type: string
50869         description: IPV4 AIM address
50870       ipaddress-v6-aim:
50871         type: string
50872         description: IPV6 AIM address
50873       ipaddress-v6-oam:
50874         type: string
50875         description: IPV6 OAM address
50876       inv-status:
50877         type: string
50878         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
50879       resource-version:
50880         type: string
50881         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50882       prov-status:
50883         type: string
50884         description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
50885       nf-role:
50886         type: string
50887         description: Nf Role is the role performed by this instance in the network.
50888       relationship-list:
50889         type: array
50890         items:
50891           $ref: "#/definitions/relationship"
50892       p-interfaces:
50893         type: array
50894         items:
50895           $ref: "#/definitions/p-interface"
50896       lag-interfaces:
50897         type: array
50898         items:
50899           $ref: "#/definitions/lag-interface"
50900   pnfs:
50901     description: |
50902       Collection of Physical Network Functions.
50903     properties:
50904       pnf:
50905         type: array
50906         items:
50907           $ref: "#/definitions/pnf"
50908   port-group:
50909     description: |
50910       Used to capture the network interfaces of this VCE
50911       ###### Related Nodes
50912       - TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
50913       - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE)
50914       - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG
50915     required:
50916     - interface-id
50917     - orchestration-status
50918     properties:
50919       interface-id:
50920         type: string
50921         description: Unique ID of the interface
50922       neutron-network-id:
50923         type: string
50924         description: Neutron network id of this Interface
50925       neutron-network-name:
50926         type: string
50927         description: Neutron network name of this Interface
50928       interface-role:
50929         type: string
50930         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
50931       resource-version:
50932         type: string
50933         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50934       port-group-id:
50935         type: string
50936         description: Unique ID for port group in vmware
50937       port-group-name:
50938         type: string
50939         description: Likely to duplicate value of neutron network name
50940       switch-name:
50941         type: string
50942         description: DVS or standard switch name (should be non-null for port groups associated with DVS)
50943       orchestration-status:
50944         type: string
50945         description: Orchestration status of this VNF, mastered by MSO
50946       heat-stack-id:
50947         type: string
50948         description: Heat stack id corresponding to this instance, managed by MSO
50949       mso-catalog-key:
50950         type: string
50951         description: Corresponds to the SDN-C catalog id used to configure this VCE
50952       cvlan-tags:
50953         type: array
50954         items:
50955           $ref: "#/definitions/cvlan-tag-entry"
50956       relationship-list:
50957         type: array
50958         items:
50959           $ref: "#/definitions/relationship"
50960   port-groups:
50961     properties:
50962       port-group:
50963         type: array
50964         items:
50965           $ref: "#/definitions/port-group"
50966   project:
50967     description: |
50968       describes the project
50969       ###### Related Nodes
50970       - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
50971     required:
50972     - project-name
50973     properties:
50974       project-name:
50975         type: string
50976         description: Name of the project deploying a service
50977       resource-version:
50978         type: string
50979         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50980       relationship-list:
50981         type: array
50982         items:
50983           $ref: "#/definitions/relationship"
50984   projects:
50985     description: |
50986       Collection of projects
50987     properties:
50988       project:
50989         type: array
50990         items:
50991           $ref: "#/definitions/project"
50992   properties:
50993     description: |
50994       Property holder for query properties or instance properties
50995     properties:
50996       property-name:
50997         type: string
50998       property-value:
50999         type: string
51000   property-constraint:
51001     description: |
51002       TBD
51003       ###### Related Nodes
51004       - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
51005     required:
51006     - property-constraint-uuid
51007     - constraint-type
51008     - property-name
51009     - property-value
51010     properties:
51011       property-constraint-uuid:
51012         type: string
51013       constraint-type:
51014         type: string
51015       property-name:
51016         type: string
51017       property-value:
51018         type: string
51019       resource-version:
51020         type: string
51021   property-constraints:
51022     properties:
51023       property-constraint:
51024         type: array
51025         items:
51026           $ref: "#/definitions/property-constraint"
51027   pserver:
51028     description: |
51029       Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
51030       ###### Related Nodes
51031       - TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
51032       - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
51033       - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
51034       - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
51035       - TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
51036       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
51037       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
51038       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
51039       - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
51040       - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
51041       - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER
51042       - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
51043       - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT
51044     required:
51045     - hostname
51046     - in-maint
51047     properties:
51048       hostname:
51049         type: string
51050         description: Value from executing hostname on the compute node.
51051       ptnii-equip-name:
51052         type: string
51053         description: PTNII name
51054       number-of-cpus:
51055         type: integer
51056         format: int32
51057         description: Number of cpus
51058       disk-in-gigabytes:
51059         type: integer
51060         format: int32
51061         description: Disk size, in GBs
51062       ram-in-megabytes:
51063         type: integer
51064         format: int32
51065         description: RAM size, in MBs
51066       equip-type:
51067         type: string
51068         description: Equipment type.  Source of truth should define valid values.
51069       equip-vendor:
51070         type: string
51071         description: Equipment vendor.  Source of truth should define valid values.
51072       equip-model:
51073         type: string
51074         description: Equipment model.  Source of truth should define valid values.
51075       fqdn:
51076         type: string
51077         description: Fully-qualified domain name
51078       pserver-selflink:
51079         type: string
51080         description: URL to endpoint where AAI can get more details
51081       ipv4-oam-address:
51082         type: string
51083         description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
51084       serial-number:
51085         type: string
51086         description: Serial number, may be queried
51087       ipaddress-v4-loopback-0:
51088         type: string
51089         description: IPV4 Loopback 0 address
51090       ipaddress-v6-loopback-0:
51091         type: string
51092         description: IPV6 Loopback 0 address
51093       ipaddress-v4-aim:
51094         type: string
51095         description: IPV4 AIM address
51096       ipaddress-v6-aim:
51097         type: string
51098         description: IPV6 AIM address
51099       ipaddress-v6-oam:
51100         type: string
51101         description: IPV6 OAM address
51102       inv-status:
51103         type: string
51104         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
51105       pserver-id:
51106         type: string
51107         description: ID of Pserver
51108       internet-topology:
51109         type: string
51110         description: internet topology of Pserver
51111       in-maint:
51112         type: boolean
51113       resource-version:
51114         type: string
51115         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51116       pserver-name2:
51117         type: string
51118         description: alternative pserver name
51119       purpose:
51120         type: string
51121         description: purpose of pserver
51122       prov-status:
51123         type: string
51124         description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
51125       relationship-list:
51126         type: array
51127         items:
51128           $ref: "#/definitions/relationship"
51129       p-interfaces:
51130         type: array
51131         items:
51132           $ref: "#/definitions/p-interface"
51133       lag-interfaces:
51134         type: array
51135         items:
51136           $ref: "#/definitions/lag-interface"
51137   pservers:
51138     description: |
51139       Collection of compute hosts.
51140     properties:
51141       pserver:
51142         type: array
51143         items:
51144           $ref: "#/definitions/pserver"
51145   query-parameters:
51146     description: |
51147       QueryParameters for performing a named-query or model query
51148     properties:
51149       named-query:
51150         type: object
51151         $ref: "#/definitions/named-query"
51152       overloaded-model:
51153         type: object
51154         $ref: "#/definitions/overloaded-model"
51155   related-lookup:
51156     description: |
51157       TBD
51158       ###### Related Nodes
51159       - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
51160     required:
51161     - related-lookup-uuid
51162     - source-node-type
51163     - source-node-property
51164     - target-node-type
51165     - target-node-property
51166     properties:
51167       related-lookup-uuid:
51168         type: string
51169       source-node-type:
51170         type: string
51171       source-node-property:
51172         type: string
51173       target-node-type:
51174         type: string
51175       target-node-property:
51176         type: string
51177       property-collect-list:
51178         type: string
51179       resource-version:
51180         type: string
51181       relationship-list:
51182         type: array
51183         items:
51184           $ref: "#/definitions/relationship"
51185   related-lookups:
51186     properties:
51187       related-lookup:
51188         type: array
51189         items:
51190           $ref: "#/definitions/related-lookup"
51191   related-to-property:
51192     properties:
51193       property-key:
51194         type: string
51195         description: Key part of a key/value pair
51196       property-value:
51197         type: string
51198         description: Value part of a key/value pair
51199   relationship:
51200     properties:
51201       related-to:
51202         type: string
51203         description: A keyword provided by A&AI to indicate type of node.
51204       related-link:
51205         type: string
51206         description: URL to the object in A&AI.
51207       relationship-data:
51208         type: array
51209         items:
51210           $ref: "#/definitions/relationship-data"
51211   relationship-data:
51212     required:
51213     - relationship-key
51214     - relationship-value
51215     properties:
51216       relationship-key:
51217         type: string
51218         description: A keyword provided by A&AI to indicate an attribute.
51219       relationship-value:
51220         type: string
51221         description: Value of the attribute.
51222   relationship-list:
51223     properties:
51224       relationship:
51225         type: array
51226         items:
51227           $ref: "#/definitions/relationship"
51228   reserved-prop-names:
51229     description: |
51230       Internal map to define some reserved properties of a vertex
51231     properties:
51232       last-mod-source-of-truth:
51233         type: string
51234       aai-node-type:
51235         type: string
51236       aai-created-ts:
51237         type: integer
51238         format: int64
51239       aai-unique-key:
51240         type: string
51241       aai-last-mod-ts:
51242         type: integer
51243         format: int64
51244       source-of-truth:
51245         type: string
51246       aai-uri:
51247         type: string
51248   response-list:
51249     description: |
51250       Response container for the results of a named-query or model query
51251     properties:
51252       inventory-response-items:
51253         type: object
51254         $ref: "#/definitions/inventory-response-items"
51255   result-data:
51256     properties:
51257       resource-type:
51258         type: string
51259         description: The specific type of node in the A&AI graph
51260       resource-link:
51261         type: string
51262         description: The URL to the specific resource
51263   route-table-reference:
51264     description: |
51265       Openstack route table reference.
51266       ###### Related Nodes
51267       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
51268     required:
51269     - route-table-reference-id
51270     - route-table-reference-fqdn
51271     properties:
51272       route-table-reference-id:
51273         type: string
51274         description: Route Table Reference id, UUID assigned to this instance.
51275       route-table-reference-fqdn:
51276         type: string
51277         description: FQDN entry in the route table.
51278       resource-version:
51279         type: string
51280         description: Concurrency value
51281       relationship-list:
51282         type: array
51283         items:
51284           $ref: "#/definitions/relationship"
51285   route-table-references:
51286     description: |
51287       Collection of openstack route table references
51288     properties:
51289       route-table-reference:
51290         type: array
51291         items:
51292           $ref: "#/definitions/route-table-reference"
51293   route-target:
51294     description: |
51295       Route target information
51296       ###### Related Nodes
51297       - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
51298     required:
51299     - global-route-target
51300     - route-target-role
51301     properties:
51302       global-route-target:
51303         type: string
51304         description: Number used to identify an RT, globally unique in the network
51305       route-target-role:
51306         type: string
51307         description: Role assigned to this route target
51308       resource-version:
51309         type: string
51310         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51311       relationship-list:
51312         type: array
51313         items:
51314           $ref: "#/definitions/relationship"
51315   route-targets:
51316     description: |
51317       Collection of route target information
51318     properties:
51319       route-target:
51320         type: array
51321         items:
51322           $ref: "#/definitions/route-target"
51323   routing-instance:
51324     description: |
51325       ###### Related Nodes
51326       - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
51327       - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
51328       - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR
51329     required:
51330     - routing-instance-id
51331     properties:
51332       routing-instance-id:
51333         type: string
51334         description: Unique id of routing instance
51335       rpm-owner:
51336         type: string
51337         description: rpm owner
51338       resource-version:
51339         type: string
51340         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51341       site-pairs:
51342         type: array
51343         items:
51344           $ref: "#/definitions/site-pair"
51345       relationship-list:
51346         type: array
51347         items:
51348           $ref: "#/definitions/relationship"
51349   routing-instances:
51350     description: |
51351       set of probes related to generic-vnf routing instance
51352     properties:
51353       routing-instance:
51354         type: array
51355         items:
51356           $ref: "#/definitions/routing-instance"
51357   sdn-zone-response:
51358     properties:
51359       oam-networks:
51360         type: object
51361         $ref: "#/definitions/oam-networks"
51362       az-and-dvs-switches:
51363         type: array
51364         items:
51365           $ref: "#/definitions/az-and-dvs-switches"
51366   search:
51367     properties:
51368       edge-tag-query-result:
51369         type: object
51370         $ref: "#/definitions/edge-tag-query-result"
51371       edge-tag-query-request:
51372         type: object
51373         $ref: "#/definitions/edge-tag-query-request"
51374       search-results:
51375         type: object
51376         $ref: "#/definitions/search-results"
51377       sdn-zone-response:
51378         type: object
51379         $ref: "#/definitions/sdn-zone-response"
51380   search-results:
51381     properties:
51382       result-data:
51383         type: array
51384         items:
51385           $ref: "#/definitions/result-data"
51386   secondary-filt:
51387     description: |
51388       SecondaryFilt for performing a named-query or model query
51389   secondary-filter:
51390     properties:
51391       property-name:
51392         type: string
51393       filter-type:
51394         type: string
51395       property-value:
51396         type: string
51397   secondary-filts:
51398     description: |
51399       SecondaryFilts for performing a named-query or model query
51400     properties:
51401       secondary-filt:
51402         type: array
51403         items:
51404           $ref: "#/definitions/secondary-filt"
51405   segmentation-assignment:
51406     description: |
51407       Openstack segmentation assignment.
51408       ###### Related Nodes
51409       - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
51410     required:
51411     - segmentation-id
51412     properties:
51413       segmentation-id:
51414         type: string
51415         description: Route Table Reference id, UUID assigned to this instance.
51416       resource-version:
51417         type: string
51418         description: Concurrency value
51419       relationship-list:
51420         type: array
51421         items:
51422           $ref: "#/definitions/relationship"
51423   segmentation-assignments:
51424     description: |
51425       Collection of openstack segmentation assignments
51426     properties:
51427       segmentation-assignment:
51428         type: array
51429         items:
51430           $ref: "#/definitions/segmentation-assignment"
51431   service:
51432     description: |
51433       Stand-in for service model definitions.  Likely to be deprecated in favor of models from ASDC.  Does not strictly map to ASDC services.
51434     required:
51435     - service-id
51436     - service-description
51437     properties:
51438       service-id:
51439         type: string
51440         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
51441       service-description:
51442         type: string
51443         description: Description of the service
51444       service-selflink:
51445         type: string
51446         description: URL to endpoint where AAI can get more details
51447       resource-version:
51448         type: string
51449         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51450       service-version:
51451         type: string
51452         description: service version
51453       relationship-list:
51454         type: array
51455         items:
51456           $ref: "#/definitions/relationship"
51457   service-capabilities:
51458     description: |
51459       Collection of service capabilities.
51460     properties:
51461       service-capability:
51462         type: array
51463         items:
51464           $ref: "#/definitions/service-capability"
51465   service-capability:
51466     description: |
51467       Early definition of server/resource pairings, likely to be replaced by models.  No new use should be made of this.
51468       ###### Related Nodes
51469       - FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
51470       - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
51471       - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK
51472     required:
51473     - service-type
51474     - vnf-type
51475     properties:
51476       service-type:
51477         type: string
51478         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
51479       vnf-type:
51480         type: string
51481         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
51482       resource-version:
51483         type: string
51484         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51485       relationship-list:
51486         type: array
51487         items:
51488           $ref: "#/definitions/relationship"
51489   service-design-and-creation:
51490     description: |
51491       Namespace for objects managed by ASDC
51492     properties:
51493       vnf-images:
51494         type: array
51495         items:
51496           $ref: "#/definitions/vnf-image"
51497       services:
51498         type: array
51499         items:
51500           $ref: "#/definitions/service"
51501       service-capabilities:
51502         type: array
51503         items:
51504           $ref: "#/definitions/service-capability"
51505       models:
51506         type: array
51507         items:
51508           $ref: "#/definitions/model"
51509       named-queries:
51510         type: array
51511         items:
51512           $ref: "#/definitions/named-query"
51513   service-instance:
51514     description: |
51515       Instance of a service
51516       ###### Related Nodes
51517       - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
51518       - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
51519       - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
51520       - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
51521       - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
51522       - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY)
51523       - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
51524       - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
51525       - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
51526       - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
51527       - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
51528       - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
51529       - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
51530       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
51531       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
51532       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
51533       - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM
51534       - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
51535     required:
51536     - service-instance-id
51537     properties:
51538       service-instance-id:
51539         type: string
51540         description: Uniquely identifies this instance of a service
51541       service-instance-name:
51542         type: string
51543         description: This field will store a name assigned to the service-instance.
51544       persona-model-id:
51545         type: string
51546         description: the ASDC model id for this resource or service model.
51547       persona-model-version:
51548         type: string
51549         description: the ASDC model version for this resource or service model.
51550       model-version-id:
51551         type: string
51552         description: the ASDC model version for this resource or service model.
51553       widget-model-id:
51554         type: string
51555         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
51556       widget-model-version:
51557         type: string
51558         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
51559       bandwidth-total:
51560         type: string
51561         description: Indicates the total bandwidth to be used for this service.
51562       bandwidth-up-wan1:
51563         type: string
51564         description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
51565       bandwidth-down-wan1:
51566         type: string
51567         description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
51568       bandwidth-up-wan2:
51569         type: string
51570         description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
51571       bandwidth-down-wan2:
51572         type: string
51573         description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
51574       vhn-portal-url:
51575         type: string
51576         description: URL customers will use to access the vHN Portal.
51577       service-instance-location-id:
51578         type: string
51579         description: An identifier that customers assign to the location where this service is being used.
51580       resource-version:
51581         type: string
51582         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51583       selflink:
51584         type: string
51585         description: Path to the controller object.
51586       orchestration-status:
51587         type: string
51588         description: Orchestration status of this service.
51589       relationship-list:
51590         type: array
51591         items:
51592           $ref: "#/definitions/relationship"
51593       metadata:
51594         type: array
51595         items:
51596           $ref: "#/definitions/metadatum"
51597       allotted-resources:
51598         type: array
51599         items:
51600           $ref: "#/definitions/allotted-resource"
51601   service-instances:
51602     description: |
51603       Collection of service instances
51604     properties:
51605       service-instance:
51606         type: array
51607         items:
51608           $ref: "#/definitions/service-instance"
51609   service-subscription:
51610     description: |
51611       Object that group service instances.
51612       ###### Related Nodes
51613       - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
51614       - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
51615       - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
51616       - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE
51617     required:
51618     - service-type
51619     properties:
51620       service-type:
51621         type: string
51622         description: Value defined by orchestration to identify this service across ECOMP.
51623       temp-ub-sub-account-id:
51624         type: string
51625         description: This property will be deleted from A&AI in the near future. Only stop gap solution.
51626       resource-version:
51627         type: string
51628         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51629       service-instances:
51630         type: array
51631         items:
51632           $ref: "#/definitions/service-instance"
51633       relationship-list:
51634         type: array
51635         items:
51636           $ref: "#/definitions/relationship"
51637   service-subscriptions:
51638     description: |
51639       Collection of objects that group service instances.
51640     properties:
51641       service-subscription:
51642         type: array
51643         items:
51644           $ref: "#/definitions/service-subscription"
51645   services:
51646     description: |
51647       Collection of service model definitions.  Likely to be deprecated in favor of models from ASDC.
51648     properties:
51649       service:
51650         type: array
51651         items:
51652           $ref: "#/definitions/service"
51653   site-pair:
51654     description: |
51655       ###### Related Nodes
51656       - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
51657       - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
51658       - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE
51659     required:
51660     - site-pair-id
51661     properties:
51662       site-pair-id:
51663         type: string
51664         description: unique identifier of probe
51665       source-ip:
51666         type: string
51667         description: Prefix address
51668       destination-ip:
51669         type: string
51670         description: Prefix address
51671       ip-version:
51672         type: string
51673         description: ip version, v4, v6
51674       destination-hostname:
51675         type: string
51676         description: Hostname of the destination equipment to which SLAs are measured against.
51677       destination-equip-type:
51678         type: string
51679         description: The type of destinatination equipment. Could be Router, etc.
51680       resource-version:
51681         type: string
51682         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51683       classes-of-service:
51684         type: array
51685         items:
51686           $ref: "#/definitions/class-of-service"
51687       relationship-list:
51688         type: array
51689         items:
51690           $ref: "#/definitions/relationship"
51691   site-pair-set:
51692     description: |
51693       Set of instances for probes used to measure service level agreements
51694       ###### Related Nodes
51695       - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
51696       - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
51697       - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE
51698     required:
51699     - site-pair-set-id
51700     properties:
51701       site-pair-set-id:
51702         type: string
51703         description: Unique id of site pair set.
51704       resource-version:
51705         type: string
51706         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51707       routing-instances:
51708         type: array
51709         items:
51710           $ref: "#/definitions/routing-instance"
51711       relationship-list:
51712         type: array
51713         items:
51714           $ref: "#/definitions/relationship"
51715   site-pair-sets:
51716     description: |
51717       Collection of sets of instances for probes related to generic-vnf
51718     properties:
51719       site-pair-set:
51720         type: array
51721         items:
51722           $ref: "#/definitions/site-pair-set"
51723   site-pairs:
51724     description: |
51725       probe within a set
51726     properties:
51727       site-pair:
51728         type: array
51729         items:
51730           $ref: "#/definitions/site-pair"
51731   snapshot:
51732     description: |
51733       Openstack snapshot
51734       ###### Related Nodes
51735       - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
51736       - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
51737     required:
51738     - snapshot-id
51739     properties:
51740       snapshot-id:
51741         type: string
51742         description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
51743       snapshot-name:
51744         type: string
51745         description: Snapshot name
51746       snapshot-architecture:
51747         type: string
51748         description: Operating system architecture
51749       snapshot-os-distro:
51750         type: string
51751         description: The common name of the operating system distribution in lowercase
51752       snapshot-os-version:
51753         type: string
51754         description: The operating system version as specified by the distributor.
51755       application:
51756         type: string
51757         description: The application that the image instantiates.
51758       application-vendor:
51759         type: string
51760         description: The vendor of the application.
51761       application-version:
51762         type: string
51763         description: The version of the application.
51764       snapshot-selflink:
51765         type: string
51766         description: URL to endpoint where AAI can get more details
51767       prev-snapshot-id:
51768         type: string
51769         description: This field contains the UUID of the previous snapshot (if any).
51770       resource-version:
51771         type: string
51772         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51773       relationship-list:
51774         type: array
51775         items:
51776           $ref: "#/definitions/relationship"
51777   snapshots:
51778     description: |
51779       Collection of openstack snapshots
51780     properties:
51781       snapshot:
51782         type: array
51783         items:
51784           $ref: "#/definitions/snapshot"
51785   sriov-pf:
51786     description: |
51787       SR-IOV Physical Function
51788       ###### Related Nodes
51789       - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
51790       - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
51791     required:
51792     - pf-pci-id
51793     properties:
51794       pf-pci-id:
51795         type: string
51796         description: Identifier for the sriov-pf
51797       resource-version:
51798         type: string
51799         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51800       relationship-list:
51801         type: array
51802         items:
51803           $ref: "#/definitions/relationship"
51804   sriov-pfs:
51805     description: |
51806       Collection of SR-IOV Physical Functions.
51807     properties:
51808       sriov-pf:
51809         type: array
51810         items:
51811           $ref: "#/definitions/sriov-pf"
51812   sriov-vf:
51813     description: |
51814       SR-IOV Virtual Function (not to be confused with virtual network function)
51815       ###### Related Nodes
51816       - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
51817     required:
51818     - pci-id
51819     properties:
51820       pci-id:
51821         type: string
51822         description: PCI ID used to identify the sriov-vf
51823       vf-vlan-filter:
51824         type: string
51825         description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
51826       vf-mac-filter:
51827         type: string
51828         description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
51829       vf-vlan-strip:
51830         type: boolean
51831         description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
51832       vf-vlan-anti-spoof-check:
51833         type: boolean
51834         description: This option ensures anti VLAN spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.
51835       vf-mac-anti-spoof-check:
51836         type: boolean
51837         description: This option ensures anti MAC spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.
51838       vf-mirrors:
51839         type: string
51840         description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
51841       vf-broadcast-allow:
51842         type: boolean
51843         description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
51844       vf-unknown-multicast-allow:
51845         type: boolean
51846         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
51847       vf-unknown-unicast-allow:
51848         type: boolean
51849         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
51850       vf-insert-stag:
51851         type: boolean
51852         description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
51853       vf-link-status:
51854         type: string
51855         description: This option is used to set the link status.  Valid values as of 1607 are on, off, and auto.
51856       resource-version:
51857         type: string
51858         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51859       neutron-network-id:
51860         type: string
51861         description: Neutron network id of the interface
51862       relationship-list:
51863         type: array
51864         items:
51865           $ref: "#/definitions/relationship"
51866   sriov-vfs:
51867     description: |
51868       Collection of SR-IOV Virtual Functions.
51869     properties:
51870       sriov-vf:
51871         type: array
51872         items:
51873           $ref: "#/definitions/sriov-vf"
51874   start-node-filter:
51875     properties:
51876       property-name:
51877         type: string
51878       property-value:
51879         type: string
51880   subnet:
51881     description: |
51882       ###### Related Nodes
51883       - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
51884       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
51885       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
51886       - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
51887     required:
51888     - subnet-id
51889     - dhcp-enabled
51890     properties:
51891       subnet-id:
51892         type: string
51893         description: Subnet ID, should be UUID.
51894       subnet-name:
51895         type: string
51896         description: Name associated with the subnet.
51897       neutron-subnet-id:
51898         type: string
51899         description: Neutron id of this subnet
51900       gateway-address:
51901         type: string
51902         description: gateway ip address
51903       network-start-address:
51904         type: string
51905         description: network start address
51906       cidr-mask:
51907         type: string
51908         description: cidr mask
51909       ip-version:
51910         type: string
51911         description: ip version
51912       orchestration-status:
51913         type: string
51914         description: Orchestration status of this VNF, mastered by MSO
51915       dhcp-enabled:
51916         type: boolean
51917       dhcp-start:
51918         type: string
51919         description: the start address reserved for use by dhcp
51920       dhcp-end:
51921         type: string
51922         description: the last address reserved for use by dhcp
51923       resource-version:
51924         type: string
51925         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51926       relationship-list:
51927         type: array
51928         items:
51929           $ref: "#/definitions/relationship"
51930   subnets:
51931     properties:
51932       subnet:
51933         type: array
51934         items:
51935           $ref: "#/definitions/subnet"
51936   tagged-inventory-item-list:
51937     properties:
51938       inventory-item:
51939         type: array
51940         items:
51941           $ref: "#/definitions/inventory-item"
51942   tenant:
51943     description: |
51944       Openstack tenant
51945       ###### Related Nodes
51946       - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
51947       - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
51948       - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
51949       - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
51950       - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
51951       - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
51952       - TENANT cannot be deleted if linked to VSERVER
51953     required:
51954     - tenant-id
51955     - tenant-name
51956     properties:
51957       tenant-id:
51958         type: string
51959         description: Unique id relative to the cloud-region.
51960       tenant-name:
51961         type: string
51962         description: Readable name of tenant
51963       resource-version:
51964         type: string
51965         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51966       vservers:
51967         type: array
51968         items:
51969           $ref: "#/definitions/vserver"
51970       relationship-list:
51971         type: array
51972         items:
51973           $ref: "#/definitions/relationship"
51974   tenants:
51975     description: |
51976       Collection of openstack tenants.
51977     properties:
51978       tenant:
51979         type: array
51980         items:
51981           $ref: "#/definitions/tenant"
51982   tunnel-xconnect:
51983     description: |
51984       Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
51985       ###### Related Nodes
51986       - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
51987     required:
51988     - id
51989     - bandwidth-up-wan1
51990     - bandwidth-down-wan1
51991     - bandwidth-up-wan2
51992     - bandwidth-down-wan2
51993     properties:
51994       id:
51995         type: string
51996         description: Allotted Resource id UUID assigned to this instance.
51997       bandwidth-up-wan1:
51998         type: string
51999         description: The WAN uplink bandwidth for WAN1
52000       bandwidth-down-wan1:
52001         type: string
52002         description: The WAN downlink bandwidth for WAN1
52003       bandwidth-up-wan2:
52004         type: string
52005         description: The WAN uplink bandwidth for WAN2
52006       bandwidth-down-wan2:
52007         type: string
52008         description: The WAN downlink bandwidth for WAN2
52009       resource-version:
52010         type: string
52011         description: Concurrency value
52012       relationship-list:
52013         type: array
52014         items:
52015           $ref: "#/definitions/relationship"
52016   tunnel-xconnects:
52017     description: |
52018       This object is used to store the specific tunnel cross connect aspects of an allotted resource
52019     properties:
52020       tunnel-xconnect:
52021         type: array
52022         items:
52023           $ref: "#/definitions/tunnel-xconnect"
52024   update:
52025     description: |
52026       Serves a PATCH like function.  Does not enforce concurrency control.  Clear each usage with AAI team.
52027     required:
52028     - update-node-type
52029     properties:
52030       update-node-type:
52031         type: string
52032       update-node-key:
52033         type: array
52034         items:
52035           $ref: "#/definitions/update-node-key"
52036       update-node-uri:
52037         type: string
52038       action:
52039         type: array
52040         items:
52041           $ref: "#/definitions/action"
52042   update-node-key:
52043     properties:
52044       key-name:
52045         type: string
52046       key-value:
52047         type: string
52048   vce:
52049     description: |
52050       Virtual Customer Edge Router, used specifically for Gamma.  This object is deprecated.
52051       ###### Related Nodes
52052       - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
52053       - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
52054       - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY)
52055       - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
52056       - FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
52057       - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
52058       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
52059       - VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP
52060     required:
52061     - vnf-id
52062     - vnf-name
52063     - vnf-type
52064     properties:
52065       vnf-id:
52066         type: string
52067         description: Unique id of VNF.  This is unique across the graph.
52068       vnf-name:
52069         type: string
52070         description: Name of VNF.
52071       vnf-name2:
52072         type: string
52073         description: Alternate name of VNF.
52074       vnf-type:
52075         type: string
52076         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
52077       service-id:
52078         type: string
52079         description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
52080       regional-resource-zone:
52081         type: string
52082         description: Regional way of organizing pservers, source of truth should define values
52083       prov-status:
52084         type: string
52085         description: Trigger for operational monitoring of this resource by Service Assurance systems.
52086       operational-state:
52087         type: string
52088         description: Indicator for whether the resource is considered operational
52089       license-key:
52090         type: string
52091         description: OBSOLETE -  do not use
52092       equipment-role:
52093         type: string
52094         description: Network role being played by this VNF
52095       orchestration-status:
52096         type: string
52097         description: Orchestration status of this VNF, mastered by MSO
52098       heat-stack-id:
52099         type: string
52100         description: Heat stack id corresponding to this instance, managed by MSO
52101       mso-catalog-key:
52102         type: string
52103         description: Corresponds to the SDN-C catalog id used to configure this VCE
52104       vpe-id:
52105         type: string
52106         description: Unique ID of VPE connected to this VCE.
52107       v6-vce-wan-address:
52108         type: string
52109         description: Valid v6 IP address for the WAN Link on this router.  Implied length of /64.
52110       ipv4-oam-address:
52111         type: string
52112         description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
52113       resource-version:
52114         type: string
52115         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52116       ipv4-loopback0-address:
52117         type: string
52118         description: Loopback0 address
52119       entitlement-resource-uuid:
52120         type: string
52121         description: OBSOLETE -  see child relationships
52122       port-groups:
52123         type: array
52124         items:
52125           $ref: "#/definitions/port-group"
52126       licenses:
52127         type: array
52128         items:
52129           $ref: "#/definitions/license"
52130       entitlements:
52131         type: array
52132         items:
52133           $ref: "#/definitions/entitlement"
52134       relationship-list:
52135         type: array
52136         items:
52137           $ref: "#/definitions/relationship"
52138   vces:
52139     description: |
52140       Collection of Virtual Customer Edge Routers, used specifically for Gamma.  This object is deprecated.
52141     properties:
52142       vce:
52143         type: array
52144         items:
52145           $ref: "#/definitions/vce"
52146   vf-module:
52147     description: |
52148       a deployment unit of VNFCs
52149       ###### Related Nodes
52150       - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
52151       - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
52152       - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
52153       - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
52154       - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
52155       - VF-MODULE cannot be deleted if linked to VNFC
52156     required:
52157     - vf-module-id
52158     - is-base-vf-module
52159     properties:
52160       vf-module-id:
52161         type: string
52162         description: Unique ID of vf-module.
52163       vf-module-name:
52164         type: string
52165         description: Name of vf-module
52166       heat-stack-id:
52167         type: string
52168         description: Heat stack id corresponding to this instance.
52169       orchestration-status:
52170         type: string
52171         description: orchestration status of this vf-module, mastered by MSO
52172       is-base-vf-module:
52173         type: boolean
52174       resource-version:
52175         type: string
52176         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52177       persona-model-id:
52178         type: string
52179         description: the ASDC model id for this resource or service model.
52180       persona-model-version:
52181         type: string
52182         description: the ASDC model version for this resource or service model.
52183       model-version-id:
52184         type: string
52185         description: the ASDC model version for this resource or service model.
52186       persona-model-customization-id:
52187         type: string
52188         description: captures the id of all the configuration used to customize the resource for the service.
52189       widget-model-id:
52190         type: string
52191         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
52192       widget-model-version:
52193         type: string
52194         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
52195       contrail-service-instance-fqdn:
52196         type: string
52197         description: the Contrail unique ID for a service-instance
52198       module-index:
52199         type: integer
52200         format: int32
52201         description: the index will track the number of modules of a given type that have been deployed in a VNF, starting with 0, and always choosing the lowest available digit
52202       selflink:
52203         type: string
52204         description: Path to the controller object.
52205       relationship-list:
52206         type: array
52207         items:
52208           $ref: "#/definitions/relationship"
52209   vf-modules:
52210     description: |
52211       Collection of vf-modules, a deployment unit of VNFCs
52212     properties:
52213       vf-module:
52214         type: array
52215         items:
52216           $ref: "#/definitions/vf-module"
52217   vig-server:
52218     description: |
52219       vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
52220       ###### Related Nodes
52221       - TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
52222     required:
52223     - vig-address-type
52224     properties:
52225       vig-address-type:
52226         type: string
52227         description: indicates whether the VIG is for AVPN or INTERNET
52228       ipaddress-v4-vig:
52229         type: string
52230         description: v4 IP of the vig server
52231       ipaddress-v6-vig:
52232         type: string
52233         description: v6 IP of the vig server
52234       resource-version:
52235         type: string
52236         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52237       relationship-list:
52238         type: array
52239         items:
52240           $ref: "#/definitions/relationship"
52241   vig-servers:
52242     properties:
52243       vig-server:
52244         type: array
52245         items:
52246           $ref: "#/definitions/vig-server"
52247   vip-ipv4-address-list:
52248     description: |
52249       IPv4 Address Range
52250       ###### Related Nodes
52251       - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52252       - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
52253       - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
52254       - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
52255     required:
52256     - vip-ipv4-address
52257     properties:
52258       vip-ipv4-address:
52259         type: string
52260         description: IP address
52261       vip-ipv4-prefix-length:
52262         type: integer
52263         format: int64
52264         description: Prefix length, 32 for single address
52265       vlan-id-inner:
52266         type: integer
52267         format: int64
52268         description: Inner VLAN tag
52269       vlan-id-outer:
52270         type: integer
52271         format: int64
52272         description: Outer VLAN tag
52273       is-floating:
52274         type: boolean
52275         description: Indicator of fixed or floating address
52276       resource-version:
52277         type: string
52278         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52279       neutron-network-id:
52280         type: string
52281         description: Neutron network id of the interface that address belongs to
52282       neutron-subnet-id:
52283         type: string
52284         description: Neutron id of subnet that address belongs to
52285       relationship-list:
52286         type: array
52287         items:
52288           $ref: "#/definitions/relationship"
52289   vip-ipv6-address-list:
52290     description: |
52291       IPv6 Address Range
52292       ###### Related Nodes
52293       - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52294       - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
52295       - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
52296       - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
52297     required:
52298     - vip-ipv6-address
52299     properties:
52300       vip-ipv6-address:
52301         type: string
52302         description: IP address
52303       vip-ipv6-prefix-length:
52304         type: integer
52305         format: int64
52306         description: Prefix length, 128 for single address
52307       vlan-id-inner:
52308         type: integer
52309         format: int64
52310         description: Inner VLAN tag
52311       vlan-id-outer:
52312         type: integer
52313         format: int64
52314         description: Outer VLAN tag
52315       is-floating:
52316         type: boolean
52317         description: Indicator of fixed or floating address
52318       resource-version:
52319         type: string
52320         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52321       neutron-network-id:
52322         type: string
52323         description: Neutron network id of the interface that address belongs to
52324       neutron-subnet-id:
52325         type: string
52326         description: Neutron id of subnet that address belongs to
52327       relationship-list:
52328         type: array
52329         items:
52330           $ref: "#/definitions/relationship"
52331   virtual-data-center:
52332     description: |
52333       Virtual organization of cloud infrastructure elements in a data center context
52334       ###### Related Nodes
52335       - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
52336       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
52337       - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
52338     required:
52339     - vdc-id
52340     - vdc-name
52341     properties:
52342       vdc-id:
52343         type: string
52344         description: Unique ID of the vdc
52345       vdc-name:
52346         type: string
52347         description: Name of the virtual data center
52348       resource-version:
52349         type: string
52350         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52351       relationship-list:
52352         type: array
52353         items:
52354           $ref: "#/definitions/relationship"
52355   virtual-data-centers:
52356     description: |
52357       Virtual organization of cloud infrastructure elements in a data center context
52358     properties:
52359       virtual-data-center:
52360         type: array
52361         items:
52362           $ref: "#/definitions/virtual-data-center"
52363   vlan:
52364     description: |
52365       Definition of vlan
52366       ###### Related Nodes
52367       - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
52368       - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
52369       - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
52370       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
52371       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
52372       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
52373       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
52374       - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
52375       - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK
52376     required:
52377     - vlan-interface
52378     properties:
52379       vlan-interface:
52380         type: string
52381         description: String that identifies the interface
52382       vlan-id-inner:
52383         type: integer
52384         format: int64
52385         description: Inner VLAN tag
52386       vlan-id-outer:
52387         type: integer
52388         format: int64
52389         description: Outer VLAN tag
52390       resource-version:
52391         type: string
52392         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52393       speed-value:
52394         type: string
52395         description: Captures the numeric part of the speed
52396       speed-units:
52397         type: string
52398         description: Captures the units corresponding to the speed
52399       vlan-description:
52400         type: string
52401         description: Used to describe (the service associated with) the vlan
52402       backdoor-connection:
52403         type: string
52404         description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
52405       vpn-id:
52406         type: string
52407         description: This indicates the customers VPN ID associated with this vlan
52408       orchestration-status:
52409         type: string
52410         description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.
52411       relationship-list:
52412         type: array
52413         items:
52414           $ref: "#/definitions/relationship"
52415       l3-interface-ipv4-address-list:
52416         type: array
52417         items:
52418           $ref: "#/definitions/l3-interface-ipv4-address-list"
52419       l3-interface-ipv6-address-list:
52420         type: array
52421         items:
52422           $ref: "#/definitions/l3-interface-ipv6-address-list"
52423   vlans:
52424     properties:
52425       vlan:
52426         type: array
52427         items:
52428           $ref: "#/definitions/vlan"
52429   vnf:
52430     description: |
52431       Abstract vnf class
52432     required:
52433     - vnf-id
52434     properties:
52435       vnf-id:
52436         type: string
52437         description: Unique id of VNF.  This is unique across the graph.
52438   vnf-image:
52439     description: |
52440       Image object that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
52441       ###### Related Nodes
52442       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
52443       - VNF-IMAGE cannot be deleted if linked to GENERIC-VNF
52444     required:
52445     - vnf-image-uuid
52446     - application
52447     - application-vendor
52448     properties:
52449       vnf-image-uuid:
52450         type: string
52451         description: Unique ID of this asset
52452       application:
52453         type: string
52454         description: The application that the image instantiates.
52455       application-vendor:
52456         type: string
52457         description: The vendor of the application.
52458       application-version:
52459         type: string
52460         description: The version of the application.
52461       selflink:
52462         type: string
52463         description: URL to endpoint where AAI can get more details
52464       resource-version:
52465         type: string
52466         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52467       relationship-list:
52468         type: array
52469         items:
52470           $ref: "#/definitions/relationship"
52471   vnf-images:
52472     description: |
52473       Collection of image objects that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
52474     properties:
52475       vnf-image:
52476         type: array
52477         items:
52478           $ref: "#/definitions/vnf-image"
52479   vnfc:
52480     description: |
52481       ###### Related Nodes
52482       - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
52483       - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
52484       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
52485     required:
52486     - vnfc-name
52487     - vnfc-function-code
52488     - vnfc-type
52489     - in-maint
52490     - is-closed-loop-disabled
52491     properties:
52492       vnfc-name:
52493         type: string
52494         description: Unique ID of vnfc.
52495       vnfc-function-code:
52496         type: string
52497         description: function code
52498       vnfc-type:
52499         type: string
52500         description: type
52501       prov-status:
52502         type: string
52503         description: prov status of this vnfc
52504       orchestration-status:
52505         type: string
52506         description: Orchestration status of this VNF, mastered by APP-C
52507       ipaddress-v4-oam-vip:
52508         type: string
52509         description: Oam V4 vip address of this vnfc
52510       in-maint:
52511         type: boolean
52512       is-closed-loop-disabled:
52513         type: boolean
52514       group-notation:
52515         type: string
52516         description: Group notation of VNFC
52517       resource-version:
52518         type: string
52519         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52520       relationship-list:
52521         type: array
52522         items:
52523           $ref: "#/definitions/relationship"
52524   vnfcs:
52525     description: |
52526       virtual network components associated with a vserver from application controller.
52527     properties:
52528       vnfc:
52529         type: array
52530         items:
52531           $ref: "#/definitions/vnfc"
52532   volume:
52533     description: |
52534       Ephemeral Block storage volume.
52535       ###### Related Nodes
52536       - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume)
52537     required:
52538     - volume-id
52539     - volume-selflink
52540     properties:
52541       volume-id:
52542         type: string
52543         description: Unique ID of block storage volume relative to the vserver.
52544       volume-selflink:
52545         type: string
52546         description: URL to endpoint where AAI can get more details
52547       resource-version:
52548         type: string
52549         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52550       relationship-list:
52551         type: array
52552         items:
52553           $ref: "#/definitions/relationship"
52554   volume-group:
52555     description: |
52556       Persistent block-level storage.
52557       ###### Related Nodes
52558       - TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52559       - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52560       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
52561       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
52562       - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
52563     required:
52564     - volume-group-id
52565     - volume-group-name
52566     - vnf-type
52567     properties:
52568       volume-group-id:
52569         type: string
52570         description: Unique ID of volume-group.
52571       volume-group-name:
52572         type: string
52573         description: Name of the volume group.
52574       heat-stack-id:
52575         type: string
52576         description: Heat stack id corresponding to this volume-group
52577       vnf-type:
52578         type: string
52579         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
52580       orchestration-status:
52581         type: string
52582         description: Orchestration status of this volume-group
52583       persona-model-customization-id:
52584         type: string
52585         description: captures the id of all the configuration used to customize the resource for the service.
52586       vf-module-persona-model-customization-id:
52587         type: string
52588         description: helps relate the volume group to the vf-module whose components will require the volume group
52589       resource-version:
52590         type: string
52591         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52592       relationship-list:
52593         type: array
52594         items:
52595           $ref: "#/definitions/relationship"
52596   volume-groups:
52597     description: |
52598       Collection of persistent block-level storage.
52599     properties:
52600       volume-group:
52601         type: array
52602         items:
52603           $ref: "#/definitions/volume-group"
52604   volumes:
52605     description: |
52606       Collection of ephemeral Block storage volumes.
52607     properties:
52608       volume:
52609         type: array
52610         items:
52611           $ref: "#/definitions/volume"
52612   vpls-pe:
52613     description: |
52614       VPLS Provider Edge routers.
52615       ###### Related Nodes
52616       - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52617       - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
52618       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
52619       - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
52620       - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
52621     required:
52622     - equipment-name
52623     properties:
52624       equipment-name:
52625         type: string
52626       prov-status:
52627         type: string
52628         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
52629       ipv4-oam-address:
52630         type: string
52631         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by VPE (v4-loopback0-ip-address).
52632       equipment-role:
52633         type: string
52634         description: Client should send valid enumerated value, e.g., VPLS-PE.
52635       vlan-id-outer:
52636         type: integer
52637         format: int64
52638         description: Temporary location for stag to get to VCE
52639       resource-version:
52640         type: string
52641         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52642       relationship-list:
52643         type: array
52644         items:
52645           $ref: "#/definitions/relationship"
52646       p-interfaces:
52647         type: array
52648         items:
52649           $ref: "#/definitions/p-interface"
52650       lag-interfaces:
52651         type: array
52652         items:
52653           $ref: "#/definitions/lag-interface"
52654   vpls-pes:
52655     description: |
52656       Collection of VPLS Provider Edge routers
52657     properties:
52658       vpls-pe:
52659         type: array
52660         items:
52661           $ref: "#/definitions/vpls-pe"
52662   vpn-binding:
52663     description: |
52664       VPN binding
52665       ###### Related Nodes
52666       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
52667       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
52668       - VPN-BINDING cannot be deleted if linked to L3-NETWORK,LOGICAL-LINK
52669     required:
52670     - vpn-id
52671     - vpn-name
52672     - global-route-target
52673     - route-target-role
52674     properties:
52675       vpn-id:
52676         type: string
52677         description: VPN ID, globally unique within A&AI
52678       vpn-name:
52679         type: string
52680         description: VPN Name
52681       global-route-target:
52682         type: string
52683         description: Number used to identify a VPN, globally unique in the network
52684       vpn-platform:
52685         type: string
52686         description: the platform associated with the VPN example AVPN, Mobility
52687       vpn-type:
52688         type: string
52689         description: Type of the vpn, should be taken from enumerated/valid values
52690       route-distinguisher:
52691         type: string
52692         description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
52693       route-target-role:
52694         type: string
52695         description: Role assigned to this route target
52696       resource-version:
52697         type: string
52698         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52699       relationship-list:
52700         type: array
52701         items:
52702           $ref: "#/definitions/relationship"
52703         description: l3-networks relate to vpn-bindings
52704   vpn-bindings:
52705     properties:
52706       vpn-binding:
52707         type: array
52708         items:
52709           $ref: "#/definitions/vpn-binding"
52710   vserver:
52711     description: |
52712       Virtual Servers, aka virtual machine or VM.
52713       ###### Related Nodes
52714       - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
52715       - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
52716       - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
52717       - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
52718       - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
52719       - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY)
52720       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
52721       - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY)
52722       - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
52723       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
52724       - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
52725       - VSERVER is DELETED when these are DELETED L-INTERFACE
52726       - VSERVER deletion means associated objects of these types are also DELETED:VOLUME
52727     required:
52728     - vserver-id
52729     - vserver-name
52730     - vserver-selflink
52731     - in-maint
52732     - is-closed-loop-disabled
52733     properties:
52734       vserver-id:
52735         type: string
52736         description: Unique identifier for this vserver relative to its tenant
52737       vserver-name:
52738         type: string
52739         description: Name of vserver
52740       vserver-name2:
52741         type: string
52742         description: Alternative name of vserver
52743       prov-status:
52744         type: string
52745         description: Trigger for operational monitoring of this resource by Service Assurance systems.
52746       vserver-selflink:
52747         type: string
52748         description: URL to endpoint where AAI can get more details
52749       in-maint:
52750         type: boolean
52751       is-closed-loop-disabled:
52752         type: boolean
52753       resource-version:
52754         type: string
52755         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52756       volumes:
52757         type: array
52758         items:
52759           $ref: "#/definitions/volume"
52760       relationship-list:
52761         type: array
52762         items:
52763           $ref: "#/definitions/relationship"
52764       l-interfaces:
52765         type: array
52766         items:
52767           $ref: "#/definitions/l-interface"
52768   vservers:
52769     description: |
52770       Collection of virtual Servers, aka virtual machines or VMs.
52771     properties:
52772       vserver:
52773         type: array
52774         items:
52775           $ref: "#/definitions/vserver"
52776   zone:
52777     description: |
52778       A zone is a grouping of assets in a location homing to the same connections into the CBB
52779       ###### Related Nodes
52780       - TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52781       - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
52782       - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
52783       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
52784     required:
52785     - zone-id
52786     - zone-name
52787     - design-type
52788     - zone-context
52789     properties:
52790       zone-id:
52791         type: string
52792         description: Code assigned by AIC to the zone
52793       zone-name:
52794         type: string
52795         description: English name associated with the zone
52796       design-type:
52797         type: string
52798         description: Design of zone [Medium/Large?]
52799       zone-context:
52800         type: string
52801         description: Context of zone [production/test]
52802       status:
52803         type: string
52804         description: Status of a zone.
52805       resource-version:
52806         type: string
52807         description: Concurrency value
52808       relationship-list:
52809         type: array
52810         items:
52811           $ref: "#/definitions/relationship"
52812   zones:
52813     description: |
52814       Collection of zones
52815     properties:
52816       zone:
52817         type: array
52818         items:
52819           $ref: "#/definitions/zone"
52820 patchDefinitions:
52821   aai-internal:
52822     properties:
52823       property-name:
52824         type: string
52825       property-value:
52826         type: string
52827   action:
52828     properties:
52829       action-type:
52830         type: string
52831       action-data:
52832         type: array
52833         items:
52834           $ref: "#/patchDefinitions/action-data"
52835   action-data:
52836     properties:
52837       property-name:
52838         type: string
52839       property-value:
52840         type: string
52841   actions:
52842     description: |
52843       APIs that are more action related than REST (e.g., notify, update).
52844     properties:
52845       update:
52846         type: object
52847         $ref: "#/patchDefinitions/update"
52848       notify:
52849         type: object
52850         $ref: "#/patchDefinitions/notify"
52851   allotted-resource:
52852     description: |
52853       Represents a slice or partial piece of a resource that gets separately allotted
52854       ###### Related Nodes
52855       - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
52856       - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
52857       - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
52858       - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
52859       - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
52860       - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
52861       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
52862       - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT
52863     required:
52864     - id
52865     properties:
52866       id:
52867         type: string
52868         description: Allotted Resource id UUID assigned to this instance.
52869       description:
52870         type: string
52871         description: The descriptive information assigned to this allotted resource instance
52872       selflink:
52873         type: string
52874         description: Link back to more information in the controller
52875       persona-model-id:
52876         type: string
52877         description: the ASDC model id for this resource or service model.
52878       persona-model-version:
52879         type: string
52880         description: the ASDC model version for this resource or service model.
52881       model-version-id:
52882         type: string
52883         description: the ASDC model version for this resource or service model.
52884       persona-model-customization-id:
52885         type: string
52886         description: captures the id of all the configuration used to customize the resource for the service.
52887   allotted-resources:
52888     description: |
52889       This object is used to store slices of services being offered
52890     properties:
52891       allotted-resource:
52892         type: array
52893         items:
52894           $ref: "#/patchDefinitions/allotted-resource"
52895   availability-zone:
52896     description: |
52897       Availability zone, a collection of compute hosts/pservers
52898       ###### Related Nodes
52899       - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52900       - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
52901       - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52902       - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
52903       - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
52904       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
52905       - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
52906       - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
52907       - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
52908     required:
52909     - availability-zone-name
52910     - hypervisor-type
52911     properties:
52912       availability-zone-name:
52913         type: string
52914         description: Name of the availability zone.  Unique across a cloud region
52915       hypervisor-type:
52916         type: string
52917         description: Type of hypervisor.  Source of truth should define valid values.
52918       operational-state:
52919         type: string
52920         description: State that indicates whether the availability zone should be used, etc.  Source of truth should define valid values.
52921   availability-zones:
52922     description: |
52923       Collection of availability zones
52924     properties:
52925       availability-zone:
52926         type: array
52927         items:
52928           $ref: "#/patchDefinitions/availability-zone"
52929   az-and-dvs-switches:
52930     properties:
52931       dvs-switches:
52932         type: object
52933         $ref: "#/patchDefinitions/dvs-switches"
52934       availability-zone:
52935         type: object
52936         $ref: "#/patchDefinitions/availability-zone"
52937   business:
52938     description: |
52939       Namespace for business related constructs
52940     properties:
52941       connectors:
52942         type: array
52943         items:
52944           $ref: "#/patchDefinitions/connector"
52945       customers:
52946         type: array
52947         items:
52948           $ref: "#/patchDefinitions/customer"
52949   class-of-service:
52950     description: |
52951       ###### Related Nodes
52952       - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
52953     required:
52954     - cos
52955     properties:
52956       cos:
52957         type: string
52958         description: unique identifier of probe
52959       probe-id:
52960         type: string
52961         description: identifier of probe
52962       probe-type:
52963         type: string
52964         description: type of probe
52965   classes-of-service:
52966     description: |
52967       class-of-service of probe
52968     properties:
52969       class-of-service:
52970         type: array
52971         items:
52972           $ref: "#/patchDefinitions/class-of-service"
52973   cloud-infrastructure:
52974     description: |
52975       Namespace for cloud infrastructure.
52976     properties:
52977       complexes:
52978         type: array
52979         items:
52980           $ref: "#/patchDefinitions/complex"
52981       cloud-regions:
52982         type: array
52983         items:
52984           $ref: "#/patchDefinitions/cloud-region"
52985       network-profiles:
52986         type: array
52987         items:
52988           $ref: "#/patchDefinitions/network-profile"
52989       pservers:
52990         type: array
52991         items:
52992           $ref: "#/patchDefinitions/pserver"
52993       virtual-data-centers:
52994         type: array
52995         items:
52996           $ref: "#/patchDefinitions/virtual-data-center"
52997   cloud-region:
52998     description: |
52999       cloud-region designates an installation of a cloud cluster or region or instantiation.
53000       ###### Related Nodes
53001       - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
53002       - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
53003       - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
53004       - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53005       - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53006       - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53007       - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53008       - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53009       - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53010       - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53011       - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53012       - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53013       - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
53014       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
53015       - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP
53016       - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
53017     required:
53018     - cloud-owner
53019     - cloud-region-id
53020     properties:
53021       cloud-owner:
53022         type: string
53023         description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
53024       cloud-region-id:
53025         type: string
53026         description: Identifier used by the vendor for the region. Second part of composite key
53027       cloud-type:
53028         type: string
53029         description: Type of the cloud (e.g., openstack)
53030       owner-defined-type:
53031         type: string
53032         description: Cloud-owner defined type indicator (e.g., dcp, lcp)
53033       cloud-region-version:
53034         type: string
53035         description: Software version employed at the site.  NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
53036       identity-url:
53037         type: string
53038         description: URL of the keystone identity service
53039       cloud-zone:
53040         type: string
53041         description: Zone where the cloud is homed.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
53042       complex-name:
53043         type: string
53044         description: complex name for cloud-region instance.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
53045   cloud-regions:
53046     properties:
53047       cloud-region:
53048         type: array
53049         items:
53050           $ref: "#/patchDefinitions/cloud-region"
53051   complex:
53052     description: |
53053       Collection of physical locations that can house cloud-regions.
53054       ###### Related Nodes
53055       - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
53056       - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
53057       - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
53058       - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
53059       - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
53060       - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
53061       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
53062       - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
53063       - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
53064       - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
53065       - FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
53066       - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
53067       - COMPLEX is DELETED when these are DELETED CTAG-POOL
53068     required:
53069     - physical-location-id
53070     - physical-location-type
53071     - street1
53072     - city
53073     - postal-code
53074     - country
53075     - region
53076     properties:
53077       physical-location-id:
53078         type: string
53079         description: Unique identifier for physical location, e.g., CLLI
53080       data-center-code:
53081         type: string
53082         description: Data center code which can be an alternate way to identify a complex
53083       complex-name:
53084         type: string
53085         description: Gamma complex name for LCP instance.
53086       identity-url:
53087         type: string
53088         description: URL of the keystone identity service
53089   complexes:
53090     description: |
53091       Collection of physical locations that can house cloud-regions.
53092     properties:
53093       complex:
53094         type: array
53095         items:
53096           $ref: "#/patchDefinitions/complex"
53097   configuration:
53098     description: |
53099       Port Mirror Configuration.
53100       ###### Related Nodes
53101       - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
53102       - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
53103       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
53104       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
53105       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
53106       - CONFIGURATION is DELETED when these are DELETED METADATUM
53107       - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
53108     required:
53109     - configuration-id
53110     - configuration-type
53111     - configuration-sub-type
53112     - orchestration-status
53113     - operational-status
53114     - configuration-selflink
53115     - model-customization-id
53116     properties:
53117       configuration-id:
53118         type: string
53119         description: UUID assigned to configuration.
53120       management-option:
53121         type: string
53122         description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
53123       configuration-name:
53124         type: string
53125         description: Name of the configuration.
53126       configuration-type:
53127         type: string
53128         description: port-mirroring-configuration.
53129       configuration-sub-type:
53130         type: string
53131         description: vprobe, pprobe.
53132       model-invariant-id:
53133         type: string
53134         description: the ASDC model id for this resource or service model.
53135       model-version-id:
53136         type: string
53137         description: the ASDC model version for this resource or service model.
53138       orchestration-status:
53139         type: string
53140         description: Orchestration status of the configuration.
53141       operational-status:
53142         type: string
53143         description: Indicator for whether the resource is considered operational.
53144       configuration-selflink:
53145         type: string
53146         description: URL to endpoint where AAI can get more details from SDN-GC.
53147       model-customization-id:
53148         type: string
53149         description: id of  the configuration used to customize the resource
53150   configurations:
53151     description: |
53152       Collection of configurations
53153     properties:
53154       configuration:
53155         type: array
53156         items:
53157           $ref: "#/patchDefinitions/configuration"
53158   connector:
53159     description: |
53160       Collection of resource instances used to connect a variety of disparate inventory widgets
53161       ###### Related Nodes
53162       - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
53163       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
53164       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
53165       - CONNECTOR is DELETED when these are DELETED METADATUM
53166     required:
53167     - resource-instance-id
53168     properties:
53169       resource-instance-id:
53170         type: string
53171         description: Unique id of resource instance.
53172   connectors:
53173     description: |
53174       Collection of resource instances used to connect a variety of disparate inventory widgets
53175     properties:
53176       connector:
53177         type: array
53178         items:
53179           $ref: "#/patchDefinitions/connector"
53180   constrained-element-set:
53181     description: |
53182       This is how we would capture constraints defining allowed sets of elements.
53183       ###### Related Nodes
53184       - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
53185       - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
53186       - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
53187       - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET
53188     required:
53189     - constrained-element-set-uuid
53190     - constraint-type
53191     - check-type
53192     properties:
53193       constrained-element-set-uuid:
53194         type: string
53195       constraint-type:
53196         type: string
53197       check-type:
53198         type: string
53199   constrained-element-sets:
53200     properties:
53201       constrained-element-set:
53202         type: array
53203         items:
53204           $ref: "#/patchDefinitions/constrained-element-set"
53205   ctag-assignment:
53206     description: |
53207       ###### Related Nodes
53208       - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
53209       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
53210     required:
53211     - vlan-id-inner
53212     properties:
53213       vlan-id-inner:
53214         type: integer
53215         format: int64
53216         description: id.
53217   ctag-assignments:
53218     properties:
53219       ctag-assignment:
53220         type: array
53221         items:
53222           $ref: "#/patchDefinitions/ctag-assignment"
53223   ctag-pool:
53224     description: |
53225       A collection of C tags (vlan tags) grouped for a specific purpose.
53226       ###### Related Nodes
53227       - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
53228       - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
53229       - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
53230     required:
53231     - target-pe
53232     - availability-zone-name
53233     - ctag-pool-purpose
53234     properties:
53235       target-pe:
53236         type: string
53237         description: The Target provider edge router
53238       availability-zone-name:
53239         type: string
53240         description: Name of the availability zone
53241       ctag-pool-purpose:
53242         type: string
53243         description: Describes what the intended purpose of this pool is.
53244       ctag-values:
53245         type: string
53246         description: Comma separated list of ctags
53247   ctag-pools:
53248     properties:
53249       ctag-pool:
53250         type: array
53251         items:
53252           $ref: "#/patchDefinitions/ctag-pool"
53253   customer:
53254     description: |
53255       customer identifiers to provide linkage back to BSS information.
53256       ###### Related Nodes
53257       - FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
53258       - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION
53259     required:
53260     - global-customer-id
53261     - subscriber-name
53262     - subscriber-type
53263     properties:
53264       global-customer-id:
53265         type: string
53266         description: Global customer id used across ECOMP to uniquely identify customer.
53267       subscriber-name:
53268         type: string
53269         description: Subscriber name, an alternate way to retrieve a customer.
53270       subscriber-type:
53271         type: string
53272         description: Subscriber type, a way to provide VID with only the INFRA customers.
53273   customers:
53274     description: |
53275       Collection of customer identifiers to provide linkage back to BSS information.
53276     properties:
53277       customer:
53278         type: array
53279         items:
53280           $ref: "#/patchDefinitions/customer"
53281   cvlan-tag-entry:
53282     required:
53283     - cvlan-tag
53284     properties:
53285       cvlan-tag:
53286         type: integer
53287         format: int64
53288         description: See mis-na-virtualization-platform.yang
53289   cvlan-tags:
53290     properties:
53291       cvlan-tag-entry:
53292         type: array
53293         items:
53294           $ref: "#/patchDefinitions/cvlan-tag-entry"
53295   dvs-switch:
53296     description: |
53297       Digital virtual switch metadata, used by SDN-C to configure VCEs.  A&AI needs to receive this data from the PO deployment team and administer it using the provisioningTool.sh into A&AI.
53298       ###### Related Nodes
53299       - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53300       - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
53301     required:
53302     - switch-name
53303     - vcenter-url
53304     properties:
53305       switch-name:
53306         type: string
53307         description: DVS switch name
53308       vcenter-url:
53309         type: string
53310         description: URL used to reach the vcenter
53311   dvs-switches:
53312     description: |
53313       Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
53314     properties:
53315       dvs-switch:
53316         type: array
53317         items:
53318           $ref: "#/patchDefinitions/dvs-switch"
53319   edge-prop-names:
53320     description: |
53321       Internal map to define the properties of an edge and interpret the map EdgeRules
53322     properties:
53323       edgeLabel:
53324         type: string
53325       direction:
53326         type: string
53327       multiplicityRule:
53328         type: string
53329       isParent:
53330         type: boolean
53331       usesResource:
53332         type: boolean
53333       hasDelTarget:
53334         type: boolean
53335       SVC-INFRA:
53336         type: boolean
53337       SVC-INFRA-REV:
53338         type: boolean
53339   edge-tag-query-request:
53340     properties:
53341       edge-tag:
53342         type: string
53343       result-detail:
53344         type: string
53345       start-node-type:
53346         type: string
53347       start-node-filter:
53348         type: array
53349         items:
53350           $ref: "#/patchDefinitions/start-node-filter"
53351       include-node-filter:
53352         type: array
53353         items:
53354           $ref: "#/patchDefinitions/include-node-filter"
53355       secondary-filter:
53356         type: array
53357         items:
53358           $ref: "#/patchDefinitions/secondary-filter"
53359   edge-tag-query-result:
53360     properties:
53361       tagged-inventory-item-list:
53362         type: array
53363         items:
53364           $ref: "#/patchDefinitions/tagged-inventory-item-list"
53365   element-choice-set:
53366     description: |
53367       This is how we would capture constraints defining allowed sets of elements.
53368       ###### Related Nodes
53369       - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
53370       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
53371       - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT
53372     required:
53373     - element-choice-set-uuid
53374     - element-choice-set-name
53375     properties:
53376       element-choice-set-uuid:
53377         type: string
53378       element-choice-set-name:
53379         type: string
53380       cardinality:
53381         type: string
53382   element-choice-sets:
53383     properties:
53384       element-choice-set:
53385         type: array
53386         items:
53387           $ref: "#/patchDefinitions/element-choice-set"
53388   entitlement:
53389     description: |
53390       Metadata for entitlement group.
53391       ###### Related Nodes
53392       - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
53393       - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
53394     required:
53395     - group-uuid
53396     - resource-uuid
53397     properties:
53398       group-uuid:
53399         type: string
53400         description: Unique ID for the entitlement group the resource comes from, should be uuid.
53401       resource-uuid:
53402         type: string
53403         description: Unique ID of an entitlement resource.
53404   entitlements:
53405     description: |
53406       Entitlements, keyed by group-uuid and resource-uuid, related to license management
53407     properties:
53408       entitlement:
53409         type: array
53410         items:
53411           $ref: "#/patchDefinitions/entitlement"
53412   esr-ems:
53413     description: |
53414       Persist EMS address information used by EMS driver.
53415       ###### Related Nodes
53416       - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)
53417       - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
53418     required:
53419     - ems-id
53420     properties:
53421       ems-id:
53422         type: string
53423         description: Unique ID of EMS.
53424   esr-ems-list:
53425     properties:
53426       esr-ems:
53427         type: array
53428         items:
53429           $ref: "#/patchDefinitions/esr-ems"
53430   esr-system-info:
53431     description: |
53432       Persist common address information of external systems.
53433       ###### Related Nodes
53434       - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)
53435       - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)
53436       - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)
53437       - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)
53438     required:
53439     - esr-system-info-id
53440     - user-name
53441     - password
53442     - system-type
53443     properties:
53444       esr-system-info-id:
53445         type: string
53446         description: Unique ID of esr system info.
53447       system-name:
53448         type: string
53449         description: name of external system.
53450       type:
53451         type: string
53452         description: type of external systems.
53453       vendor:
53454         type: string
53455         description: vendor of external systems.
53456       version:
53457         type: string
53458         description: version of external systems.
53459       service-url:
53460         type: string
53461         description: url used to access external systems.
53462       user-name:
53463         type: string
53464         description: username used to access external systems.
53465       password:
53466         type: string
53467         description: password used to access external systems.
53468       system-type:
53469         type: string
53470         description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
53471       protocol:
53472         type: string
53473         description: protocol of third party SDNC, for example netconf/snmp.
53474       ssl-cacert:
53475         type: string
53476         description: ca file content if enabled ssl on auth-url.
53477       ssl-insecure:
53478         type: boolean
53479         description: Whether to verify VIM's certificate.
53480       ip-address:
53481         type: string
53482         description: service IP of ftp server.
53483       port:
53484         type: string
53485         description: service port of ftp server.
53486       cloud-domain:
53487         type: string
53488         description: domain info for authentication.
53489       default-tenant:
53490         type: string
53491         description: default tenant of VIM.
53492       passive:
53493         type: boolean
53494         description: ftp passive mode or not.
53495       remote-path:
53496         type: string
53497         description: resource or performance data file path.
53498       system-status:
53499         type: string
53500         description: the status of external system.
53501   esr-system-info-list:
53502     description: |
53503       Collection of persistent block-level external system auth info.
53504     properties:
53505       esr-system-info:
53506         type: array
53507         items:
53508           $ref: "#/patchDefinitions/esr-system-info"
53509   esr-thirdparty-sdnc:
53510     description: |
53511       Persist SDNC address information used by ONAP SDNC.
53512       ###### Related Nodes
53513       - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)
53514       - TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
53515       - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
53516     required:
53517     - thirdparty-sdnc-id
53518     properties:
53519       thirdparty-sdnc-id:
53520         type: string
53521         description: Unique ID of SDNC.
53522       location:
53523         type: string
53524         description: used for DC type to indicate the location of SDNC, such as Core or Edge.
53525       product-name:
53526         type: string
53527         description: password used to access SDNC server.
53528   esr-thirdparty-sdnc-list:
53529     properties:
53530       esr-thirdparty-sdnc:
53531         type: array
53532         items:
53533           $ref: "#/patchDefinitions/esr-thirdparty-sdnc"
53534   esr-vnfm:
53535     description: |
53536       Persist VNFM address information used by VF-C.
53537       ###### Related Nodes
53538       - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)
53539       - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
53540     required:
53541     - vnfm-id
53542     properties:
53543       vnfm-id:
53544         type: string
53545         description: Unique ID of VNFM.
53546       vim-id:
53547         type: string
53548         description: indecate the VIM to deploy VNF.
53549       certificate-url:
53550         type: string
53551         description: certificate url of VNFM.
53552   esr-vnfm-list:
53553     properties:
53554       esr-vnfm:
53555         type: array
53556         items:
53557           $ref: "#/patchDefinitions/esr-vnfm"
53558   evc:
53559     description: |
53560       evc object is an optional child object of the Configuration object.
53561       ###### Related Nodes
53562       - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
53563     required:
53564     - evc-id
53565     properties:
53566       evc-id:
53567         type: string
53568         description: Unique/key field for the evc object
53569       forwarding-path-topology:
53570         type: string
53571         description: Point-to-Point, Multi-Point
53572       cir-value:
53573         type: string
53574         description: Commited Information Rate
53575       cir-units:
53576         type: string
53577         description: CIR units
53578       connection-diversity-group-id:
53579         type: string
53580         description: Diversity Group ID
53581       service-hours:
53582         type: string
53583         description: formerly Performance Group
53584       esp-evc-circuit-id:
53585         type: string
53586         description: EVC Circuit ID of ESP EVC
53587       esp-evc-cir-value:
53588         type: string
53589         description: Committed Information Rate (For ESP)
53590       esp-evc-cir-units:
53591         type: string
53592         description: CIR units (For ESP)
53593       esp-itu-code:
53594         type: string
53595         description: Identifies ESP
53596       collector-pop-clli:
53597         type: string
53598         description: Collector POP CLLI (from the hostname of the access pnf)
53599       inter-connect-type-ingress:
53600         type: string
53601         description: Interconnect type on ingress side of EVC.
53602       tagmode-access-ingress:
53603         type: string
53604         description: tagode for collector side of EVC
53605       tagmode-access-egress:
53606         type: string
53607         description: tagMode for network side of EVC
53608   evcs:
53609     properties:
53610       evc:
53611         type: array
53612         items:
53613           $ref: "#/patchDefinitions/evc"
53614   external-system:
53615     description: |
53616       Namespace for external system.
53617     properties:
53618       esr-ems-list:
53619         type: object
53620         $ref: "#/patchDefinitions/esr-ems-list"
53621       esr-vnfm-list:
53622         type: object
53623         $ref: "#/patchDefinitions/esr-vnfm-list"
53624       esr-thirdparty-sdnc-list:
53625         type: object
53626         $ref: "#/patchDefinitions/esr-thirdparty-sdnc-list"
53627   extra-properties:
53628     description: |
53629       Extra properties for inventory item for response list
53630   extra-property:
53631     properties:
53632       property-name:
53633         type: string
53634   flavor:
53635     description: |
53636       Openstack flavor.
53637       ###### Related Nodes
53638       - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53639       - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
53640       - FLAVOR cannot be deleted if linked to VSERVER
53641     required:
53642     - flavor-id
53643     - flavor-name
53644     - flavor-selflink
53645     properties:
53646       flavor-id:
53647         type: string
53648         description: Flavor id, expected to be unique across cloud-region.
53649       flavor-name:
53650         type: string
53651         description: Flavor name
53652       flavor-vcpus:
53653         type: integer
53654         format: int32
53655         description: Number of CPUs
53656       flavor-ram:
53657         type: integer
53658         format: int32
53659         description: Amount of memory
53660       flavor-disk:
53661         type: integer
53662         format: int32
53663         description: Disk space
53664       flavor-ephemeral:
53665         type: integer
53666         format: int32
53667         description: Amount of ephemeral disk space
53668       flavor-swap:
53669         type: string
53670         description: amount of swap space allocation
53671       flavor-is-public:
53672         type: boolean
53673         description: whether flavor is available to all users or private to the tenant it was created in.
53674       flavor-selflink:
53675         type: string
53676         description: URL to endpoint where AAI can get more details
53677       flavor-disabled:
53678         type: boolean
53679         description: Boolean as to whether this flavor is no longer enabled
53680   flavors:
53681     description: |
53682       Collection of openstack flavors.
53683     properties:
53684       flavor:
53685         type: array
53686         items:
53687           $ref: "#/patchDefinitions/flavor"
53688   forwarder:
53689     description: |
53690       Entity describing a sequenced segment of forwarding path
53691       ###### Related Nodes
53692       - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
53693       - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
53694       - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
53695       - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
53696       - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
53697       - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION
53698     required:
53699     - sequence
53700     properties:
53701       sequence:
53702         type: integer
53703         format: int32
53704         description: Unique ID of this segmentation
53705       forwarder-role:
53706         type: string
53707         description: ingress, intermediate, egress
53708   forwarder-evc:
53709     description: |
53710       forwarder object is an optional child object of the Configuration object.
53711       ###### Related Nodes
53712       - TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
53713     required:
53714     - forwarder-evc-id
53715     properties:
53716       forwarder-evc-id:
53717         type: string
53718         description: Key for forwarder-evc object
53719       circuit-id:
53720         type: string
53721         description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
53722       ivlan:
53723         type: string
53724         description: Internal VLAN.
53725       svlan:
53726         type: string
53727         description: SVLAN value for ingress of egress forwarder.
53728       cvlan:
53729         type: string
53730         description: CVLAN value for ingress of egress forwarder.
53731   forwarder-evcs:
53732     properties:
53733       forwarder-evc:
53734         type: array
53735         items:
53736           $ref: "#/patchDefinitions/forwarder-evc"
53737   forwarders:
53738     properties:
53739       forwarder:
53740         type: array
53741         items:
53742           $ref: "#/patchDefinitions/forwarder"
53743   forwarding-path:
53744     description: |
53745       Entity that describes the sequenced forwarding path between interfaces of services or resources
53746       ###### Related Nodes
53747       - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
53748       - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
53749       - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
53750       - FORWARDING-PATH is DELETED when these are DELETED FORWARDER
53751       - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION
53752     required:
53753     - forwarding-path-id
53754     - forwarding-path-name
53755     properties:
53756       forwarding-path-id:
53757         type: string
53758         description: Unique ID of this FP
53759       forwarding-path-name:
53760         type: string
53761         description: Name of the FP
53762   forwarding-paths:
53763     properties:
53764       forwarding-path:
53765         type: array
53766         items:
53767           $ref: "#/patchDefinitions/forwarding-path"
53768   generic-vnf:
53769     description: |
53770       General purpose VNF
53771       ###### Related Nodes
53772       - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
53773       - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
53774       - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
53775       - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
53776       - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY)
53777       - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
53778       - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
53779       - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
53780       - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
53781       - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
53782       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
53783       - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
53784       - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
53785       - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
53786       - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
53787       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
53788       - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
53789       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
53790       - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
53791       - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
53792       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
53793       - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE
53794     required:
53795     - vnf-id
53796     - vnf-name
53797     - vnf-type
53798     - in-maint
53799     - is-closed-loop-disabled
53800     properties:
53801       vnf-id:
53802         type: string
53803         description: Unique id of VNF.  This is unique across the graph.
53804       vnf-name:
53805         type: string
53806         description: Name of VNF.
53807       vnf-name2:
53808         type: string
53809         description: Alternate name of VNF.
53810       vnf-type:
53811         type: string
53812         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
53813       service-id:
53814         type: string
53815         description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
53816       regional-resource-zone:
53817         type: string
53818         description: Regional way of organizing pservers, source of truth should define values
53819       prov-status:
53820         type: string
53821         description: Trigger for operational monitoring of this resource by Service Assurance systems.
53822       operational-state:
53823         type: string
53824         description: Indicator for whether the resource is considered operational.  Valid values are in-service-path and out-of-service-path.
53825       license-key:
53826         type: string
53827         description: OBSOLETE -  do not use
53828       equipment-role:
53829         type: string
53830         description: Client should send valid enumerated value
53831       orchestration-status:
53832         type: string
53833         description: Orchestration status of this VNF, used by MSO.
53834       heat-stack-id:
53835         type: string
53836         description: Heat stack id corresponding to this instance, managed by MSO
53837       mso-catalog-key:
53838         type: string
53839         description: Corresponds to the SDN-C catalog id used to configure this VCE
53840       management-option:
53841         type: string
53842         description: identifier of managed by company or customer
53843       ipv4-oam-address:
53844         type: string
53845         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
53846       ipv4-loopback0-address:
53847         type: string
53848         description: v4 Loopback0 address
53849       nm-lan-v6-address:
53850         type: string
53851         description: v6 Loopback address
53852       management-v6-address:
53853         type: string
53854         description: v6 management address
53855       vcpu:
53856         type: integer
53857         format: int64
53858         description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
53859       vcpu-units:
53860         type: string
53861         description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only in some usecases
53862       vmemory:
53863         type: integer
53864         format: int64
53865         description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
53866       vmemory-units:
53867         type: string
53868         description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only in some usecases
53869       vdisk:
53870         type: integer
53871         format: int64
53872         description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
53873       vdisk-units:
53874         type: string
53875         description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only in some usecases
53876       in-maint:
53877         type: boolean
53878       is-closed-loop-disabled:
53879         type: boolean
53880   generic-vnfs:
53881     description: |
53882       Collection of VNFs
53883     properties:
53884       generic-vnf:
53885         type: array
53886         items:
53887           $ref: "#/patchDefinitions/generic-vnf"
53888   group-assignment:
53889     description: |
53890       Openstack group-assignment used to store exclusivity groups (EG).
53891       ###### Related Nodes
53892       - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53893       - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
53894       - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
53895     required:
53896     - group-id
53897     - group-type
53898     - group-name
53899     properties:
53900       group-id:
53901         type: string
53902         description: Group id, expected to be unique across cloud-region.
53903       group-type:
53904         type: string
53905         description: Group type - the type of group this instance refers to
53906       group-name:
53907         type: string
53908         description: Group name - name assigned to the group
53909       group-description:
53910         type: string
53911         description: Group description - description of the group
53912   group-assignments:
53913     description: |
53914       Collection of openstack group assignments
53915     properties:
53916       group-assignment:
53917         type: array
53918         items:
53919           $ref: "#/patchDefinitions/group-assignment"
53920   host-route:
53921     description: |
53922       ###### Related Nodes
53923       - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
53924     required:
53925     - host-route-id
53926     - route-prefix
53927     - next-hop
53928     properties:
53929       host-route-id:
53930         type: string
53931         description: host-route id
53932       route-prefix:
53933         type: string
53934         description: subnet prefix
53935       next-hop:
53936         type: string
53937         description: Could be ip-address, hostname, or service-instance
53938       next-hop-type:
53939         type: string
53940         description: Should be ip-address, hostname, or service-instance to match next-hop
53941   host-routes:
53942     properties:
53943       host-route:
53944         type: array
53945         items:
53946           $ref: "#/patchDefinitions/host-route"
53947   hpa-capabilities:
53948     description: |
53949       Collection of HPA Capabilities
53950     properties:
53951       hpa-capability:
53952         type: array
53953         items:
53954           $ref: "#/patchDefinitions/hpa-capability"
53955   hpa-capability:
53956     description: |
53957       Represents a HPA capability
53958       ###### Related Nodes
53959       - TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE)
53960       - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53961       - FROM hpa-feature-attributes( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE)
53962       - HPA-CAPABILITY is DELETED when these are DELETED HPA-FEATURE-ATTRIBUTES
53963     required:
53964     - hpa-capability-id
53965     - hpa-feature
53966     properties:
53967       hpa-capability-id:
53968         type: string
53969         description: UUID to uniquely identify a HPA capability
53970       hpa-feature:
53971         type: string
53972         description: Name of the HPACapability
53973       hpa-version:
53974         type: string
53975         description: HPA schema version
53976       hpa-hw-arch:
53977         type: string
53978         description: Hardware architecture
53979   hpa-feature-attributes:
53980     description: |
53981       HPA Capability Feature attributes
53982       ###### Related Nodes
53983       - TO hpa-capability( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE)
53984     properties:
53985       hpa-attr-key:
53986         type: string
53987         description: name of the specific HPA attribute
53988       hpa-attr-value:
53989         type: string
53990         description: JSON string specifying the value, unit and type of the specific HPA attribute
53991   image:
53992     description: |
53993       Openstack image.
53994       ###### Related Nodes
53995       - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53996       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
53997       - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
53998       - IMAGE cannot be deleted if linked to VSERVER
53999       - IMAGE is DELETED when these are DELETED METADATUM
54000     required:
54001     - image-id
54002     - image-name
54003     - image-os-distro
54004     - image-os-version
54005     - image-selflink
54006     properties:
54007       image-id:
54008         type: string
54009         description: Image id, expected to be unique across cloud region
54010       image-name:
54011         type: string
54012         description: Image name
54013       image-architecture:
54014         type: string
54015         description: Operating system architecture.
54016       image-os-distro:
54017         type: string
54018         description: The common name of the operating system distribution in lowercase
54019       image-os-version:
54020         type: string
54021         description: The operating system version as specified by the distributor.
54022       application:
54023         type: string
54024         description: The application that the image instantiates.
54025       application-vendor:
54026         type: string
54027         description: The vendor of the application.
54028       application-version:
54029         type: string
54030         description: The version of the application.
54031       image-selflink:
54032         type: string
54033         description: URL to endpoint where AAI can get more details
54034   images:
54035     description: |
54036       Collectio of Openstack images.
54037     properties:
54038       image:
54039         type: array
54040         items:
54041           $ref: "#/patchDefinitions/image"
54042   include-node-filter:
54043     properties:
54044       include-node-type:
54045         type: string
54046   instance-filter:
54047     description: |
54048       InstanceFilter for performing a named-query or model query
54049   instance-filters:
54050     description: |
54051       InstanceFilters for performing a named-query or model query
54052     properties:
54053       instance-filter:
54054         type: array
54055         items:
54056           $ref: "#/patchDefinitions/instance-filter"
54057   instance-group:
54058     description: |
54059       General mechanism for grouping instances
54060       ###### Related Nodes
54061       - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
54062       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
54063       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
54064       - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
54065       - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
54066     required:
54067     - id
54068     - description
54069     - type
54070     properties:
54071       id:
54072         type: string
54073         description: Instance Group ID, UUID assigned to this instance.
54074       description:
54075         type: string
54076         description: Descriptive text to help identify the usage of this instance-group
54077       type:
54078         type: string
54079         description: Only valid value today is lower case ha for high availability
54080       sub-type:
54081         type: string
54082         description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
54083   instance-groups:
54084     description: |
54085       Collection of openstack route table references
54086     properties:
54087       instance-group:
54088         type: array
54089         items:
54090           $ref: "#/patchDefinitions/instance-group"
54091   inventory:
54092     properties:
54093       search:
54094         type: object
54095         $ref: "#/patchDefinitions/search"
54096       actions:
54097         type: object
54098         $ref: "#/patchDefinitions/actions"
54099       cloud-infrastructure:
54100         type: object
54101         $ref: "#/patchDefinitions/cloud-infrastructure"
54102       business:
54103         type: object
54104         $ref: "#/patchDefinitions/business"
54105       service-design-and-creation:
54106         type: object
54107         $ref: "#/patchDefinitions/service-design-and-creation"
54108       network:
54109         type: object
54110         $ref: "#/patchDefinitions/network"
54111       aai-internal:
54112         type: object
54113         $ref: "#/patchDefinitions/aai-internal"
54114       nodes:
54115         type: array
54116         items:
54117           $ref: "#/patchDefinitions/aai-internal"
54118   inventory-item:
54119     properties:
54120       inventory-item-type:
54121         type: string
54122       inventory-item-link:
54123         type: string
54124       inventory-item-data:
54125         type: array
54126         items:
54127           $ref: "#/patchDefinitions/inventory-item-data"
54128       tagged-inventory-item-list:
54129         type: array
54130         items:
54131           $ref: "#/patchDefinitions/tagged-inventory-item-list"
54132   inventory-item-data:
54133     properties:
54134       property-name:
54135         type: string
54136       property-value:
54137         type: string
54138   inventory-response-item:
54139     description: |
54140       Inventory item for response list
54141     properties:
54142       model-name:
54143         type: string
54144       extra-properties:
54145         type: object
54146         $ref: "#/patchDefinitions/extra-properties"
54147       inventory-response-items:
54148         type: object
54149         $ref: "#/patchDefinitions/inventory-response-items"
54150   inventory-response-items:
54151     description: |
54152       Container for inventory items in response list
54153     properties:
54154       inventory-response-item:
54155         type: array
54156         items:
54157           $ref: "#/patchDefinitions/inventory-response-item"
54158   ipsec-configuration:
54159     description: |
54160       IPSec configuration node will contain various configuration data for the NMTE VNF. This node will have an edge to the generic-vnf (vnf type = TE). Starting 1607, this data will be populated by SDN-C
54161       ###### Related Nodes
54162       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
54163       - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
54164       - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER
54165     required:
54166     - ipsec-configuration-id
54167     properties:
54168       ipsec-configuration-id:
54169         type: string
54170         description: UUID of this configuration
54171       requested-vig-address-type:
54172         type: string
54173         description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
54174       requested-encryption-strength:
54175         type: string
54176         description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
54177       requested-dmz-type:
54178         type: string
54179         description: can offer a shared DMZ or a DMZ specific to a customer
54180       shared-dmz-network-address:
54181         type: string
54182         description: Network address of shared DMZ
54183       requested-customer-name:
54184         type: string
54185         description: If the DMZ is a custom DMZ, this field will indicate the customer information
54186       ike-version:
54187         type: string
54188         description: can be 1 or 2
54189       ikev1-authentication:
54190         type: string
54191         description: Contains values like md5, sha1, sha256, sha384
54192       ikev1-encryption:
54193         type: string
54194         description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
54195       ikev1-dh-group:
54196         type: string
54197         description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
54198       ikev1-am-group-id:
54199         type: string
54200         description: Group name defined in VIG for clients using aggressive mode
54201       ikev1-am-password:
54202         type: string
54203         description: pre-shared key for the above group name
54204       ikev1-sa-lifetime:
54205         type: string
54206         description: Lifetime for IKEv1 SA
54207       ipsec-authentication:
54208         type: string
54209         description: md5, sha1, sha256, sha384
54210       ipsec-encryption:
54211         type: string
54212         description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
54213       ipsec-sa-lifetime:
54214         type: string
54215         description: Life time for IPSec SA
54216       ipsec-pfs:
54217         type: string
54218         description: enable PFS or not
54219       xauth-userid:
54220         type: string
54221         description: user ID for xAuth, sm-user, ,nmteHostName
54222       xauth-user-password:
54223         type: string
54224         description: Encrypted using the Juniper $9$ algorithm
54225       dpd-interval:
54226         type: string
54227         description: The time between DPD probe
54228       dpd-frequency:
54229         type: string
54230         description: Maximum number of DPD before claiming the tunnel is down
54231   ipsec-configurations:
54232     properties:
54233       ipsec-configuration:
54234         type: array
54235         items:
54236           $ref: "#/patchDefinitions/ipsec-configuration"
54237   key-data:
54238     properties:
54239       key-name:
54240         type: string
54241       key-value:
54242         type: string
54243   l-interface:
54244     description: |
54245       Logical interfaces, e.g., a vnic.
54246       ###### Related Nodes
54247       - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
54248       - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
54249       - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
54250       - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
54251       - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
54252       - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
54253       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
54254       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
54255       - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
54256       - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
54257       - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN
54258       - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
54259     required:
54260     - interface-name
54261     properties:
54262       interface-name:
54263         type: string
54264         description: Name given to the interface
54265       interface-role:
54266         type: string
54267         description: E.g., CUSTOMER, UPLINK, etc.
54268       v6-wan-link-ip:
54269         type: string
54270         description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
54271       selflink:
54272         type: string
54273         description: URL to endpoint where AAI can get more details
54274       interface-id:
54275         type: string
54276         description: ID of interface
54277       macaddr:
54278         type: string
54279         description: MAC address for the interface
54280       network-name:
54281         type: string
54282         description: Name of the network
54283       management-option:
54284         type: string
54285         description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
54286       interface-description:
54287         type: string
54288         description: Human friendly text regarding this interface.
54289   l-interfaces:
54290     description: |
54291       Collection of logical interfaces.
54292     properties:
54293       l-interface:
54294         type: array
54295         items:
54296           $ref: "#/patchDefinitions/l-interface"
54297   l3-interface-ipv4-address-list:
54298     description: |
54299       IPv4 Address Range
54300       ###### Related Nodes
54301       - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
54302       - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
54303       - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
54304       - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
54305     required:
54306     - l3-interface-ipv4-address
54307     properties:
54308       l3-interface-ipv4-address:
54309         type: string
54310         description: IP address
54311       l3-interface-ipv4-prefix-length:
54312         type: integer
54313         format: int64
54314         description: Prefix length, 32 for single address
54315       vlan-id-inner:
54316         type: integer
54317         format: int64
54318         description: Inner VLAN tag
54319       vlan-id-outer:
54320         type: integer
54321         format: int64
54322         description: Outer VLAN tag
54323       is-floating:
54324         type: boolean
54325         description: Indicator of fixed or floating address
54326   l3-interface-ipv6-address-list:
54327     description: |
54328       IPv6 Address Range
54329       ###### Related Nodes
54330       - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
54331       - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
54332       - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
54333       - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
54334     required:
54335     - l3-interface-ipv6-address
54336     properties:
54337       l3-interface-ipv6-address:
54338         type: string
54339         description: IP address
54340       l3-interface-ipv6-prefix-length:
54341         type: integer
54342         format: int64
54343         description: Prefix length, 128 for single address
54344       vlan-id-inner:
54345         type: integer
54346         format: int64
54347         description: Inner VLAN tag
54348       vlan-id-outer:
54349         type: integer
54350         format: int64
54351         description: Outer VLAN tag
54352       is-floating:
54353         type: boolean
54354         description: Indicator of fixed or floating address
54355   l3-network:
54356     description: |
54357       Generic network definition
54358       ###### Related Nodes
54359       - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
54360       - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
54361       - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
54362       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
54363       - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
54364       - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
54365       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
54366       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
54367       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
54368       - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
54369       - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
54370       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
54371       - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
54372       - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
54373       - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
54374       - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET
54375     required:
54376     - network-id
54377     - network-name
54378     - is-bound-to-vpn
54379     - is-provider-network
54380     - is-shared-network
54381     - is-external-network
54382     properties:
54383       network-id:
54384         type: string
54385         description: Network ID, should be uuid. Unique across A&AI.
54386       network-name:
54387         type: string
54388         description: Name of the network, governed by some naming convention..
54389       network-type:
54390         type: string
54391         description: Type of the network - who defines these values?
54392       network-role:
54393         type: string
54394         description: Role the network plans - who defines these values?
54395       network-technology:
54396         type: string
54397         description: Network technology - who defines these values?
54398       neutron-network-id:
54399         type: string
54400         description: Neutron network id of this Interface
54401       is-bound-to-vpn:
54402         type: boolean
54403       service-id:
54404         type: string
54405         description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
54406       network-role-instance:
54407         type: integer
54408         format: int64
54409         description: network role instance
54410   l3-networks:
54411     properties:
54412       l3-network:
54413         type: array
54414         items:
54415           $ref: "#/patchDefinitions/l3-network"
54416   lag-interface:
54417     description: |
54418       Link aggregate interface
54419       ###### Related Nodes
54420       - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
54421       - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
54422       - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
54423       - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
54424       - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
54425       - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
54426       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
54427       - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE
54428       - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK
54429     required:
54430     - interface-name
54431     properties:
54432       interface-name:
54433         type: string
54434         description: Name that identifies the link aggregate interface
54435       interface-description:
54436         type: string
54437         description: Human friendly text regarding this interface.
54438   lag-interfaces:
54439     description: |
54440       Collection of link aggregate interfaces.
54441     properties:
54442       lag-interface:
54443         type: array
54444         items:
54445           $ref: "#/patchDefinitions/lag-interface"
54446   lag-link:
54447     description: |
54448       LAG links can connect lag-interfaces
54449       ###### Related Nodes
54450       - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
54451       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
54452     required:
54453     - link-name
54454     properties:
54455       link-name:
54456         type: string
54457         description: Alphabetical concatenation of lag-interface names
54458   lag-links:
54459     description: |
54460       Collection of link aggregation connections
54461     properties:
54462       lag-link:
54463         type: array
54464         items:
54465           $ref: "#/patchDefinitions/lag-link"
54466   license:
54467     description: |
54468       Metadata for license group.
54469       ###### Related Nodes
54470       - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
54471       - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
54472     required:
54473     - group-uuid
54474     - resource-uuid
54475     properties:
54476       group-uuid:
54477         type: string
54478         description: Unique ID for the license group the resource belongs to, should be uuid.
54479       resource-uuid:
54480         type: string
54481         description: Unique ID of a license resource.
54482   licenses:
54483     description: |
54484       Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
54485     properties:
54486       license:
54487         type: array
54488         items:
54489           $ref: "#/patchDefinitions/license"
54490   line-of-business:
54491     description: |
54492       describes a line-of-business
54493       ###### Related Nodes
54494       - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
54495     required:
54496     - line-of-business-name
54497     properties:
54498       line-of-business-name:
54499         type: string
54500         description: Name of the line-of-business (product)
54501   lines-of-business:
54502     description: |
54503       Collection of lines-of-business
54504     properties:
54505       line-of-business:
54506         type: array
54507         items:
54508           $ref: "#/patchDefinitions/line-of-business"
54509   logical-link:
54510     description: |
54511       Logical links generally connect l-interfaces but are used to express logical connectivity between two points
54512       ###### Related Nodes
54513       - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
54514       - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
54515       - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
54516       - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
54517       - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
54518       - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
54519       - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
54520       - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
54521       - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
54522       - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
54523       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
54524       - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
54525       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
54526     required:
54527     - link-name
54528     - link-type
54529     properties:
54530       link-name:
54531         type: string
54532         description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
54533       link-type:
54534         type: string
54535         description: Type of logical link, e.g., evc
54536       speed-value:
54537         type: string
54538         description: Captures the numeric part of the speed
54539       speed-units:
54540         type: string
54541         description: Captures the units corresponding to the speed
54542       ip-version:
54543         type: string
54544         description: v4, v6, or ds for dual stack
54545       routing-protocol:
54546         type: string
54547         description: For example, static or BGP
54548   logical-links:
54549     description: |
54550       Collection of logical connections
54551     properties:
54552       logical-link:
54553         type: array
54554         items:
54555           $ref: "#/patchDefinitions/logical-link"
54556   metadata:
54557     description: |
54558       Collection of metadatum (key/value pairs)
54559     properties:
54560       metadatum:
54561         type: array
54562         items:
54563           $ref: "#/patchDefinitions/metadatum"
54564   metadatum:
54565     description: |
54566       Key/value pairs
54567       ###### Related Nodes
54568       - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
54569       - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
54570       - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
54571       - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
54572     required:
54573     - metaname
54574     - metaval
54575     properties:
54576       metaname:
54577         type: string
54578       metaval:
54579         type: string
54580   model:
54581     description: |
54582       Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
54583       ###### Related Nodes
54584       - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
54585       - FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
54586       - FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
54587       - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
54588       - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
54589       - MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
54590       - MODEL is DELETED when these are DELETED MODEL-VER
54591     required:
54592     - model-invariant-id
54593     - model-type
54594     properties:
54595       model-invariant-id:
54596         type: string
54597         description: Unique identifier corresponding to the main definition of a model in ASDC
54598       model-type:
54599         type: string
54600         description: Type of the model, e.g., service, resource, widget, etc.
54601   model-and-named-query-search:
54602     description: |
54603       ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
54604     properties:
54605       query-parameters:
54606         type: object
54607         $ref: "#/patchDefinitions/query-parameters"
54608       instance-filters:
54609         type: object
54610         $ref: "#/patchDefinitions/instance-filters"
54611       secondary-filts:
54612         type: object
54613         $ref: "#/patchDefinitions/secondary-filts"
54614       top-node-type:
54615         type: string
54616       secondary-filter-cut-point:
54617         type: string
54618   model-constraint:
54619     description: |
54620       This is how we would capture constraints defining allowed sets of elements.
54621       ###### Related Nodes
54622       - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
54623       - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
54624       - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET
54625     required:
54626     - model-constraint-uuid
54627     - constrained-element-set-uuid-to-replace
54628     properties:
54629       model-constraint-uuid:
54630         type: string
54631       constrained-element-set-uuid-to-replace:
54632         type: string
54633       constrained-element-sets:
54634         type: array
54635         items:
54636           $ref: "#/patchDefinitions/constrained-element-set"
54637   model-constraints:
54638     properties:
54639       model-constraint:
54640         type: array
54641         items:
54642           $ref: "#/patchDefinitions/model-constraint"
54643   model-element:
54644     description: |
54645       Defines how other models combine to make up a higher-level model.
54646       ###### Related Nodes
54647       - TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
54648       - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
54649       - TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
54650       - TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
54651       - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
54652       - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
54653       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
54654       - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT
54655     required:
54656     - model-element-uuid
54657     - new-data-del-flag
54658     - cardinality
54659     properties:
54660       model-element-uuid:
54661         type: string
54662       new-data-del-flag:
54663         type: string
54664         description: Indicates whether this element was created as part of instantiation from this model
54665       cardinality:
54666         type: string
54667         description: How many of this type of element are required/allowed
54668       linkage-points:
54669         type: string
54670   model-elements:
54671     properties:
54672       model-element:
54673         type: array
54674         items:
54675           $ref: "#/patchDefinitions/model-element"
54676   model-ver:
54677     description: |
54678       Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
54679       ###### Related Nodes
54680       - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
54681       - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
54682       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
54683       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
54684       - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT
54685       - MODEL-VER is DELETED when these are DELETED MODEL-ELEMENT,METADATUM
54686     required:
54687     - model-version-id
54688     - model-name
54689     - model-version
54690     properties:
54691       model-version-id:
54692         type: string
54693         description: Unique identifier corresponding to one version of a model in ASDC
54694       model-name:
54695         type: string
54696         description: Name of the model, which can change from version to version.
54697       model-version:
54698         type: string
54699         description: Version
54700       model-description:
54701         type: string
54702         description: Description
54703   model-vers:
54704     properties:
54705       model-ver:
54706         type: array
54707         items:
54708           $ref: "#/patchDefinitions/model-ver"
54709   models:
54710     description: |
54711       Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
54712     properties:
54713       model:
54714         type: array
54715         items:
54716           $ref: "#/patchDefinitions/model"
54717   multicast-configuration:
54718     description: |
54719       ###### Related Nodes
54720       - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
54721     required:
54722     - multicast-configuration-id
54723     - multicast-protocol
54724     - rp-type
54725     properties:
54726       multicast-configuration-id:
54727         type: string
54728         description: Unique id of multicast configuration.
54729       multicast-protocol:
54730         type: string
54731         description: protocol of multicast configuration
54732       rp-type:
54733         type: string
54734         description: rp type of multicast configuration
54735   multicast-configurations:
54736     description: |
54737       multicast configuration of generic-vnf ip-address
54738     properties:
54739       multicast-configuration:
54740         type: array
54741         items:
54742           $ref: "#/patchDefinitions/multicast-configuration"
54743   named-queries:
54744     properties:
54745       named-query:
54746         type: array
54747         items:
54748           $ref: "#/patchDefinitions/named-query"
54749   named-query:
54750     description: |
54751       TBD
54752       ###### Related Nodes
54753       - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
54754       - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
54755       - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
54756       - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT
54757     required:
54758     - named-query-uuid
54759     - named-query-name
54760     - named-query-version
54761     properties:
54762       named-query-uuid:
54763         type: string
54764       named-query-name:
54765         type: string
54766       named-query-version:
54767         type: string
54768       required-input-param:
54769         type: string
54770       description:
54771         type: string
54772   named-query-element:
54773     description: |
54774       TBD
54775       ###### Related Nodes
54776       - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
54777       - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
54778       - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
54779       - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
54780       - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
54781       - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
54782       - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP
54783     required:
54784     - named-query-element-uuid
54785     properties:
54786       named-query-element-uuid:
54787         type: string
54788       property-collect-list:
54789         type: string
54790   named-query-elements:
54791     properties:
54792       named-query-element:
54793         type: array
54794         items:
54795           $ref: "#/patchDefinitions/named-query-element"
54796   network:
54797     description: |
54798       Namespace for network inventory resources.
54799     properties:
54800       logical-links:
54801         type: array
54802         items:
54803           $ref: "#/patchDefinitions/logical-link"
54804       site-pair-sets:
54805         type: array
54806         items:
54807           $ref: "#/patchDefinitions/site-pair-set"
54808       vpn-bindings:
54809         type: array
54810         items:
54811           $ref: "#/patchDefinitions/vpn-binding"
54812       vpls-pes:
54813         type: array
54814         items:
54815           $ref: "#/patchDefinitions/vpls-pe"
54816       multicast-configurations:
54817         type: array
54818         items:
54819           $ref: "#/patchDefinitions/multicast-configuration"
54820       vces:
54821         type: array
54822         items:
54823           $ref: "#/patchDefinitions/vce"
54824       vnfcs:
54825         type: array
54826         items:
54827           $ref: "#/patchDefinitions/vnfc"
54828       l3-networks:
54829         type: array
54830         items:
54831           $ref: "#/patchDefinitions/l3-network"
54832       network-policies:
54833         type: array
54834         items:
54835           $ref: "#/patchDefinitions/network-policy"
54836       generic-vnfs:
54837         type: array
54838         items:
54839           $ref: "#/patchDefinitions/generic-vnf"
54840       lag-links:
54841         type: array
54842         items:
54843           $ref: "#/patchDefinitions/lag-link"
54844       newvces:
54845         type: array
54846         items:
54847           $ref: "#/patchDefinitions/newvce"
54848       pnfs:
54849         type: array
54850         items:
54851           $ref: "#/patchDefinitions/pnf"
54852       physical-links:
54853         type: array
54854         items:
54855           $ref: "#/patchDefinitions/physical-link"
54856       ipsec-configurations:
54857         type: array
54858         items:
54859           $ref: "#/patchDefinitions/ipsec-configuration"
54860       route-table-references:
54861         type: array
54862         items:
54863           $ref: "#/patchDefinitions/route-table-reference"
54864       instance-groups:
54865         type: array
54866         items:
54867           $ref: "#/patchDefinitions/instance-group"
54868       zones:
54869         type: array
54870         items:
54871           $ref: "#/patchDefinitions/zone"
54872   network-policies:
54873     properties:
54874       network-policy:
54875         type: array
54876         items:
54877           $ref: "#/patchDefinitions/network-policy"
54878   network-policy:
54879     description: |
54880       ###### Related Nodes
54881       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
54882     required:
54883     - network-policy-id
54884     properties:
54885       network-policy-id:
54886         type: string
54887         description: UUID representing unique key to this instance
54888       network-policy-fqdn:
54889         type: string
54890         description: Contrail FQDN for the policy
54891       heat-stack-id:
54892         type: string
54893         description: ID for the openStack Heat instance
54894   network-profile:
54895     description: |
54896       Network profile populated by SDN-GP for SNMP
54897       ###### Related Nodes
54898       - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
54899     required:
54900     - nm-profile-name
54901     properties:
54902       nm-profile-name:
54903         type: string
54904         description: Unique name of network profile.
54905       community-string:
54906         type: string
54907         description: Encrypted SNMP community string
54908   network-profiles:
54909     description: |
54910       Collection of network profiles
54911     properties:
54912       network-profile:
54913         type: array
54914         items:
54915           $ref: "#/patchDefinitions/network-profile"
54916   newvce:
54917     description: |
54918       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
54919       ###### Related Nodes
54920       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
54921       - NEWVCE is DELETED when these are DELETED L-INTERFACE
54922     required:
54923     - vnf-id2
54924     - vnf-name
54925     - vnf-type
54926     properties:
54927       vnf-id2:
54928         type: string
54929         description: Unique id of VNF, can't use same attribute name right now until we promote this new object
54930       vnf-name:
54931         type: string
54932         description: Name of VNF.
54933       vnf-name2:
54934         type: string
54935         description: Alternate name of VNF.
54936       vnf-type:
54937         type: string
54938         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
54939       prov-status:
54940         type: string
54941         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
54942       operational-state:
54943         type: string
54944         description: Indicator for whether the resource is considered operational
54945       license-key:
54946         type: string
54947         description: OBSOLETE -  do not use
54948       ipv4-oam-address:
54949         type: string
54950         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by VPE (v4-loopback0-ip-address).
54951       equipment-role:
54952         type: string
54953         description: Client should send valid enumerated value.
54954   newvces:
54955     description: |
54956       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
54957     properties:
54958       newvce:
54959         type: array
54960         items:
54961           $ref: "#/patchDefinitions/newvce"
54962   notification-event:
54963     properties:
54964       cambria.partition:
54965         type: string
54966       notification-event-header:
54967         type: object
54968         $ref: "#/patchDefinitions/notification-event-header"
54969   notification-event-header:
54970     properties:
54971       id:
54972         type: string
54973       timestamp:
54974         type: string
54975       source-name:
54976         type: string
54977       domain:
54978         type: string
54979       sequence-number:
54980         type: string
54981       severity:
54982         type: string
54983       event-type:
54984         type: string
54985       version:
54986         type: string
54987       action:
54988         type: string
54989       entity-type:
54990         type: string
54991       top-entity-type:
54992         type: string
54993       entity-link:
54994         type: string
54995       status:
54996         type: string
54997   notify:
54998     required:
54999     - event-id
55000     properties:
55001       event-id:
55002         type: string
55003       node-type:
55004         type: string
55005       event-trigger:
55006         type: string
55007       key-data:
55008         type: array
55009         items:
55010           $ref: "#/patchDefinitions/key-data"
55011       selflink:
55012         type: string
55013   oam-network:
55014     description: |
55015       OAM network, to be deprecated shortly.  Do not use for new purposes.
55016       ###### Related Nodes
55017       - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
55018       - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
55019       - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
55020     required:
55021     - network-uuid
55022     - network-name
55023     - cvlan-tag
55024     properties:
55025       network-uuid:
55026         type: string
55027         description: UUID of the network. Unique across a cloud-region
55028       network-name:
55029         type: string
55030         description: Name of the network.
55031       cvlan-tag:
55032         type: integer
55033         format: int64
55034         description: cvlan-id
55035       ipv4-oam-gateway-address:
55036         type: string
55037         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
55038       ipv4-oam-gateway-address-prefix-length:
55039         type: integer
55040         format: int32
55041         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
55042   oam-networks:
55043     description: |
55044       Collection of OAM networks, to be deprecated shortly.  Do not use for new purposes.
55045     properties:
55046       oam-network:
55047         type: array
55048         items:
55049           $ref: "#/patchDefinitions/oam-network"
55050   operational-environment:
55051     description: |
55052       It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
55053       ###### Related Nodes
55054       - TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
55055       - FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
55056     required:
55057     - operational-environment-id
55058     - operational-environment-name
55059     - operational-environment-type
55060     - operational-environment-status
55061     - tenant-context
55062     - workload-context
55063     properties:
55064       operational-environment-id:
55065         type: string
55066         description: UUID of an operational environment
55067       operational-environment-name:
55068         type: string
55069         description: Operational Environment name
55070       operational-environment-type:
55071         type: string
55072         description: Operational Environment Type.
55073       operational-environment-status:
55074         type: string
55075         description: Status
55076       tenant-context:
55077         type: string
55078         description: Tenant Context.
55079       workload-context:
55080         type: string
55081         description: Workload Context.
55082   operational-environments:
55083     description: |
55084       a logical partition of the cloud which allows to have multiple environments in the production AIC.
55085     properties:
55086       operational-environment:
55087         type: array
55088         items:
55089           $ref: "#/patchDefinitions/operational-environment"
55090   overloaded-model:
55091     description: |
55092       Allows for legacy POST of old-style and new-style models
55093     required:
55094     - model-invariant-id
55095     - model-name-version-id
55096     - model-type
55097     - model-name
55098     - model-id
55099     - model-version
55100     properties:
55101       model-invariant-id:
55102         type: string
55103         description: Unique identifier corresponding to the main definition of a model in ASDC
55104       model-name-version-id:
55105         type: string
55106         description: Unique identifier corresponding to one version of a model in ASDC
55107       model-type:
55108         type: string
55109         description: Type of the model, e.g., service, resource, widget, etc.
55110       model-name:
55111         type: string
55112         description: Name of the model, which can change from version to version.
55113       model-id:
55114         type: string
55115         description: Invariant unique ID which does not change from version to version
55116       model-version:
55117         type: string
55118         description: Version
55119       model-description:
55120         type: string
55121         description: Description
55122   owning-entities:
55123     description: |
55124       Collection of owning-entities
55125     properties:
55126       owning-entity:
55127         type: array
55128         items:
55129           $ref: "#/patchDefinitions/owning-entity"
55130   owning-entity:
55131     description: |
55132       describes an owning-entity
55133       ###### Related Nodes
55134       - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
55135     required:
55136     - owning-entity-id
55137     - owning-entity-name
55138     properties:
55139       owning-entity-id:
55140         type: string
55141         description: UUID of an owning entity
55142       owning-entity-name:
55143         type: string
55144         description: Owning entity name
55145   p-interface:
55146     description: |
55147       Physical interface (e.g., nic)
55148       ###### Related Nodes
55149       - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
55150       - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
55151       - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
55152       - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
55153       - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
55154       - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
55155       - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
55156       - P-INTERFACE is DELETED when these are DELETED L-INTERFACE
55157       - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK
55158     required:
55159     - interface-name
55160     properties:
55161       interface-name:
55162         type: string
55163         description: Name that identifies the physical interface
55164       speed-value:
55165         type: string
55166         description: Captures the numeric part of the speed
55167       speed-units:
55168         type: string
55169         description: Captures the units corresponding to the speed
55170       port-description:
55171         type: string
55172         description: Nature of the services and connectivity on this port.
55173       equipment-identifier:
55174         type: string
55175         description: CLEI or other specification for p-interface hardware.
55176       interface-role:
55177         type: string
55178         description: Role specification for p-interface hardware.
55179       interface-type:
55180         type: string
55181         description: Indicates the physical properties of the interface.
55182       prov-status:
55183         type: string
55184         description: Trigger for operational monitoring of this resource by Service Assurance systems.
55185   p-interfaces:
55186     description: |
55187       Collection of physical interfaces.
55188     properties:
55189       p-interface:
55190         type: array
55191         items:
55192           $ref: "#/patchDefinitions/p-interface"
55193   physical-link:
55194     description: |
55195       Collection of physical connections, typically between p-interfaces
55196       ###### Related Nodes
55197       - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
55198     required:
55199     - link-name
55200     properties:
55201       link-name:
55202         type: string
55203         description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
55204       speed-value:
55205         type: string
55206         description: Captures the numeric part of the speed
55207       speed-units:
55208         type: string
55209         description: Captures the units corresponding to the speed
55210       circuit-id:
55211         type: string
55212         description: Circuit it
55213       dual-mode:
55214         type: string
55215         description: Dual access mode (e.g., primary, secondary
55216       management-option:
55217         type: string
55218         description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
55219       service-provider-name:
55220         type: string
55221         description: Name of the service Provider on this link.
55222   physical-links:
55223     description: |
55224       Collection of physical connections, typically between p-interfaces
55225     properties:
55226       physical-link:
55227         type: array
55228         items:
55229           $ref: "#/patchDefinitions/physical-link"
55230   platform:
55231     description: |
55232       describes a platform
55233       ###### Related Nodes
55234       - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
55235     required:
55236     - platform-name
55237     properties:
55238       platform-name:
55239         type: string
55240         description: Name of the platform
55241   platforms:
55242     description: |
55243       Collection of platforms
55244     properties:
55245       platform:
55246         type: array
55247         items:
55248           $ref: "#/patchDefinitions/platform"
55249   pnf:
55250     description: |
55251       PNF represents a physical network function. typically equipment used in the D1 world.
55252       ###### Related Nodes
55253       - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
55254       - TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
55255       - TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
55256       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
55257       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
55258       - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
55259       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
55260       - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
55261     required:
55262     - pnf-name
55263     - in-maint
55264     properties:
55265       pnf-name:
55266         type: string
55267         description: unique name of Physical Network Function.
55268       pnf-name2:
55269         type: string
55270         description: name of Physical Network Function.
55271       pnf-name2-source:
55272         type: string
55273         description: source of name2
55274       pnf-id:
55275         type: string
55276         description: id of pnf
55277       equip-type:
55278         type: string
55279         description: Equipment type.  Source of truth should define valid values.
55280       equip-vendor:
55281         type: string
55282         description: Equipment vendor.  Source of truth should define valid values.
55283       equip-model:
55284         type: string
55285         description: Equipment model.  Source of truth should define valid values.
55286       management-option:
55287         type: string
55288         description: identifier of managed by company or customer
55289       ipaddress-v4-oam:
55290         type: string
55291         description: ipv4-oam-address with new naming convention for IP addresses
55292       sw-version:
55293         type: string
55294         description: sw-version is the version of SW for the hosted application on the PNF.
55295       in-maint:
55296         type: boolean
55297       frame-id:
55298         type: string
55299         description: ID of the physical frame (relay rack) where pnf is installed.
55300       serial-number:
55301         type: string
55302         description: Serial number of the device
55303       ipaddress-v4-loopback-0:
55304         type: string
55305         description: IPV4 Loopback 0 address
55306       ipaddress-v6-loopback-0:
55307         type: string
55308         description: IPV6 Loopback 0 address
55309       ipaddress-v4-aim:
55310         type: string
55311         description: IPV4 AIM address
55312       ipaddress-v6-aim:
55313         type: string
55314         description: IPV6 AIM address
55315       ipaddress-v6-oam:
55316         type: string
55317         description: IPV6 OAM address
55318       inv-status:
55319         type: string
55320         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
55321   pnfs:
55322     description: |
55323       Collection of Physical Network Functions.
55324     properties:
55325       pnf:
55326         type: array
55327         items:
55328           $ref: "#/patchDefinitions/pnf"
55329   port-group:
55330     description: |
55331       Used to capture the network interfaces of this VCE
55332       ###### Related Nodes
55333       - TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
55334       - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE)
55335       - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG
55336     required:
55337     - interface-id
55338     - orchestration-status
55339     properties:
55340       interface-id:
55341         type: string
55342         description: Unique ID of the interface
55343       neutron-network-id:
55344         type: string
55345         description: Neutron network id of this Interface
55346       neutron-network-name:
55347         type: string
55348         description: Neutron network name of this Interface
55349       interface-role:
55350         type: string
55351         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
55352   port-groups:
55353     properties:
55354       port-group:
55355         type: array
55356         items:
55357           $ref: "#/patchDefinitions/port-group"
55358   project:
55359     description: |
55360       describes the project
55361       ###### Related Nodes
55362       - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
55363     required:
55364     - project-name
55365     properties:
55366       project-name:
55367         type: string
55368         description: Name of the project deploying a service
55369   projects:
55370     description: |
55371       Collection of projects
55372     properties:
55373       project:
55374         type: array
55375         items:
55376           $ref: "#/patchDefinitions/project"
55377   properties:
55378     description: |
55379       Property holder for query properties or instance properties
55380     properties:
55381       property-name:
55382         type: string
55383       property-value:
55384         type: string
55385   property-constraint:
55386     description: |
55387       TBD
55388       ###### Related Nodes
55389       - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
55390     required:
55391     - property-constraint-uuid
55392     - constraint-type
55393     - property-name
55394     - property-value
55395     properties:
55396       property-constraint-uuid:
55397         type: string
55398       constraint-type:
55399         type: string
55400       property-name:
55401         type: string
55402       property-value:
55403         type: string
55404   property-constraints:
55405     properties:
55406       property-constraint:
55407         type: array
55408         items:
55409           $ref: "#/patchDefinitions/property-constraint"
55410   pserver:
55411     description: |
55412       Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
55413       ###### Related Nodes
55414       - TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
55415       - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
55416       - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
55417       - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
55418       - TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
55419       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
55420       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
55421       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
55422       - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
55423       - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
55424       - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER
55425       - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
55426       - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT
55427     required:
55428     - hostname
55429     - in-maint
55430     properties:
55431       hostname:
55432         type: string
55433         description: Value from executing hostname on the compute node.
55434       ptnii-equip-name:
55435         type: string
55436         description: PTNII name
55437       number-of-cpus:
55438         type: integer
55439         format: int32
55440         description: Number of cpus
55441       disk-in-gigabytes:
55442         type: integer
55443         format: int32
55444         description: Disk size, in GBs
55445       ram-in-megabytes:
55446         type: integer
55447         format: int32
55448         description: RAM size, in MBs
55449       equip-type:
55450         type: string
55451         description: Equipment type.  Source of truth should define valid values.
55452       equip-vendor:
55453         type: string
55454         description: Equipment vendor.  Source of truth should define valid values.
55455       equip-model:
55456         type: string
55457         description: Equipment model.  Source of truth should define valid values.
55458       fqdn:
55459         type: string
55460         description: Fully-qualified domain name
55461       pserver-selflink:
55462         type: string
55463         description: URL to endpoint where AAI can get more details
55464       ipv4-oam-address:
55465         type: string
55466         description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
55467       serial-number:
55468         type: string
55469         description: Serial number, may be queried
55470       ipaddress-v4-loopback-0:
55471         type: string
55472         description: IPV4 Loopback 0 address
55473       ipaddress-v6-loopback-0:
55474         type: string
55475         description: IPV6 Loopback 0 address
55476       ipaddress-v4-aim:
55477         type: string
55478         description: IPV4 AIM address
55479       ipaddress-v6-aim:
55480         type: string
55481         description: IPV6 AIM address
55482       ipaddress-v6-oam:
55483         type: string
55484         description: IPV6 OAM address
55485       inv-status:
55486         type: string
55487         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
55488       pserver-id:
55489         type: string
55490         description: ID of Pserver
55491       internet-topology:
55492         type: string
55493         description: internet topology of Pserver
55494       in-maint:
55495         type: boolean
55496   pservers:
55497     description: |
55498       Collection of compute hosts.
55499     properties:
55500       pserver:
55501         type: array
55502         items:
55503           $ref: "#/patchDefinitions/pserver"
55504   query-parameters:
55505     description: |
55506       QueryParameters for performing a named-query or model query
55507     properties:
55508       named-query:
55509         type: object
55510         $ref: "#/patchDefinitions/named-query"
55511       overloaded-model:
55512         type: object
55513         $ref: "#/patchDefinitions/overloaded-model"
55514   related-lookup:
55515     description: |
55516       TBD
55517       ###### Related Nodes
55518       - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
55519     required:
55520     - related-lookup-uuid
55521     - source-node-type
55522     - source-node-property
55523     - target-node-type
55524     - target-node-property
55525     properties:
55526       related-lookup-uuid:
55527         type: string
55528       source-node-type:
55529         type: string
55530       source-node-property:
55531         type: string
55532       target-node-type:
55533         type: string
55534       target-node-property:
55535         type: string
55536       property-collect-list:
55537         type: string
55538   related-lookups:
55539     properties:
55540       related-lookup:
55541         type: array
55542         items:
55543           $ref: "#/patchDefinitions/related-lookup"
55544   related-to-property:
55545     properties:
55546       property-key:
55547         type: string
55548         description: Key part of a key/value pair
55549       property-value:
55550         type: string
55551         description: Value part of a key/value pair
55552   relationship:
55553     properties:
55554       related-to:
55555         type: string
55556         description: A keyword provided by A&AI to indicate type of node.
55557       related-link:
55558         type: string
55559         description: URL to the object in A&AI.
55560       relationship-data:
55561         type: array
55562         items:
55563           $ref: "#/patchDefinitions/relationship-data"
55564       related-to-property:
55565         type: array
55566         items:
55567           $ref: "#/patchDefinitions/related-to-property"
55568   relationship-data:
55569     required:
55570     - relationship-key
55571     - relationship-value
55572     properties:
55573       relationship-key:
55574         type: string
55575         description: A keyword provided by A&AI to indicate an attribute.
55576       relationship-value:
55577         type: string
55578         description: Value of the attribute.
55579   reserved-prop-names:
55580     description: |
55581       Internal map to define some reserved properties of a vertex
55582     properties:
55583       last-mod-source-of-truth:
55584         type: string
55585       aai-node-type:
55586         type: string
55587       aai-created-ts:
55588         type: integer
55589         format: int64
55590       aai-unique-key:
55591         type: string
55592       aai-last-mod-ts:
55593         type: integer
55594         format: int64
55595       source-of-truth:
55596         type: string
55597       aai-uri:
55598         type: string
55599   response-list:
55600     description: |
55601       Response container for the results of a named-query or model query
55602     properties:
55603       inventory-response-items:
55604         type: object
55605         $ref: "#/patchDefinitions/inventory-response-items"
55606   result-data:
55607     properties:
55608       resource-type:
55609         type: string
55610         description: The specific type of node in the A&AI graph
55611       resource-link:
55612         type: string
55613         description: The URL to the specific resource
55614   route-table-reference:
55615     description: |
55616       Openstack route table reference.
55617       ###### Related Nodes
55618       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
55619     required:
55620     - route-table-reference-id
55621     - route-table-reference-fqdn
55622     properties:
55623       route-table-reference-id:
55624         type: string
55625         description: Route Table Reference id, UUID assigned to this instance.
55626       route-table-reference-fqdn:
55627         type: string
55628         description: FQDN entry in the route table.
55629   route-table-references:
55630     description: |
55631       Collection of openstack route table references
55632     properties:
55633       route-table-reference:
55634         type: array
55635         items:
55636           $ref: "#/patchDefinitions/route-table-reference"
55637   route-target:
55638     description: |
55639       Route target information
55640       ###### Related Nodes
55641       - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
55642     required:
55643     - global-route-target
55644     - route-target-role
55645     properties:
55646       global-route-target:
55647         type: string
55648         description: Number used to identify an RT, globally unique in the network
55649       route-target-role:
55650         type: string
55651         description: Role assigned to this route target
55652   route-targets:
55653     description: |
55654       Collection of route target information
55655     properties:
55656       route-target:
55657         type: array
55658         items:
55659           $ref: "#/patchDefinitions/route-target"
55660   routing-instance:
55661     description: |
55662       ###### Related Nodes
55663       - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
55664       - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
55665       - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR
55666     required:
55667     - routing-instance-id
55668     properties:
55669       routing-instance-id:
55670         type: string
55671         description: Unique id of routing instance
55672       rpm-owner:
55673         type: string
55674         description: rpm owner
55675   routing-instances:
55676     description: |
55677       set of probes related to generic-vnf routing instance
55678     properties:
55679       routing-instance:
55680         type: array
55681         items:
55682           $ref: "#/patchDefinitions/routing-instance"
55683   sdn-zone-response:
55684     properties:
55685       oam-networks:
55686         type: object
55687         $ref: "#/patchDefinitions/oam-networks"
55688       az-and-dvs-switches:
55689         type: array
55690         items:
55691           $ref: "#/patchDefinitions/az-and-dvs-switches"
55692   search:
55693     properties:
55694       edge-tag-query-result:
55695         type: object
55696         $ref: "#/patchDefinitions/edge-tag-query-result"
55697       edge-tag-query-request:
55698         type: object
55699         $ref: "#/patchDefinitions/edge-tag-query-request"
55700       search-results:
55701         type: object
55702         $ref: "#/patchDefinitions/search-results"
55703       sdn-zone-response:
55704         type: object
55705         $ref: "#/patchDefinitions/sdn-zone-response"
55706   search-results:
55707     properties:
55708       result-data:
55709         type: array
55710         items:
55711           $ref: "#/patchDefinitions/result-data"
55712   secondary-filt:
55713     description: |
55714       SecondaryFilt for performing a named-query or model query
55715   secondary-filter:
55716     properties:
55717       property-name:
55718         type: string
55719       filter-type:
55720         type: string
55721       property-value:
55722         type: string
55723   secondary-filts:
55724     description: |
55725       SecondaryFilts for performing a named-query or model query
55726     properties:
55727       secondary-filt:
55728         type: array
55729         items:
55730           $ref: "#/patchDefinitions/secondary-filt"
55731   segmentation-assignment:
55732     description: |
55733       Openstack segmentation assignment.
55734       ###### Related Nodes
55735       - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
55736     required:
55737     - segmentation-id
55738     properties:
55739       segmentation-id:
55740         type: string
55741         description: Route Table Reference id, UUID assigned to this instance.
55742   segmentation-assignments:
55743     description: |
55744       Collection of openstack segmentation assignments
55745     properties:
55746       segmentation-assignment:
55747         type: array
55748         items:
55749           $ref: "#/patchDefinitions/segmentation-assignment"
55750   service:
55751     description: |
55752       Stand-in for service model definitions.  Likely to be deprecated in favor of models from ASDC.  Does not strictly map to ASDC services.
55753     required:
55754     - service-id
55755     - service-description
55756     properties:
55757       service-id:
55758         type: string
55759         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
55760       service-description:
55761         type: string
55762         description: Description of the service
55763       service-selflink:
55764         type: string
55765         description: URL to endpoint where AAI can get more details
55766   service-capabilities:
55767     description: |
55768       Collection of service capabilities.
55769     properties:
55770       service-capability:
55771         type: array
55772         items:
55773           $ref: "#/patchDefinitions/service-capability"
55774   service-capability:
55775     description: |
55776       Early definition of server/resource pairings, likely to be replaced by models.  No new use should be made of this.
55777       ###### Related Nodes
55778       - FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
55779       - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
55780       - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK
55781     required:
55782     - service-type
55783     - vnf-type
55784     properties:
55785       service-type:
55786         type: string
55787         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
55788       vnf-type:
55789         type: string
55790         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
55791   service-design-and-creation:
55792     description: |
55793       Namespace for objects managed by ASDC
55794     properties:
55795       vnf-images:
55796         type: array
55797         items:
55798           $ref: "#/patchDefinitions/vnf-image"
55799       services:
55800         type: array
55801         items:
55802           $ref: "#/patchDefinitions/service"
55803       service-capabilities:
55804         type: array
55805         items:
55806           $ref: "#/patchDefinitions/service-capability"
55807       models:
55808         type: array
55809         items:
55810           $ref: "#/patchDefinitions/model"
55811       named-queries:
55812         type: array
55813         items:
55814           $ref: "#/patchDefinitions/named-query"
55815   service-instance:
55816     description: |
55817       Instance of a service
55818       ###### Related Nodes
55819       - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
55820       - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
55821       - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
55822       - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
55823       - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
55824       - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY)
55825       - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
55826       - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
55827       - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
55828       - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
55829       - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
55830       - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
55831       - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
55832       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
55833       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
55834       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
55835       - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM
55836       - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
55837     required:
55838     - service-instance-id
55839     properties:
55840       service-instance-id:
55841         type: string
55842         description: Uniquely identifies this instance of a service
55843       service-instance-name:
55844         type: string
55845         description: This field will store a name assigned to the service-instance.
55846       persona-model-id:
55847         type: string
55848         description: the ASDC model id for this resource or service model.
55849       persona-model-version:
55850         type: string
55851         description: the ASDC model version for this resource or service model.
55852       model-version-id:
55853         type: string
55854         description: the ASDC model version for this resource or service model.
55855       widget-model-id:
55856         type: string
55857         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
55858       widget-model-version:
55859         type: string
55860         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
55861       bandwidth-total:
55862         type: string
55863         description: Indicates the total bandwidth to be used for this service.
55864       bandwidth-up-wan1:
55865         type: string
55866         description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
55867       bandwidth-down-wan1:
55868         type: string
55869         description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
55870       bandwidth-up-wan2:
55871         type: string
55872         description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
55873       bandwidth-down-wan2:
55874         type: string
55875         description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
55876       vhn-portal-url:
55877         type: string
55878         description: URL customers will use to access the vHN Portal.
55879       service-instance-location-id:
55880         type: string
55881         description: An identifier that customers assign to the location where this service is being used.
55882   service-instances:
55883     description: |
55884       Collection of service instances
55885     properties:
55886       service-instance:
55887         type: array
55888         items:
55889           $ref: "#/patchDefinitions/service-instance"
55890   service-subscription:
55891     description: |
55892       Object that group service instances.
55893       ###### Related Nodes
55894       - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
55895       - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
55896       - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
55897       - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE
55898     required:
55899     - service-type
55900     properties:
55901       service-type:
55902         type: string
55903         description: Value defined by orchestration to identify this service across ECOMP.
55904       temp-ub-sub-account-id:
55905         type: string
55906         description: This property will be deleted from A&AI in the near future. Only stop gap solution.
55907   service-subscriptions:
55908     description: |
55909       Collection of objects that group service instances.
55910     properties:
55911       service-subscription:
55912         type: array
55913         items:
55914           $ref: "#/patchDefinitions/service-subscription"
55915   services:
55916     description: |
55917       Collection of service model definitions.  Likely to be deprecated in favor of models from ASDC.
55918     properties:
55919       service:
55920         type: array
55921         items:
55922           $ref: "#/patchDefinitions/service"
55923   site-pair:
55924     description: |
55925       ###### Related Nodes
55926       - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
55927       - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
55928       - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE
55929     required:
55930     - site-pair-id
55931     properties:
55932       site-pair-id:
55933         type: string
55934         description: unique identifier of probe
55935       source-ip:
55936         type: string
55937         description: Prefix address
55938       destination-ip:
55939         type: string
55940         description: Prefix address
55941       ip-version:
55942         type: string
55943         description: ip version, v4, v6
55944       destination-hostname:
55945         type: string
55946         description: Hostname of the destination equipment to which SLAs are measured against.
55947       destination-equip-type:
55948         type: string
55949         description: The type of destinatination equipment. Could be Router, etc.
55950   site-pair-set:
55951     description: |
55952       Set of instances for probes used to measure service level agreements
55953       ###### Related Nodes
55954       - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
55955       - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
55956       - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE
55957     required:
55958     - site-pair-set-id
55959     properties:
55960       site-pair-set-id:
55961         type: string
55962         description: Unique id of site pair set.
55963   site-pair-sets:
55964     description: |
55965       Collection of sets of instances for probes related to generic-vnf
55966     properties:
55967       site-pair-set:
55968         type: array
55969         items:
55970           $ref: "#/patchDefinitions/site-pair-set"
55971   site-pairs:
55972     description: |
55973       probe within a set
55974     properties:
55975       site-pair:
55976         type: array
55977         items:
55978           $ref: "#/patchDefinitions/site-pair"
55979   snapshot:
55980     description: |
55981       Openstack snapshot
55982       ###### Related Nodes
55983       - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
55984       - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
55985     required:
55986     - snapshot-id
55987     properties:
55988       snapshot-id:
55989         type: string
55990         description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
55991       snapshot-name:
55992         type: string
55993         description: Snapshot name
55994       snapshot-architecture:
55995         type: string
55996         description: Operating system architecture
55997       snapshot-os-distro:
55998         type: string
55999         description: The common name of the operating system distribution in lowercase
56000       snapshot-os-version:
56001         type: string
56002         description: The operating system version as specified by the distributor.
56003       application:
56004         type: string
56005         description: The application that the image instantiates.
56006       application-vendor:
56007         type: string
56008         description: The vendor of the application.
56009       application-version:
56010         type: string
56011         description: The version of the application.
56012       snapshot-selflink:
56013         type: string
56014         description: URL to endpoint where AAI can get more details
56015       prev-snapshot-id:
56016         type: string
56017         description: This field contains the UUID of the previous snapshot (if any).
56018   snapshots:
56019     description: |
56020       Collection of openstack snapshots
56021     properties:
56022       snapshot:
56023         type: array
56024         items:
56025           $ref: "#/patchDefinitions/snapshot"
56026   sriov-pf:
56027     description: |
56028       SR-IOV Physical Function
56029       ###### Related Nodes
56030       - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
56031       - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
56032     required:
56033     - pf-pci-id
56034     properties:
56035       pf-pci-id:
56036         type: string
56037         description: Identifier for the sriov-pf
56038   sriov-pfs:
56039     description: |
56040       Collection of SR-IOV Physical Functions.
56041     properties:
56042       sriov-pf:
56043         type: array
56044         items:
56045           $ref: "#/patchDefinitions/sriov-pf"
56046   sriov-vf:
56047     description: |
56048       SR-IOV Virtual Function (not to be confused with virtual network function)
56049       ###### Related Nodes
56050       - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
56051     required:
56052     - pci-id
56053     properties:
56054       pci-id:
56055         type: string
56056         description: PCI ID used to identify the sriov-vf
56057       vf-vlan-filter:
56058         type: string
56059         description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
56060       vf-mac-filter:
56061         type: string
56062         description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
56063       vf-vlan-strip:
56064         type: boolean
56065         description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
56066       vf-vlan-anti-spoof-check:
56067         type: boolean
56068         description: This option ensures anti VLAN spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.
56069       vf-mac-anti-spoof-check:
56070         type: boolean
56071         description: This option ensures anti MAC spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.
56072       vf-mirrors:
56073         type: string
56074         description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
56075       vf-broadcast-allow:
56076         type: boolean
56077         description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
56078       vf-unknown-multicast-allow:
56079         type: boolean
56080         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
56081       vf-unknown-unicast-allow:
56082         type: boolean
56083         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
56084       vf-insert-stag:
56085         type: boolean
56086         description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
56087       vf-link-status:
56088         type: string
56089         description: This option is used to set the link status.  Valid values as of 1607 are on, off, and auto.
56090   sriov-vfs:
56091     description: |
56092       Collection of SR-IOV Virtual Functions.
56093     properties:
56094       sriov-vf:
56095         type: array
56096         items:
56097           $ref: "#/patchDefinitions/sriov-vf"
56098   start-node-filter:
56099     properties:
56100       property-name:
56101         type: string
56102       property-value:
56103         type: string
56104   subnet:
56105     description: |
56106       ###### Related Nodes
56107       - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
56108       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
56109       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
56110       - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
56111     required:
56112     - subnet-id
56113     - dhcp-enabled
56114     properties:
56115       subnet-id:
56116         type: string
56117         description: Subnet ID, should be UUID.
56118       subnet-name:
56119         type: string
56120         description: Name associated with the subnet.
56121       neutron-subnet-id:
56122         type: string
56123         description: Neutron id of this subnet
56124       gateway-address:
56125         type: string
56126         description: gateway ip address
56127       network-start-address:
56128         type: string
56129         description: network start address
56130       cidr-mask:
56131         type: string
56132         description: cidr mask
56133       ip-version:
56134         type: string
56135         description: ip version
56136       orchestration-status:
56137         type: string
56138         description: Orchestration status of this VNF, mastered by MSO
56139       dhcp-enabled:
56140         type: boolean
56141       dhcp-start:
56142         type: string
56143         description: the start address reserved for use by dhcp
56144       dhcp-end:
56145         type: string
56146         description: the last address reserved for use by dhcp
56147   subnets:
56148     properties:
56149       subnet:
56150         type: array
56151         items:
56152           $ref: "#/patchDefinitions/subnet"
56153   tagged-inventory-item-list:
56154     properties:
56155       inventory-item:
56156         type: array
56157         items:
56158           $ref: "#/patchDefinitions/inventory-item"
56159   tenant:
56160     description: |
56161       Openstack tenant
56162       ###### Related Nodes
56163       - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
56164       - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
56165       - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
56166       - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
56167       - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
56168       - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
56169       - TENANT cannot be deleted if linked to VSERVER
56170     required:
56171     - tenant-id
56172     - tenant-name
56173     properties:
56174       tenant-id:
56175         type: string
56176         description: Unique id relative to the cloud-region.
56177       tenant-name:
56178         type: string
56179         description: Readable name of tenant
56180   tenants:
56181     description: |
56182       Collection of openstack tenants.
56183     properties:
56184       tenant:
56185         type: array
56186         items:
56187           $ref: "#/patchDefinitions/tenant"
56188   tunnel-xconnect:
56189     description: |
56190       Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
56191       ###### Related Nodes
56192       - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
56193     required:
56194     - id
56195     - bandwidth-up-wan1
56196     - bandwidth-down-wan1
56197     - bandwidth-up-wan2
56198     - bandwidth-down-wan2
56199     properties:
56200       id:
56201         type: string
56202         description: Allotted Resource id UUID assigned to this instance.
56203       bandwidth-up-wan1:
56204         type: string
56205         description: The WAN uplink bandwidth for WAN1
56206       bandwidth-down-wan1:
56207         type: string
56208         description: The WAN downlink bandwidth for WAN1
56209       bandwidth-up-wan2:
56210         type: string
56211         description: The WAN uplink bandwidth for WAN2
56212       bandwidth-down-wan2:
56213         type: string
56214         description: The WAN downlink bandwidth for WAN2
56215   tunnel-xconnects:
56216     description: |
56217       This object is used to store the specific tunnel cross connect aspects of an allotted resource
56218     properties:
56219       tunnel-xconnect:
56220         type: array
56221         items:
56222           $ref: "#/patchDefinitions/tunnel-xconnect"
56223   update:
56224     description: |
56225       Serves a PATCH like function.  Does not enforce concurrency control.  Clear each usage with AAI team.
56226     required:
56227     - update-node-type
56228     properties:
56229       update-node-type:
56230         type: string
56231       update-node-key:
56232         type: array
56233         items:
56234           $ref: "#/patchDefinitions/update-node-key"
56235       update-node-uri:
56236         type: string
56237       action:
56238         type: array
56239         items:
56240           $ref: "#/patchDefinitions/action"
56241   update-node-key:
56242     properties:
56243       key-name:
56244         type: string
56245       key-value:
56246         type: string
56247   vce:
56248     description: |
56249       Virtual Customer Edge Router, used specifically for Gamma.  This object is deprecated.
56250       ###### Related Nodes
56251       - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
56252       - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
56253       - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY)
56254       - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
56255       - FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
56256       - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
56257       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
56258       - VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP
56259     required:
56260     - vnf-id
56261     - vnf-name
56262     - vnf-type
56263     properties:
56264       vnf-id:
56265         type: string
56266         description: Unique id of VNF.  This is unique across the graph.
56267       vnf-name:
56268         type: string
56269         description: Name of VNF.
56270       vnf-name2:
56271         type: string
56272         description: Alternate name of VNF.
56273       vnf-type:
56274         type: string
56275         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
56276       service-id:
56277         type: string
56278         description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
56279       regional-resource-zone:
56280         type: string
56281         description: Regional way of organizing pservers, source of truth should define values
56282       prov-status:
56283         type: string
56284         description: Trigger for operational monitoring of this resource by Service Assurance systems.
56285       operational-state:
56286         type: string
56287         description: Indicator for whether the resource is considered operational
56288       license-key:
56289         type: string
56290         description: OBSOLETE -  do not use
56291       equipment-role:
56292         type: string
56293         description: Network role being played by this VNF
56294       orchestration-status:
56295         type: string
56296         description: Orchestration status of this VNF, mastered by MSO
56297       heat-stack-id:
56298         type: string
56299         description: Heat stack id corresponding to this instance, managed by MSO
56300       mso-catalog-key:
56301         type: string
56302         description: Corresponds to the SDN-C catalog id used to configure this VCE
56303       vpe-id:
56304         type: string
56305         description: Unique ID of VPE connected to this VCE.
56306       v6-vce-wan-address:
56307         type: string
56308         description: Valid v6 IP address for the WAN Link on this router.  Implied length of /64.
56309       ipv4-oam-address:
56310         type: string
56311         description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
56312   vces:
56313     description: |
56314       Collection of Virtual Customer Edge Routers, used specifically for Gamma.  This object is deprecated.
56315     properties:
56316       vce:
56317         type: array
56318         items:
56319           $ref: "#/patchDefinitions/vce"
56320   vf-module:
56321     description: |
56322       a deployment unit of VNFCs
56323       ###### Related Nodes
56324       - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
56325       - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
56326       - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
56327       - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
56328       - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
56329       - VF-MODULE cannot be deleted if linked to VNFC
56330     required:
56331     - vf-module-id
56332     - is-base-vf-module
56333     properties:
56334       vf-module-id:
56335         type: string
56336         description: Unique ID of vf-module.
56337       vf-module-name:
56338         type: string
56339         description: Name of vf-module
56340       heat-stack-id:
56341         type: string
56342         description: Heat stack id corresponding to this instance.
56343       orchestration-status:
56344         type: string
56345         description: orchestration status of this vf-module, mastered by MSO
56346       is-base-vf-module:
56347         type: boolean
56348   vf-modules:
56349     description: |
56350       Collection of vf-modules, a deployment unit of VNFCs
56351     properties:
56352       vf-module:
56353         type: array
56354         items:
56355           $ref: "#/patchDefinitions/vf-module"
56356   vig-server:
56357     description: |
56358       vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
56359       ###### Related Nodes
56360       - TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
56361     required:
56362     - vig-address-type
56363     properties:
56364       vig-address-type:
56365         type: string
56366         description: indicates whether the VIG is for AVPN or INTERNET
56367       ipaddress-v4-vig:
56368         type: string
56369         description: v4 IP of the vig server
56370       ipaddress-v6-vig:
56371         type: string
56372         description: v6 IP of the vig server
56373   vig-servers:
56374     properties:
56375       vig-server:
56376         type: array
56377         items:
56378           $ref: "#/patchDefinitions/vig-server"
56379   vip-ipv4-address-list:
56380     description: |
56381       IPv4 Address Range
56382       ###### Related Nodes
56383       - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
56384       - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
56385       - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
56386       - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
56387     required:
56388     - vip-ipv4-address
56389     properties:
56390       vip-ipv4-address:
56391         type: string
56392         description: IP address
56393       vip-ipv4-prefix-length:
56394         type: integer
56395         format: int64
56396         description: Prefix length, 32 for single address
56397       vlan-id-inner:
56398         type: integer
56399         format: int64
56400         description: Inner VLAN tag
56401       vlan-id-outer:
56402         type: integer
56403         format: int64
56404         description: Outer VLAN tag
56405       is-floating:
56406         type: boolean
56407         description: Indicator of fixed or floating address
56408   vip-ipv6-address-list:
56409     description: |
56410       IPv6 Address Range
56411       ###### Related Nodes
56412       - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
56413       - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
56414       - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
56415       - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
56416     required:
56417     - vip-ipv6-address
56418     properties:
56419       vip-ipv6-address:
56420         type: string
56421         description: IP address
56422       vip-ipv6-prefix-length:
56423         type: integer
56424         format: int64
56425         description: Prefix length, 128 for single address
56426       vlan-id-inner:
56427         type: integer
56428         format: int64
56429         description: Inner VLAN tag
56430       vlan-id-outer:
56431         type: integer
56432         format: int64
56433         description: Outer VLAN tag
56434       is-floating:
56435         type: boolean
56436         description: Indicator of fixed or floating address
56437   virtual-data-center:
56438     description: |
56439       Virtual organization of cloud infrastructure elements in a data center context
56440       ###### Related Nodes
56441       - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
56442       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
56443       - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
56444     required:
56445     - vdc-id
56446     - vdc-name
56447     properties:
56448       vdc-id:
56449         type: string
56450         description: Unique ID of the vdc
56451       vdc-name:
56452         type: string
56453         description: Name of the virtual data center
56454   virtual-data-centers:
56455     description: |
56456       Virtual organization of cloud infrastructure elements in a data center context
56457     properties:
56458       virtual-data-center:
56459         type: array
56460         items:
56461           $ref: "#/patchDefinitions/virtual-data-center"
56462   vlan:
56463     description: |
56464       Definition of vlan
56465       ###### Related Nodes
56466       - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
56467       - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
56468       - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
56469       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
56470       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
56471       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
56472       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
56473       - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
56474       - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK
56475     required:
56476     - vlan-interface
56477     properties:
56478       vlan-interface:
56479         type: string
56480         description: String that identifies the interface
56481       vlan-id-inner:
56482         type: integer
56483         format: int64
56484         description: Inner VLAN tag
56485       vlan-id-outer:
56486         type: integer
56487         format: int64
56488         description: Outer VLAN tag
56489   vlans:
56490     properties:
56491       vlan:
56492         type: array
56493         items:
56494           $ref: "#/patchDefinitions/vlan"
56495   vnf:
56496     description: |
56497       Abstract vnf class
56498     required:
56499     - vnf-id
56500     properties:
56501       vnf-id:
56502         type: string
56503         description: Unique id of VNF.  This is unique across the graph.
56504   vnf-image:
56505     description: |
56506       Image object that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
56507       ###### Related Nodes
56508       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
56509       - VNF-IMAGE cannot be deleted if linked to GENERIC-VNF
56510     required:
56511     - vnf-image-uuid
56512     - application
56513     - application-vendor
56514     properties:
56515       vnf-image-uuid:
56516         type: string
56517         description: Unique ID of this asset
56518       application:
56519         type: string
56520         description: The application that the image instantiates.
56521       application-vendor:
56522         type: string
56523         description: The vendor of the application.
56524       application-version:
56525         type: string
56526         description: The version of the application.
56527       selflink:
56528         type: string
56529         description: URL to endpoint where AAI can get more details
56530   vnf-images:
56531     description: |
56532       Collection of image objects that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
56533     properties:
56534       vnf-image:
56535         type: array
56536         items:
56537           $ref: "#/patchDefinitions/vnf-image"
56538   vnfc:
56539     description: |
56540       ###### Related Nodes
56541       - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
56542       - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
56543       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
56544     required:
56545     - vnfc-name
56546     - vnfc-function-code
56547     - vnfc-type
56548     - in-maint
56549     - is-closed-loop-disabled
56550     properties:
56551       vnfc-name:
56552         type: string
56553         description: Unique ID of vnfc.
56554       vnfc-function-code:
56555         type: string
56556         description: function code
56557       vnfc-type:
56558         type: string
56559         description: type
56560       prov-status:
56561         type: string
56562         description: prov status of this vnfc
56563       orchestration-status:
56564         type: string
56565         description: Orchestration status of this VNF, mastered by APP-C
56566       ipaddress-v4-oam-vip:
56567         type: string
56568         description: Oam V4 vip address of this vnfc
56569       in-maint:
56570         type: boolean
56571       is-closed-loop-disabled:
56572         type: boolean
56573       group-notation:
56574         type: string
56575         description: Group notation of VNFC
56576   vnfcs:
56577     description: |
56578       virtual network components associated with a vserver from application controller.
56579     properties:
56580       vnfc:
56581         type: array
56582         items:
56583           $ref: "#/patchDefinitions/vnfc"
56584   volume:
56585     description: |
56586       Ephemeral Block storage volume.
56587       ###### Related Nodes
56588       - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume)
56589     required:
56590     - volume-id
56591     - volume-selflink
56592     properties:
56593       volume-id:
56594         type: string
56595         description: Unique ID of block storage volume relative to the vserver.
56596       volume-selflink:
56597         type: string
56598         description: URL to endpoint where AAI can get more details
56599   volume-group:
56600     description: |
56601       Persistent block-level storage.
56602       ###### Related Nodes
56603       - TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
56604       - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
56605       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
56606       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
56607       - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
56608     required:
56609     - volume-group-id
56610     - volume-group-name
56611     - vnf-type
56612     properties:
56613       volume-group-id:
56614         type: string
56615         description: Unique ID of volume-group.
56616       volume-group-name:
56617         type: string
56618         description: Name of the volume group.
56619       heat-stack-id:
56620         type: string
56621         description: Heat stack id corresponding to this volume-group
56622       vnf-type:
56623         type: string
56624         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
56625       orchestration-status:
56626         type: string
56627         description: Orchestration status of this volume-group
56628       persona-model-customization-id:
56629         type: string
56630         description: captures the id of all the configuration used to customize the resource for the service.
56631       vf-module-persona-model-customization-id:
56632         type: string
56633         description: helps relate the volume group to the vf-module whose components will require the volume group
56634   volume-groups:
56635     description: |
56636       Collection of persistent block-level storage.
56637     properties:
56638       volume-group:
56639         type: array
56640         items:
56641           $ref: "#/patchDefinitions/volume-group"
56642   volumes:
56643     description: |
56644       Collection of ephemeral Block storage volumes.
56645     properties:
56646       volume:
56647         type: array
56648         items:
56649           $ref: "#/patchDefinitions/volume"
56650   vpls-pe:
56651     description: |
56652       VPLS Provider Edge routers.
56653       ###### Related Nodes
56654       - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
56655       - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
56656       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
56657       - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
56658       - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
56659     required:
56660     - equipment-name
56661     properties:
56662       equipment-name:
56663         type: string
56664       prov-status:
56665         type: string
56666         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
56667       ipv4-oam-address:
56668         type: string
56669         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by VPE (v4-loopback0-ip-address).
56670       equipment-role:
56671         type: string
56672         description: Client should send valid enumerated value, e.g., VPLS-PE.
56673       vlan-id-outer:
56674         type: integer
56675         format: int64
56676         description: Temporary location for stag to get to VCE
56677   vpls-pes:
56678     description: |
56679       Collection of VPLS Provider Edge routers
56680     properties:
56681       vpls-pe:
56682         type: array
56683         items:
56684           $ref: "#/patchDefinitions/vpls-pe"
56685   vpn-binding:
56686     description: |
56687       VPN binding
56688       ###### Related Nodes
56689       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
56690       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
56691       - VPN-BINDING cannot be deleted if linked to L3-NETWORK,LOGICAL-LINK
56692     required:
56693     - vpn-id
56694     - vpn-name
56695     - global-route-target
56696     - route-target-role
56697     properties:
56698       vpn-id:
56699         type: string
56700         description: VPN ID, globally unique within A&AI
56701       vpn-name:
56702         type: string
56703         description: VPN Name
56704       global-route-target:
56705         type: string
56706         description: Number used to identify a VPN, globally unique in the network
56707       vpn-platform:
56708         type: string
56709         description: the platform associated with the VPN example AVPN, Mobility
56710       vpn-type:
56711         type: string
56712         description: Type of the vpn, should be taken from enumerated/valid values
56713       route-distinguisher:
56714         type: string
56715         description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
56716       route-target-role:
56717         type: string
56718         description: Role assigned to this route target
56719   vpn-bindings:
56720     properties:
56721       vpn-binding:
56722         type: array
56723         items:
56724           $ref: "#/patchDefinitions/vpn-binding"
56725   vserver:
56726     description: |
56727       Virtual Servers, aka virtual machine or VM.
56728       ###### Related Nodes
56729       - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
56730       - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
56731       - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
56732       - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
56733       - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
56734       - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY)
56735       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
56736       - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY)
56737       - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
56738       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
56739       - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
56740       - VSERVER is DELETED when these are DELETED L-INTERFACE
56741       - VSERVER deletion means associated objects of these types are also DELETED:VOLUME
56742     required:
56743     - vserver-id
56744     - vserver-name
56745     - vserver-selflink
56746     - in-maint
56747     - is-closed-loop-disabled
56748     properties:
56749       vserver-id:
56750         type: string
56751         description: Unique identifier for this vserver relative to its tenant
56752       vserver-name:
56753         type: string
56754         description: Name of vserver
56755       vserver-name2:
56756         type: string
56757         description: Alternative name of vserver
56758       prov-status:
56759         type: string
56760         description: Trigger for operational monitoring of this resource by Service Assurance systems.
56761       vserver-selflink:
56762         type: string
56763         description: URL to endpoint where AAI can get more details
56764       in-maint:
56765         type: boolean
56766       is-closed-loop-disabled:
56767         type: boolean
56768   vservers:
56769     description: |
56770       Collection of virtual Servers, aka virtual machines or VMs.
56771     properties:
56772       vserver:
56773         type: array
56774         items:
56775           $ref: "#/patchDefinitions/vserver"
56776   zone:
56777     description: |
56778       A zone is a grouping of assets in a location homing to the same connections into the CBB
56779       ###### Related Nodes
56780       - TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
56781       - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
56782       - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
56783       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
56784     required:
56785     - zone-id
56786     - zone-name
56787     - design-type
56788     - zone-context
56789     properties:
56790       zone-id:
56791         type: string
56792         description: Code assigned by AIC to the zone
56793       zone-name:
56794         type: string
56795         description: English name associated with the zone
56796       design-type:
56797         type: string
56798         description: Design of zone [Medium/Large?]
56799       zone-context:
56800         type: string
56801         description: Context of zone [production/test]
56802       status:
56803         type: string
56804         description: Status of a zone.
56805   zones:
56806     description: |
56807       Collection of zones
56808     properties:
56809       zone:
56810         type: array
56811         items:
56812           $ref: "#/patchDefinitions/zone"
56813 getDefinitions:
56814   aai-internal:
56815     properties:
56816       property-name:
56817         type: string
56818       property-value:
56819         type: string
56820   action:
56821     properties:
56822       action-type:
56823         type: string
56824       action-data:
56825         type: array
56826         items:
56827           $ref: "#/getDefinitions/action-data"
56828   action-data:
56829     properties:
56830       property-name:
56831         type: string
56832       property-value:
56833         type: string
56834   actions:
56835     description: |
56836       APIs that are more action related than REST (e.g., notify, update).
56837     properties:
56838       update:
56839         type: object
56840         $ref: "#/getDefinitions/update"
56841       notify:
56842         type: object
56843         $ref: "#/getDefinitions/notify"
56844   allotted-resource:
56845     description: |
56846       Represents a slice or partial piece of a resource that gets separately allotted
56847       ###### Related Nodes
56848       - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
56849       - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
56850       - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
56851       - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
56852       - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
56853       - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
56854       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
56855       - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT
56856     required:
56857     - id
56858     properties:
56859       id:
56860         type: string
56861         description: Allotted Resource id UUID assigned to this instance.
56862       description:
56863         type: string
56864         description: The descriptive information assigned to this allotted resource instance
56865       selflink:
56866         type: string
56867         description: Link back to more information in the controller
56868       persona-model-id:
56869         type: string
56870         description: the ASDC model id for this resource or service model.
56871       persona-model-version:
56872         type: string
56873         description: the ASDC model version for this resource or service model.
56874       model-version-id:
56875         type: string
56876         description: the ASDC model version for this resource or service model.
56877       persona-model-customization-id:
56878         type: string
56879         description: captures the id of all the configuration used to customize the resource for the service.
56880       resource-version:
56881         type: string
56882         description: Concurrency value
56883       tunnel-xconnects:
56884         type: array
56885         items:
56886           $ref: "#/getDefinitions/tunnel-xconnect"
56887       relationship-list:
56888         type: array
56889         items:
56890           $ref: "#/getDefinitions/relationship"
56891   allotted-resources:
56892     description: |
56893       This object is used to store slices of services being offered
56894     properties:
56895       allotted-resource:
56896         type: array
56897         items:
56898           $ref: "#/getDefinitions/allotted-resource"
56899   availability-zone:
56900     description: |
56901       Availability zone, a collection of compute hosts/pservers
56902       ###### Related Nodes
56903       - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
56904       - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
56905       - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
56906       - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
56907       - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
56908       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
56909       - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
56910       - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
56911       - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
56912     required:
56913     - availability-zone-name
56914     - hypervisor-type
56915     properties:
56916       availability-zone-name:
56917         type: string
56918         description: Name of the availability zone.  Unique across a cloud region
56919       hypervisor-type:
56920         type: string
56921         description: Type of hypervisor.  Source of truth should define valid values.
56922       operational-state:
56923         type: string
56924         description: State that indicates whether the availability zone should be used, etc.  Source of truth should define valid values.
56925       resource-version:
56926         type: string
56927         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56928       relationship-list:
56929         type: array
56930         items:
56931           $ref: "#/getDefinitions/relationship"
56932   availability-zones:
56933     description: |
56934       Collection of availability zones
56935     properties:
56936       availability-zone:
56937         type: array
56938         items:
56939           $ref: "#/getDefinitions/availability-zone"
56940   az-and-dvs-switches:
56941     properties:
56942       dvs-switches:
56943         type: object
56944         $ref: "#/getDefinitions/dvs-switches"
56945       availability-zone:
56946         type: object
56947         $ref: "#/getDefinitions/availability-zone"
56948   business:
56949     description: |
56950       Namespace for business related constructs
56951     properties:
56952       connectors:
56953         type: array
56954         items:
56955           $ref: "#/getDefinitions/connector"
56956       customers:
56957         type: array
56958         items:
56959           $ref: "#/getDefinitions/customer"
56960   class-of-service:
56961     description: |
56962       ###### Related Nodes
56963       - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
56964     required:
56965     - cos
56966     properties:
56967       cos:
56968         type: string
56969         description: unique identifier of probe
56970       probe-id:
56971         type: string
56972         description: identifier of probe
56973       probe-type:
56974         type: string
56975         description: type of probe
56976       resource-version:
56977         type: string
56978         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56979       relationship-list:
56980         type: array
56981         items:
56982           $ref: "#/getDefinitions/relationship"
56983   classes-of-service:
56984     description: |
56985       class-of-service of probe
56986     properties:
56987       class-of-service:
56988         type: array
56989         items:
56990           $ref: "#/getDefinitions/class-of-service"
56991   cloud-infrastructure:
56992     description: |
56993       Namespace for cloud infrastructure.
56994     properties:
56995       complexes:
56996         type: array
56997         items:
56998           $ref: "#/getDefinitions/complex"
56999       cloud-regions:
57000         type: array
57001         items:
57002           $ref: "#/getDefinitions/cloud-region"
57003       network-profiles:
57004         type: array
57005         items:
57006           $ref: "#/getDefinitions/network-profile"
57007       pservers:
57008         type: array
57009         items:
57010           $ref: "#/getDefinitions/pserver"
57011       virtual-data-centers:
57012         type: array
57013         items:
57014           $ref: "#/getDefinitions/virtual-data-center"
57015   cloud-region:
57016     description: |
57017       cloud-region designates an installation of a cloud cluster or region or instantiation.
57018       ###### Related Nodes
57019       - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
57020       - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
57021       - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
57022       - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
57023       - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
57024       - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
57025       - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
57026       - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
57027       - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
57028       - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
57029       - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
57030       - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
57031       - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
57032       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
57033       - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP
57034       - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
57035     required:
57036     - cloud-owner
57037     - cloud-region-id
57038     properties:
57039       cloud-owner:
57040         type: string
57041         description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
57042       cloud-region-id:
57043         type: string
57044         description: Identifier used by the vendor for the region. Second part of composite key
57045       cloud-type:
57046         type: string
57047         description: Type of the cloud (e.g., openstack)
57048       owner-defined-type:
57049         type: string
57050         description: Cloud-owner defined type indicator (e.g., dcp, lcp)
57051       cloud-region-version:
57052         type: string
57053         description: Software version employed at the site.  NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
57054       identity-url:
57055         type: string
57056         description: URL of the keystone identity service
57057       cloud-zone:
57058         type: string
57059         description: Zone where the cloud is homed.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
57060       complex-name:
57061         type: string
57062         description: complex name for cloud-region instance.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
57063       resource-version:
57064         type: string
57065         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57066       volume-groups:
57067         type: array
57068         items:
57069           $ref: "#/getDefinitions/volume-group"
57070       tenants:
57071         type: array
57072         items:
57073           $ref: "#/getDefinitions/tenant"
57074       flavors:
57075         type: array
57076         items:
57077           $ref: "#/getDefinitions/flavor"
57078       group-assignments:
57079         type: array
57080         items:
57081           $ref: "#/getDefinitions/group-assignment"
57082       snapshots:
57083         type: array
57084         items:
57085           $ref: "#/getDefinitions/snapshot"
57086       images:
57087         type: array
57088         items:
57089           $ref: "#/getDefinitions/image"
57090       dvs-switches:
57091         type: array
57092         items:
57093           $ref: "#/getDefinitions/dvs-switch"
57094       oam-networks:
57095         type: array
57096         items:
57097           $ref: "#/getDefinitions/oam-network"
57098       availability-zones:
57099         type: array
57100         items:
57101           $ref: "#/getDefinitions/availability-zone"
57102       relationship-list:
57103         type: array
57104         items:
57105           $ref: "#/getDefinitions/relationship"
57106   cloud-regions:
57107     properties:
57108       cloud-region:
57109         type: array
57110         items:
57111           $ref: "#/getDefinitions/cloud-region"
57112   complex:
57113     description: |
57114       Collection of physical locations that can house cloud-regions.
57115       ###### Related Nodes
57116       - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
57117       - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
57118       - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
57119       - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
57120       - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
57121       - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
57122       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
57123       - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
57124       - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
57125       - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
57126       - FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
57127       - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
57128       - COMPLEX is DELETED when these are DELETED CTAG-POOL
57129     required:
57130     - physical-location-id
57131     - physical-location-type
57132     - street1
57133     - city
57134     - postal-code
57135     - country
57136     - region
57137     properties:
57138       physical-location-id:
57139         type: string
57140         description: Unique identifier for physical location, e.g., CLLI
57141       data-center-code:
57142         type: string
57143         description: Data center code which can be an alternate way to identify a complex
57144       complex-name:
57145         type: string
57146         description: Gamma complex name for LCP instance.
57147       identity-url:
57148         type: string
57149         description: URL of the keystone identity service
57150       resource-version:
57151         type: string
57152         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57153       physical-location-type:
57154         type: string
57155         description: Type, e.g., central office, data center.
57156       street1:
57157         type: string
57158       street2:
57159         type: string
57160       city:
57161         type: string
57162       state:
57163         type: string
57164       postal-code:
57165         type: string
57166       country:
57167         type: string
57168       region:
57169         type: string
57170       latitude:
57171         type: string
57172       longitude:
57173         type: string
57174       elevation:
57175         type: string
57176       lata:
57177         type: string
57178       ctag-pools:
57179         type: array
57180         items:
57181           $ref: "#/getDefinitions/ctag-pool"
57182       relationship-list:
57183         type: array
57184         items:
57185           $ref: "#/getDefinitions/relationship"
57186   complexes:
57187     description: |
57188       Collection of physical locations that can house cloud-regions.
57189     properties:
57190       complex:
57191         type: array
57192         items:
57193           $ref: "#/getDefinitions/complex"
57194   configuration:
57195     description: |
57196       Port Mirror Configuration.
57197       ###### Related Nodes
57198       - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
57199       - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
57200       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
57201       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
57202       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
57203       - CONFIGURATION is DELETED when these are DELETED METADATUM
57204       - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
57205     required:
57206     - configuration-id
57207     - configuration-type
57208     - configuration-sub-type
57209     - orchestration-status
57210     - operational-status
57211     - configuration-selflink
57212     - model-customization-id
57213     properties:
57214       configuration-id:
57215         type: string
57216         description: UUID assigned to configuration.
57217       management-option:
57218         type: string
57219         description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
57220       configuration-name:
57221         type: string
57222         description: Name of the configuration.
57223       configuration-type:
57224         type: string
57225         description: port-mirroring-configuration.
57226       configuration-sub-type:
57227         type: string
57228         description: vprobe, pprobe.
57229       model-invariant-id:
57230         type: string
57231         description: the ASDC model id for this resource or service model.
57232       model-version-id:
57233         type: string
57234         description: the ASDC model version for this resource or service model.
57235       orchestration-status:
57236         type: string
57237         description: Orchestration status of the configuration.
57238       operational-status:
57239         type: string
57240         description: Indicator for whether the resource is considered operational.
57241       configuration-selflink:
57242         type: string
57243         description: URL to endpoint where AAI can get more details from SDN-GC.
57244       model-customization-id:
57245         type: string
57246         description: id of  the configuration used to customize the resource
57247       resource-version:
57248         type: string
57249         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57250       relationship-list:
57251         type: array
57252         items:
57253           $ref: "#/getDefinitions/relationship"
57254       metadata:
57255         type: array
57256         items:
57257           $ref: "#/getDefinitions/metadatum"
57258   configurations:
57259     description: |
57260       Collection of configurations
57261     properties:
57262       configuration:
57263         type: array
57264         items:
57265           $ref: "#/getDefinitions/configuration"
57266   connector:
57267     description: |
57268       Collection of resource instances used to connect a variety of disparate inventory widgets
57269       ###### Related Nodes
57270       - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
57271       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
57272       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
57273       - CONNECTOR is DELETED when these are DELETED METADATUM
57274     required:
57275     - resource-instance-id
57276     properties:
57277       resource-instance-id:
57278         type: string
57279         description: Unique id of resource instance.
57280       resource-version:
57281         type: string
57282         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57283       persona-model-id:
57284         type: string
57285         description: the ASDC model id for this resource or service model.
57286       persona-model-version:
57287         type: string
57288         description: the ASDC model version for this resource or service model.
57289       model-version-id:
57290         type: string
57291         description: the ASDC model version for this resource or service model.
57292       widget-model-id:
57293         type: string
57294         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
57295       widget-model-version:
57296         type: string
57297         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
57298       relationship-list:
57299         type: array
57300         items:
57301           $ref: "#/getDefinitions/relationship"
57302       metadata:
57303         type: array
57304         items:
57305           $ref: "#/getDefinitions/metadatum"
57306   connectors:
57307     description: |
57308       Collection of resource instances used to connect a variety of disparate inventory widgets
57309     properties:
57310       connector:
57311         type: array
57312         items:
57313           $ref: "#/getDefinitions/connector"
57314   constrained-element-set:
57315     description: |
57316       This is how we would capture constraints defining allowed sets of elements.
57317       ###### Related Nodes
57318       - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
57319       - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
57320       - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
57321       - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET
57322     required:
57323     - constrained-element-set-uuid
57324     - constraint-type
57325     - check-type
57326     properties:
57327       constrained-element-set-uuid:
57328         type: string
57329       constraint-type:
57330         type: string
57331       check-type:
57332         type: string
57333       resource-version:
57334         type: string
57335       element-choice-sets:
57336         type: array
57337         items:
57338           $ref: "#/getDefinitions/element-choice-set"
57339       relationship-list:
57340         type: array
57341         items:
57342           $ref: "#/getDefinitions/relationship"
57343   constrained-element-sets:
57344     properties:
57345       constrained-element-set:
57346         type: array
57347         items:
57348           $ref: "#/getDefinitions/constrained-element-set"
57349   ctag-assignment:
57350     description: |
57351       ###### Related Nodes
57352       - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
57353       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
57354     required:
57355     - vlan-id-inner
57356     properties:
57357       vlan-id-inner:
57358         type: integer
57359         format: int64
57360         description: id.
57361       resource-version:
57362         type: string
57363         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57364       relationship-list:
57365         type: array
57366         items:
57367           $ref: "#/getDefinitions/relationship"
57368   ctag-assignments:
57369     properties:
57370       ctag-assignment:
57371         type: array
57372         items:
57373           $ref: "#/getDefinitions/ctag-assignment"
57374   ctag-pool:
57375     description: |
57376       A collection of C tags (vlan tags) grouped for a specific purpose.
57377       ###### Related Nodes
57378       - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
57379       - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
57380       - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
57381     required:
57382     - target-pe
57383     - availability-zone-name
57384     - ctag-pool-purpose
57385     properties:
57386       target-pe:
57387         type: string
57388         description: The Target provider edge router
57389       availability-zone-name:
57390         type: string
57391         description: Name of the availability zone
57392       ctag-pool-purpose:
57393         type: string
57394         description: Describes what the intended purpose of this pool is.
57395       ctag-values:
57396         type: string
57397         description: Comma separated list of ctags
57398       resource-version:
57399         type: string
57400         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57401       relationship-list:
57402         type: array
57403         items:
57404           $ref: "#/getDefinitions/relationship"
57405   ctag-pools:
57406     properties:
57407       ctag-pool:
57408         type: array
57409         items:
57410           $ref: "#/getDefinitions/ctag-pool"
57411   customer:
57412     description: |
57413       customer identifiers to provide linkage back to BSS information.
57414       ###### Related Nodes
57415       - FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
57416       - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION
57417     required:
57418     - global-customer-id
57419     - subscriber-name
57420     - subscriber-type
57421     properties:
57422       global-customer-id:
57423         type: string
57424         description: Global customer id used across ECOMP to uniquely identify customer.
57425       subscriber-name:
57426         type: string
57427         description: Subscriber name, an alternate way to retrieve a customer.
57428       subscriber-type:
57429         type: string
57430         description: Subscriber type, a way to provide VID with only the INFRA customers.
57431       resource-version:
57432         type: string
57433         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57434       service-subscriptions:
57435         type: array
57436         items:
57437           $ref: "#/getDefinitions/service-subscription"
57438       relationship-list:
57439         type: array
57440         items:
57441           $ref: "#/getDefinitions/relationship"
57442   customers:
57443     description: |
57444       Collection of customer identifiers to provide linkage back to BSS information.
57445     properties:
57446       customer:
57447         type: array
57448         items:
57449           $ref: "#/getDefinitions/customer"
57450   cvlan-tag-entry:
57451     required:
57452     - cvlan-tag
57453     properties:
57454       cvlan-tag:
57455         type: integer
57456         format: int64
57457         description: See mis-na-virtualization-platform.yang
57458       resource-version:
57459         type: string
57460         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57461       relationship-list:
57462         type: array
57463         items:
57464           $ref: "#/getDefinitions/relationship"
57465   cvlan-tags:
57466     properties:
57467       cvlan-tag-entry:
57468         type: array
57469         items:
57470           $ref: "#/getDefinitions/cvlan-tag-entry"
57471   dvs-switch:
57472     description: |
57473       Digital virtual switch metadata, used by SDN-C to configure VCEs.  A&AI needs to receive this data from the PO deployment team and administer it using the provisioningTool.sh into A&AI.
57474       ###### Related Nodes
57475       - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
57476       - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
57477     required:
57478     - switch-name
57479     - vcenter-url
57480     properties:
57481       switch-name:
57482         type: string
57483         description: DVS switch name
57484       vcenter-url:
57485         type: string
57486         description: URL used to reach the vcenter
57487       resource-version:
57488         type: string
57489         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57490       relationship-list:
57491         type: array
57492         items:
57493           $ref: "#/getDefinitions/relationship"
57494   dvs-switches:
57495     description: |
57496       Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
57497     properties:
57498       dvs-switch:
57499         type: array
57500         items:
57501           $ref: "#/getDefinitions/dvs-switch"
57502   edge-prop-names:
57503     description: |
57504       Internal map to define the properties of an edge and interpret the map EdgeRules
57505     properties:
57506       edgeLabel:
57507         type: string
57508       direction:
57509         type: string
57510       multiplicityRule:
57511         type: string
57512       isParent:
57513         type: boolean
57514       usesResource:
57515         type: boolean
57516       hasDelTarget:
57517         type: boolean
57518       SVC-INFRA:
57519         type: boolean
57520       SVC-INFRA-REV:
57521         type: boolean
57522   edge-tag-query-request:
57523     properties:
57524       edge-tag:
57525         type: string
57526       result-detail:
57527         type: string
57528       start-node-type:
57529         type: string
57530       start-node-filter:
57531         type: array
57532         items:
57533           $ref: "#/getDefinitions/start-node-filter"
57534       include-node-filter:
57535         type: array
57536         items:
57537           $ref: "#/getDefinitions/include-node-filter"
57538       secondary-filter:
57539         type: array
57540         items:
57541           $ref: "#/getDefinitions/secondary-filter"
57542   edge-tag-query-result:
57543     properties:
57544       tagged-inventory-item-list:
57545         type: array
57546         items:
57547           $ref: "#/getDefinitions/tagged-inventory-item-list"
57548   element-choice-set:
57549     description: |
57550       This is how we would capture constraints defining allowed sets of elements.
57551       ###### Related Nodes
57552       - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
57553       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
57554       - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT
57555     required:
57556     - element-choice-set-uuid
57557     - element-choice-set-name
57558     properties:
57559       element-choice-set-uuid:
57560         type: string
57561       element-choice-set-name:
57562         type: string
57563       cardinality:
57564         type: string
57565       resource-version:
57566         type: string
57567       model-elements:
57568         type: array
57569         items:
57570           $ref: "#/getDefinitions/model-element"
57571       relationship-list:
57572         type: array
57573         items:
57574           $ref: "#/getDefinitions/relationship"
57575   element-choice-sets:
57576     properties:
57577       element-choice-set:
57578         type: array
57579         items:
57580           $ref: "#/getDefinitions/element-choice-set"
57581   entitlement:
57582     description: |
57583       Metadata for entitlement group.
57584       ###### Related Nodes
57585       - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
57586       - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
57587     required:
57588     - group-uuid
57589     - resource-uuid
57590     properties:
57591       group-uuid:
57592         type: string
57593         description: Unique ID for the entitlement group the resource comes from, should be uuid.
57594       resource-uuid:
57595         type: string
57596         description: Unique ID of an entitlement resource.
57597       resource-version:
57598         type: string
57599         description: Concurrency value
57600       relationship-list:
57601         type: array
57602         items:
57603           $ref: "#/getDefinitions/relationship"
57604   entitlements:
57605     description: |
57606       Entitlements, keyed by group-uuid and resource-uuid, related to license management
57607     properties:
57608       entitlement:
57609         type: array
57610         items:
57611           $ref: "#/getDefinitions/entitlement"
57612   esr-ems:
57613     description: |
57614       Persist EMS address information used by EMS driver.
57615       ###### Related Nodes
57616       - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)
57617       - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
57618     required:
57619     - ems-id
57620     properties:
57621       ems-id:
57622         type: string
57623         description: Unique ID of EMS.
57624       resource-version:
57625         type: string
57626         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57627       esr-system-info-list:
57628         type: object
57629         $ref: "#/getDefinitions/esr-system-info-list"
57630       relationship-list:
57631         type: object
57632         $ref: "#/getDefinitions/relationship-list"
57633   esr-ems-list:
57634     properties:
57635       esr-ems:
57636         type: array
57637         items:
57638           $ref: "#/getDefinitions/esr-ems"
57639   esr-system-info:
57640     description: |
57641       Persist common address information of external systems.
57642       ###### Related Nodes
57643       - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)
57644       - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)
57645       - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)
57646       - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)
57647     required:
57648     - esr-system-info-id
57649     - user-name
57650     - password
57651     - system-type
57652     properties:
57653       esr-system-info-id:
57654         type: string
57655         description: Unique ID of esr system info.
57656       system-name:
57657         type: string
57658         description: name of external system.
57659       type:
57660         type: string
57661         description: type of external systems.
57662       vendor:
57663         type: string
57664         description: vendor of external systems.
57665       version:
57666         type: string
57667         description: version of external systems.
57668       service-url:
57669         type: string
57670         description: url used to access external systems.
57671       user-name:
57672         type: string
57673         description: username used to access external systems.
57674       password:
57675         type: string
57676         description: password used to access external systems.
57677       system-type:
57678         type: string
57679         description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
57680       protocol:
57681         type: string
57682         description: protocol of third party SDNC, for example netconf/snmp.
57683       ssl-cacert:
57684         type: string
57685         description: ca file content if enabled ssl on auth-url.
57686       ssl-insecure:
57687         type: boolean
57688         description: Whether to verify VIM's certificate.
57689       ip-address:
57690         type: string
57691         description: service IP of ftp server.
57692       port:
57693         type: string
57694         description: service port of ftp server.
57695       cloud-domain:
57696         type: string
57697         description: domain info for authentication.
57698       default-tenant:
57699         type: string
57700         description: default tenant of VIM.
57701       passive:
57702         type: boolean
57703         description: ftp passive mode or not.
57704       remote-path:
57705         type: string
57706         description: resource or performance data file path.
57707       system-status:
57708         type: string
57709         description: the status of external system.
57710       resource-version:
57711         type: string
57712         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57713       relationship-list:
57714         type: array
57715         items:
57716           $ref: "#/getDefinitions/relationship"
57717   esr-system-info-list:
57718     description: |
57719       Collection of persistent block-level external system auth info.
57720     properties:
57721       esr-system-info:
57722         type: array
57723         items:
57724           $ref: "#/getDefinitions/esr-system-info"
57725   esr-thirdparty-sdnc:
57726     description: |
57727       Persist SDNC address information used by ONAP SDNC.
57728       ###### Related Nodes
57729       - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)
57730       - TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
57731       - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
57732     required:
57733     - thirdparty-sdnc-id
57734     properties:
57735       thirdparty-sdnc-id:
57736         type: string
57737         description: Unique ID of SDNC.
57738       location:
57739         type: string
57740         description: used for DC type to indicate the location of SDNC, such as Core or Edge.
57741       product-name:
57742         type: string
57743         description: password used to access SDNC server.
57744       resource-version:
57745         type: string
57746         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57747       esr-system-info-list:
57748         type: object
57749         $ref: "#/getDefinitions/esr-system-info-list"
57750       relationship-list:
57751         type: object
57752         $ref: "#/getDefinitions/relationship-list"
57753   esr-thirdparty-sdnc-list:
57754     properties:
57755       esr-thirdparty-sdnc:
57756         type: array
57757         items:
57758           $ref: "#/getDefinitions/esr-thirdparty-sdnc"
57759   esr-vnfm:
57760     description: |
57761       Persist VNFM address information used by VF-C.
57762       ###### Related Nodes
57763       - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)
57764       - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
57765     required:
57766     - vnfm-id
57767     properties:
57768       vnfm-id:
57769         type: string
57770         description: Unique ID of VNFM.
57771       vim-id:
57772         type: string
57773         description: indecate the VIM to deploy VNF.
57774       certificate-url:
57775         type: string
57776         description: certificate url of VNFM.
57777       resource-version:
57778         type: string
57779         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57780       esr-system-info-list:
57781         type: object
57782         $ref: "#/getDefinitions/esr-system-info-list"
57783       relationship-list:
57784         type: object
57785         $ref: "#/getDefinitions/relationship-list"
57786   esr-vnfm-list:
57787     properties:
57788       esr-vnfm:
57789         type: array
57790         items:
57791           $ref: "#/getDefinitions/esr-vnfm"
57792   evc:
57793     description: |
57794       evc object is an optional child object of the Configuration object.
57795       ###### Related Nodes
57796       - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
57797     required:
57798     - evc-id
57799     properties:
57800       evc-id:
57801         type: string
57802         description: Unique/key field for the evc object
57803       forwarding-path-topology:
57804         type: string
57805         description: Point-to-Point, Multi-Point
57806       cir-value:
57807         type: string
57808         description: Commited Information Rate
57809       cir-units:
57810         type: string
57811         description: CIR units
57812       connection-diversity-group-id:
57813         type: string
57814         description: Diversity Group ID
57815       service-hours:
57816         type: string
57817         description: formerly Performance Group
57818       esp-evc-circuit-id:
57819         type: string
57820         description: EVC Circuit ID of ESP EVC
57821       esp-evc-cir-value:
57822         type: string
57823         description: Committed Information Rate (For ESP)
57824       esp-evc-cir-units:
57825         type: string
57826         description: CIR units (For ESP)
57827       esp-itu-code:
57828         type: string
57829         description: Identifies ESP
57830       collector-pop-clli:
57831         type: string
57832         description: Collector POP CLLI (from the hostname of the access pnf)
57833       inter-connect-type-ingress:
57834         type: string
57835         description: Interconnect type on ingress side of EVC.
57836       tagmode-access-ingress:
57837         type: string
57838         description: tagode for collector side of EVC
57839       tagmode-access-egress:
57840         type: string
57841         description: tagMode for network side of EVC
57842       relationship-list:
57843         type: array
57844         items:
57845           $ref: "#/getDefinitions/relationship"
57846       resource-version:
57847         type: string
57848         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57849   evcs:
57850     properties:
57851       evc:
57852         type: array
57853         items:
57854           $ref: "#/getDefinitions/evc"
57855   external-system:
57856     description: |
57857       Namespace for external system.
57858     properties:
57859       esr-ems-list:
57860         type: object
57861         $ref: "#/getDefinitions/esr-ems-list"
57862       esr-vnfm-list:
57863         type: object
57864         $ref: "#/getDefinitions/esr-vnfm-list"
57865       esr-thirdparty-sdnc-list:
57866         type: object
57867         $ref: "#/getDefinitions/esr-thirdparty-sdnc-list"
57868   extra-properties:
57869     description: |
57870       Extra properties for inventory item for response list
57871   extra-property:
57872     properties:
57873       property-name:
57874         type: string
57875   flavor:
57876     description: |
57877       Openstack flavor.
57878       ###### Related Nodes
57879       - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
57880       - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
57881       - FLAVOR cannot be deleted if linked to VSERVER
57882     required:
57883     - flavor-id
57884     - flavor-name
57885     - flavor-selflink
57886     properties:
57887       flavor-id:
57888         type: string
57889         description: Flavor id, expected to be unique across cloud-region.
57890       flavor-name:
57891         type: string
57892         description: Flavor name
57893       flavor-vcpus:
57894         type: integer
57895         format: int32
57896         description: Number of CPUs
57897       flavor-ram:
57898         type: integer
57899         format: int32
57900         description: Amount of memory
57901       flavor-disk:
57902         type: integer
57903         format: int32
57904         description: Disk space
57905       flavor-ephemeral:
57906         type: integer
57907         format: int32
57908         description: Amount of ephemeral disk space
57909       flavor-swap:
57910         type: string
57911         description: amount of swap space allocation
57912       flavor-is-public:
57913         type: boolean
57914         description: whether flavor is available to all users or private to the tenant it was created in.
57915       flavor-selflink:
57916         type: string
57917         description: URL to endpoint where AAI can get more details
57918       flavor-disabled:
57919         type: boolean
57920         description: Boolean as to whether this flavor is no longer enabled
57921       resource-version:
57922         type: string
57923         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57924       relationship-list:
57925         type: array
57926         items:
57927           $ref: "#/getDefinitions/relationship"
57928   flavors:
57929     description: |
57930       Collection of openstack flavors.
57931     properties:
57932       flavor:
57933         type: array
57934         items:
57935           $ref: "#/getDefinitions/flavor"
57936   forwarder:
57937     description: |
57938       Entity describing a sequenced segment of forwarding path
57939       ###### Related Nodes
57940       - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
57941       - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
57942       - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
57943       - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
57944       - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
57945       - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION
57946     required:
57947     - sequence
57948     properties:
57949       sequence:
57950         type: integer
57951         format: int32
57952         description: Unique ID of this segmentation
57953       forwarder-role:
57954         type: string
57955         description: ingress, intermediate, egress
57956       relationship-list:
57957         type: array
57958         items:
57959           $ref: "#/getDefinitions/relationship"
57960       resource-version:
57961         type: string
57962         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57963   forwarder-evc:
57964     description: |
57965       forwarder object is an optional child object of the Configuration object.
57966       ###### Related Nodes
57967       - TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
57968     required:
57969     - forwarder-evc-id
57970     properties:
57971       forwarder-evc-id:
57972         type: string
57973         description: Key for forwarder-evc object
57974       circuit-id:
57975         type: string
57976         description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
57977       ivlan:
57978         type: string
57979         description: Internal VLAN.
57980       svlan:
57981         type: string
57982         description: SVLAN value for ingress of egress forwarder.
57983       cvlan:
57984         type: string
57985         description: CVLAN value for ingress of egress forwarder.
57986       relationship-list:
57987         type: array
57988         items:
57989           $ref: "#/getDefinitions/relationship"
57990       resource-version:
57991         type: string
57992         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57993   forwarder-evcs:
57994     properties:
57995       forwarder-evc:
57996         type: array
57997         items:
57998           $ref: "#/getDefinitions/forwarder-evc"
57999   forwarders:
58000     properties:
58001       forwarder:
58002         type: array
58003         items:
58004           $ref: "#/getDefinitions/forwarder"
58005   forwarding-path:
58006     description: |
58007       Entity that describes the sequenced forwarding path between interfaces of services or resources
58008       ###### Related Nodes
58009       - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
58010       - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
58011       - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
58012       - FORWARDING-PATH is DELETED when these are DELETED FORWARDER
58013       - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION
58014     required:
58015     - forwarding-path-id
58016     - forwarding-path-name
58017     properties:
58018       forwarding-path-id:
58019         type: string
58020         description: Unique ID of this FP
58021       forwarding-path-name:
58022         type: string
58023         description: Name of the FP
58024       relationship-list:
58025         type: array
58026         items:
58027           $ref: "#/getDefinitions/relationship"
58028       resource-version:
58029         type: string
58030         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58031       selflink:
58032         type: string
58033         description: the self link for this FP
58034       forwarders:
58035         type: array
58036         items:
58037           $ref: "#/getDefinitions/forwarder"
58038   forwarding-paths:
58039     properties:
58040       forwarding-path:
58041         type: array
58042         items:
58043           $ref: "#/getDefinitions/forwarding-path"
58044   generic-vnf:
58045     description: |
58046       General purpose VNF
58047       ###### Related Nodes
58048       - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
58049       - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
58050       - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
58051       - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
58052       - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY)
58053       - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
58054       - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
58055       - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
58056       - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
58057       - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
58058       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
58059       - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
58060       - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
58061       - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
58062       - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
58063       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
58064       - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
58065       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
58066       - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
58067       - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
58068       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
58069       - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE
58070     required:
58071     - vnf-id
58072     - vnf-name
58073     - vnf-type
58074     - in-maint
58075     - is-closed-loop-disabled
58076     properties:
58077       vnf-id:
58078         type: string
58079         description: Unique id of VNF.  This is unique across the graph.
58080       vnf-name:
58081         type: string
58082         description: Name of VNF.
58083       vnf-name2:
58084         type: string
58085         description: Alternate name of VNF.
58086       vnf-type:
58087         type: string
58088         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
58089       service-id:
58090         type: string
58091         description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
58092       regional-resource-zone:
58093         type: string
58094         description: Regional way of organizing pservers, source of truth should define values
58095       prov-status:
58096         type: string
58097         description: Trigger for operational monitoring of this resource by Service Assurance systems.
58098       operational-state:
58099         type: string
58100         description: Indicator for whether the resource is considered operational.  Valid values are in-service-path and out-of-service-path.
58101       license-key:
58102         type: string
58103         description: OBSOLETE -  do not use
58104       equipment-role:
58105         type: string
58106         description: Client should send valid enumerated value
58107       orchestration-status:
58108         type: string
58109         description: Orchestration status of this VNF, used by MSO.
58110       heat-stack-id:
58111         type: string
58112         description: Heat stack id corresponding to this instance, managed by MSO
58113       mso-catalog-key:
58114         type: string
58115         description: Corresponds to the SDN-C catalog id used to configure this VCE
58116       management-option:
58117         type: string
58118         description: identifier of managed by company or customer
58119       ipv4-oam-address:
58120         type: string
58121         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
58122       ipv4-loopback0-address:
58123         type: string
58124         description: v4 Loopback0 address
58125       nm-lan-v6-address:
58126         type: string
58127         description: v6 Loopback address
58128       management-v6-address:
58129         type: string
58130         description: v6 management address
58131       vcpu:
58132         type: integer
58133         format: int64
58134         description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
58135       vcpu-units:
58136         type: string
58137         description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only in some usecases
58138       vmemory:
58139         type: integer
58140         format: int64
58141         description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
58142       vmemory-units:
58143         type: string
58144         description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only in some usecases
58145       vdisk:
58146         type: integer
58147         format: int64
58148         description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
58149       vdisk-units:
58150         type: string
58151         description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only in some usecases
58152       in-maint:
58153         type: boolean
58154       is-closed-loop-disabled:
58155         type: boolean
58156       resource-version:
58157         type: string
58158         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58159       summary-status:
58160         type: string
58161         description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.
58162       encrypted-access-flag:
58163         type: boolean
58164         description: indicates whether generic-vnf access uses SSH
58165       persona-model-id:
58166         type: string
58167         description: the ASDC model id for this resource or service model.
58168       persona-model-version:
58169         type: string
58170         description: the ASDC model version for this resource or service model.
58171       model-version-id:
58172         type: string
58173         description: the ASDC model version for this resource or service model.
58174       persona-model-customization-id:
58175         type: string
58176         description: captures the id of all the configuration used to customize the resource for the service.
58177       widget-model-id:
58178         type: string
58179         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
58180       widget-model-version:
58181         type: string
58182         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
58183       as-number:
58184         type: string
58185         description: as-number of the VNF
58186       regional-resource-subzone:
58187         type: string
58188         description: represents sub zone of the rr plane
58189       selflink:
58190         type: string
58191         description: Path to the controller object.
58192       relationship-list:
58193         type: array
58194         items:
58195           $ref: "#/getDefinitions/relationship"
58196       l-interfaces:
58197         type: array
58198         items:
58199           $ref: "#/getDefinitions/l-interface"
58200       lag-interfaces:
58201         type: array
58202         items:
58203           $ref: "#/getDefinitions/lag-interface"
58204       vf-modules:
58205         type: array
58206         items:
58207           $ref: "#/getDefinitions/vf-module"
58208       licenses:
58209         type: array
58210         items:
58211           $ref: "#/getDefinitions/license"
58212       entitlements:
58213         type: array
58214         items:
58215           $ref: "#/getDefinitions/entitlement"
58216   generic-vnfs:
58217     description: |
58218       Collection of VNFs
58219     properties:
58220       generic-vnf:
58221         type: array
58222         items:
58223           $ref: "#/getDefinitions/generic-vnf"
58224   group-assignment:
58225     description: |
58226       Openstack group-assignment used to store exclusivity groups (EG).
58227       ###### Related Nodes
58228       - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58229       - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
58230       - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
58231     required:
58232     - group-id
58233     - group-type
58234     - group-name
58235     properties:
58236       group-id:
58237         type: string
58238         description: Group id, expected to be unique across cloud-region.
58239       group-type:
58240         type: string
58241         description: Group type - the type of group this instance refers to
58242       group-name:
58243         type: string
58244         description: Group name - name assigned to the group
58245       group-description:
58246         type: string
58247         description: Group description - description of the group
58248       resource-version:
58249         type: string
58250         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58251       relationship-list:
58252         type: array
58253         items:
58254           $ref: "#/getDefinitions/relationship"
58255   group-assignments:
58256     description: |
58257       Collection of openstack group assignments
58258     properties:
58259       group-assignment:
58260         type: array
58261         items:
58262           $ref: "#/getDefinitions/group-assignment"
58263   host-route:
58264     description: |
58265       ###### Related Nodes
58266       - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
58267     required:
58268     - host-route-id
58269     - route-prefix
58270     - next-hop
58271     properties:
58272       host-route-id:
58273         type: string
58274         description: host-route id
58275       route-prefix:
58276         type: string
58277         description: subnet prefix
58278       next-hop:
58279         type: string
58280         description: Could be ip-address, hostname, or service-instance
58281       next-hop-type:
58282         type: string
58283         description: Should be ip-address, hostname, or service-instance to match next-hop
58284       resource-version:
58285         type: string
58286         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58287       relationship-list:
58288         type: array
58289         items:
58290           $ref: "#/getDefinitions/relationship"
58291   host-routes:
58292     properties:
58293       host-route:
58294         type: array
58295         items:
58296           $ref: "#/getDefinitions/host-route"
58297   hpa-capabilities:
58298     description: |
58299       Collection of HPA Capabilities
58300     properties:
58301       hpa-capability:
58302         type: array
58303         items:
58304           $ref: "#/getDefinitions/hpa-capability"
58305   hpa-capability:
58306     description: |
58307       Represents a HPA capability
58308       ###### Related Nodes
58309       - TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE)
58310       - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58311       - FROM hpa-feature-attributes( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE)
58312       - HPA-CAPABILITY is DELETED when these are DELETED HPA-FEATURE-ATTRIBUTES
58313     required:
58314     - hpa-capability-id
58315     - hpa-feature
58316     properties:
58317       hpa-capability-id:
58318         type: string
58319         description: UUID to uniquely identify a HPA capability
58320       hpa-feature:
58321         type: string
58322         description: Name of the HPACapability
58323       hpa-version:
58324         type: string
58325         description: HPA schema version
58326       hpa-hw-arch:
58327         type: string
58328         description: Hardware architecture
58329       resource-version:
58330         type: string
58331         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58332       relationship-list:
58333         type: array
58334         items:
58335           $ref: "#/getDefinitions/relationship"
58336       hpa-feature-attributes:
58337         type: array
58338         items:
58339           $ref: "#/getDefinitions/hpa-feature-attributes"
58340   hpa-feature-attributes:
58341     description: |
58342       HPA Capability Feature attributes
58343       ###### Related Nodes
58344       - TO hpa-capability( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE)
58345     properties:
58346       hpa-attr-key:
58347         type: string
58348         description: name of the specific HPA attribute
58349       hpa-attr-value:
58350         type: string
58351         description: JSON string specifying the value, unit and type of the specific HPA attribute
58352       resource-version:
58353         type: string
58354         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58355       relationship-list:
58356         type: array
58357         items:
58358           $ref: "#/getDefinitions/relationship"
58359   image:
58360     description: |
58361       Openstack image.
58362       ###### Related Nodes
58363       - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58364       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
58365       - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
58366       - IMAGE cannot be deleted if linked to VSERVER
58367       - IMAGE is DELETED when these are DELETED METADATUM
58368     required:
58369     - image-id
58370     - image-name
58371     - image-os-distro
58372     - image-os-version
58373     - image-selflink
58374     properties:
58375       image-id:
58376         type: string
58377         description: Image id, expected to be unique across cloud region
58378       image-name:
58379         type: string
58380         description: Image name
58381       image-architecture:
58382         type: string
58383         description: Operating system architecture.
58384       image-os-distro:
58385         type: string
58386         description: The common name of the operating system distribution in lowercase
58387       image-os-version:
58388         type: string
58389         description: The operating system version as specified by the distributor.
58390       application:
58391         type: string
58392         description: The application that the image instantiates.
58393       application-vendor:
58394         type: string
58395         description: The vendor of the application.
58396       application-version:
58397         type: string
58398         description: The version of the application.
58399       image-selflink:
58400         type: string
58401         description: URL to endpoint where AAI can get more details
58402       resource-version:
58403         type: string
58404         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58405       relationship-list:
58406         type: array
58407         items:
58408           $ref: "#/getDefinitions/relationship"
58409       metadata:
58410         type: array
58411         items:
58412           $ref: "#/getDefinitions/metadatum"
58413   images:
58414     description: |
58415       Collectio of Openstack images.
58416     properties:
58417       image:
58418         type: array
58419         items:
58420           $ref: "#/getDefinitions/image"
58421   include-node-filter:
58422     properties:
58423       include-node-type:
58424         type: string
58425   instance-filter:
58426     description: |
58427       InstanceFilter for performing a named-query or model query
58428   instance-filters:
58429     description: |
58430       InstanceFilters for performing a named-query or model query
58431     properties:
58432       instance-filter:
58433         type: array
58434         items:
58435           $ref: "#/getDefinitions/instance-filter"
58436   instance-group:
58437     description: |
58438       General mechanism for grouping instances
58439       ###### Related Nodes
58440       - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
58441       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
58442       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
58443       - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
58444       - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
58445     required:
58446     - id
58447     - description
58448     - type
58449     properties:
58450       id:
58451         type: string
58452         description: Instance Group ID, UUID assigned to this instance.
58453       description:
58454         type: string
58455         description: Descriptive text to help identify the usage of this instance-group
58456       type:
58457         type: string
58458         description: Only valid value today is lower case ha for high availability
58459       sub-type:
58460         type: string
58461         description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
58462       resource-version:
58463         type: string
58464         description: Concurrency value
58465       relationship-list:
58466         type: array
58467         items:
58468           $ref: "#/getDefinitions/relationship"
58469   instance-groups:
58470     description: |
58471       Collection of openstack route table references
58472     properties:
58473       instance-group:
58474         type: array
58475         items:
58476           $ref: "#/getDefinitions/instance-group"
58477   inventory:
58478     properties:
58479       search:
58480         type: object
58481         $ref: "#/getDefinitions/search"
58482       actions:
58483         type: object
58484         $ref: "#/getDefinitions/actions"
58485       cloud-infrastructure:
58486         type: object
58487         $ref: "#/getDefinitions/cloud-infrastructure"
58488       business:
58489         type: object
58490         $ref: "#/getDefinitions/business"
58491       service-design-and-creation:
58492         type: object
58493         $ref: "#/getDefinitions/service-design-and-creation"
58494       network:
58495         type: object
58496         $ref: "#/getDefinitions/network"
58497       aai-internal:
58498         type: object
58499         $ref: "#/getDefinitions/aai-internal"
58500       nodes:
58501         type: array
58502         items:
58503           $ref: "#/getDefinitions/aai-internal"
58504   inventory-item:
58505     properties:
58506       inventory-item-type:
58507         type: string
58508       inventory-item-link:
58509         type: string
58510       inventory-item-data:
58511         type: array
58512         items:
58513           $ref: "#/getDefinitions/inventory-item-data"
58514       tagged-inventory-item-list:
58515         type: array
58516         items:
58517           $ref: "#/getDefinitions/tagged-inventory-item-list"
58518   inventory-item-data:
58519     properties:
58520       property-name:
58521         type: string
58522       property-value:
58523         type: string
58524   inventory-response-item:
58525     description: |
58526       Inventory item for response list
58527     properties:
58528       model-name:
58529         type: string
58530       extra-properties:
58531         type: object
58532         $ref: "#/getDefinitions/extra-properties"
58533       inventory-response-items:
58534         type: object
58535         $ref: "#/getDefinitions/inventory-response-items"
58536   inventory-response-items:
58537     description: |
58538       Container for inventory items in response list
58539     properties:
58540       inventory-response-item:
58541         type: array
58542         items:
58543           $ref: "#/getDefinitions/inventory-response-item"
58544   ipsec-configuration:
58545     description: |
58546       IPSec configuration node will contain various configuration data for the NMTE VNF. This node will have an edge to the generic-vnf (vnf type = TE). Starting 1607, this data will be populated by SDN-C
58547       ###### Related Nodes
58548       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
58549       - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
58550       - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER
58551     required:
58552     - ipsec-configuration-id
58553     properties:
58554       ipsec-configuration-id:
58555         type: string
58556         description: UUID of this configuration
58557       requested-vig-address-type:
58558         type: string
58559         description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
58560       requested-encryption-strength:
58561         type: string
58562         description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
58563       requested-dmz-type:
58564         type: string
58565         description: can offer a shared DMZ or a DMZ specific to a customer
58566       shared-dmz-network-address:
58567         type: string
58568         description: Network address of shared DMZ
58569       requested-customer-name:
58570         type: string
58571         description: If the DMZ is a custom DMZ, this field will indicate the customer information
58572       ike-version:
58573         type: string
58574         description: can be 1 or 2
58575       ikev1-authentication:
58576         type: string
58577         description: Contains values like md5, sha1, sha256, sha384
58578       ikev1-encryption:
58579         type: string
58580         description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
58581       ikev1-dh-group:
58582         type: string
58583         description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
58584       ikev1-am-group-id:
58585         type: string
58586         description: Group name defined in VIG for clients using aggressive mode
58587       ikev1-am-password:
58588         type: string
58589         description: pre-shared key for the above group name
58590       ikev1-sa-lifetime:
58591         type: string
58592         description: Lifetime for IKEv1 SA
58593       ipsec-authentication:
58594         type: string
58595         description: md5, sha1, sha256, sha384
58596       ipsec-encryption:
58597         type: string
58598         description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
58599       ipsec-sa-lifetime:
58600         type: string
58601         description: Life time for IPSec SA
58602       ipsec-pfs:
58603         type: string
58604         description: enable PFS or not
58605       xauth-userid:
58606         type: string
58607         description: user ID for xAuth, sm-user, ,nmteHostName
58608       xauth-user-password:
58609         type: string
58610         description: Encrypted using the Juniper $9$ algorithm
58611       dpd-interval:
58612         type: string
58613         description: The time between DPD probe
58614       dpd-frequency:
58615         type: string
58616         description: Maximum number of DPD before claiming the tunnel is down
58617       resource-version:
58618         type: string
58619         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58620       relationship-list:
58621         type: array
58622         items:
58623           $ref: "#/getDefinitions/relationship"
58624       vig-servers:
58625         type: array
58626         items:
58627           $ref: "#/getDefinitions/vig-server"
58628   ipsec-configurations:
58629     properties:
58630       ipsec-configuration:
58631         type: array
58632         items:
58633           $ref: "#/getDefinitions/ipsec-configuration"
58634   key-data:
58635     properties:
58636       key-name:
58637         type: string
58638       key-value:
58639         type: string
58640   l-interface:
58641     description: |
58642       Logical interfaces, e.g., a vnic.
58643       ###### Related Nodes
58644       - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
58645       - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
58646       - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
58647       - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
58648       - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
58649       - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
58650       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
58651       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
58652       - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
58653       - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
58654       - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN
58655       - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
58656     required:
58657     - interface-name
58658     properties:
58659       interface-name:
58660         type: string
58661         description: Name given to the interface
58662       interface-role:
58663         type: string
58664         description: E.g., CUSTOMER, UPLINK, etc.
58665       v6-wan-link-ip:
58666         type: string
58667         description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
58668       selflink:
58669         type: string
58670         description: URL to endpoint where AAI can get more details
58671       interface-id:
58672         type: string
58673         description: ID of interface
58674       macaddr:
58675         type: string
58676         description: MAC address for the interface
58677       network-name:
58678         type: string
58679         description: Name of the network
58680       management-option:
58681         type: string
58682         description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
58683       interface-description:
58684         type: string
58685         description: Human friendly text regarding this interface.
58686       resource-version:
58687         type: string
58688         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58689       vlans:
58690         type: array
58691         items:
58692           $ref: "#/getDefinitions/vlan"
58693       sriov-vfs:
58694         type: array
58695         items:
58696           $ref: "#/getDefinitions/sriov-vf"
58697       relationship-list:
58698         type: array
58699         items:
58700           $ref: "#/getDefinitions/relationship"
58701       l3-interface-ipv4-address-list:
58702         type: array
58703         items:
58704           $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
58705       l3-interface-ipv6-address-list:
58706         type: array
58707         items:
58708           $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
58709   l-interfaces:
58710     description: |
58711       Collection of logical interfaces.
58712     properties:
58713       l-interface:
58714         type: array
58715         items:
58716           $ref: "#/getDefinitions/l-interface"
58717   l3-interface-ipv4-address-list:
58718     description: |
58719       IPv4 Address Range
58720       ###### Related Nodes
58721       - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
58722       - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
58723       - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
58724       - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
58725     required:
58726     - l3-interface-ipv4-address
58727     properties:
58728       l3-interface-ipv4-address:
58729         type: string
58730         description: IP address
58731       l3-interface-ipv4-prefix-length:
58732         type: integer
58733         format: int64
58734         description: Prefix length, 32 for single address
58735       vlan-id-inner:
58736         type: integer
58737         format: int64
58738         description: Inner VLAN tag
58739       vlan-id-outer:
58740         type: integer
58741         format: int64
58742         description: Outer VLAN tag
58743       is-floating:
58744         type: boolean
58745         description: Indicator of fixed or floating address
58746       resource-version:
58747         type: string
58748         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58749       neutron-network-id:
58750         type: string
58751         description: Neutron network id of the interface that address belongs to
58752       neutron-subnet-id:
58753         type: string
58754         description: Neutron id of subnet that address belongs to
58755       relationship-list:
58756         type: array
58757         items:
58758           $ref: "#/getDefinitions/relationship"
58759   l3-interface-ipv6-address-list:
58760     description: |
58761       IPv6 Address Range
58762       ###### Related Nodes
58763       - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
58764       - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
58765       - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
58766       - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
58767     required:
58768     - l3-interface-ipv6-address
58769     properties:
58770       l3-interface-ipv6-address:
58771         type: string
58772         description: IP address
58773       l3-interface-ipv6-prefix-length:
58774         type: integer
58775         format: int64
58776         description: Prefix length, 128 for single address
58777       vlan-id-inner:
58778         type: integer
58779         format: int64
58780         description: Inner VLAN tag
58781       vlan-id-outer:
58782         type: integer
58783         format: int64
58784         description: Outer VLAN tag
58785       is-floating:
58786         type: boolean
58787         description: Indicator of fixed or floating address
58788       resource-version:
58789         type: string
58790         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58791       neutron-network-id:
58792         type: string
58793         description: Neutron network id of the interface that address belongs to
58794       neutron-subnet-id:
58795         type: string
58796         description: Neutron id of subnet that address belongs to
58797       relationship-list:
58798         type: array
58799         items:
58800           $ref: "#/getDefinitions/relationship"
58801   l3-network:
58802     description: |
58803       Generic network definition
58804       ###### Related Nodes
58805       - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
58806       - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
58807       - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
58808       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
58809       - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
58810       - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
58811       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
58812       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
58813       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
58814       - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
58815       - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
58816       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
58817       - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
58818       - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
58819       - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
58820       - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET
58821     required:
58822     - network-id
58823     - network-name
58824     - is-bound-to-vpn
58825     - is-provider-network
58826     - is-shared-network
58827     - is-external-network
58828     properties:
58829       network-id:
58830         type: string
58831         description: Network ID, should be uuid. Unique across A&AI.
58832       network-name:
58833         type: string
58834         description: Name of the network, governed by some naming convention..
58835       network-type:
58836         type: string
58837         description: Type of the network - who defines these values?
58838       network-role:
58839         type: string
58840         description: Role the network plans - who defines these values?
58841       network-technology:
58842         type: string
58843         description: Network technology - who defines these values?
58844       neutron-network-id:
58845         type: string
58846         description: Neutron network id of this Interface
58847       is-bound-to-vpn:
58848         type: boolean
58849       service-id:
58850         type: string
58851         description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
58852       network-role-instance:
58853         type: integer
58854         format: int64
58855         description: network role instance
58856       resource-version:
58857         type: string
58858         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58859       orchestration-status:
58860         type: string
58861         description: Orchestration status of this VNF, mastered by MSO
58862       heat-stack-id:
58863         type: string
58864         description: Heat stack id corresponding to this instance, managed by MSO
58865       mso-catalog-key:
58866         type: string
58867         description: Corresponds to the SDN-C catalog id used to configure this VCE
58868       contrail-network-fqdn:
58869         type: string
58870         description: Contrail FQDN for the network
58871       persona-model-id:
58872         type: string
58873         description: the ASDC model id for this resource or service model.
58874       persona-model-version:
58875         type: string
58876         description: the ASDC model version for this resource or service model.
58877       model-version-id:
58878         type: string
58879         description: the ASDC model version for this resource or service model.
58880       persona-model-customization-id:
58881         type: string
58882         description: captures the id of all the configuration used to customize the resource for the service.
58883       widget-model-id:
58884         type: string
58885         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
58886       widget-model-version:
58887         type: string
58888         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
58889       physical-network-name:
58890         type: string
58891         description: Name associated with the physical network.
58892       is-provider-network:
58893         type: boolean
58894       is-shared-network:
58895         type: boolean
58896       is-external-network:
58897         type: boolean
58898       selflink:
58899         type: string
58900         description: Path to the controller object.
58901       subnets:
58902         type: array
58903         items:
58904           $ref: "#/getDefinitions/subnet"
58905       ctag-assignments:
58906         type: array
58907         items:
58908           $ref: "#/getDefinitions/ctag-assignment"
58909       segmentation-assignments:
58910         type: array
58911         items:
58912           $ref: "#/getDefinitions/segmentation-assignment"
58913       relationship-list:
58914         type: array
58915         items:
58916           $ref: "#/getDefinitions/relationship"
58917         description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
58918   l3-networks:
58919     properties:
58920       l3-network:
58921         type: array
58922         items:
58923           $ref: "#/getDefinitions/l3-network"
58924   lag-interface:
58925     description: |
58926       Link aggregate interface
58927       ###### Related Nodes
58928       - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
58929       - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
58930       - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
58931       - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
58932       - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
58933       - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
58934       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
58935       - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE
58936       - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK
58937     required:
58938     - interface-name
58939     properties:
58940       interface-name:
58941         type: string
58942         description: Name that identifies the link aggregate interface
58943       interface-description:
58944         type: string
58945         description: Human friendly text regarding this interface.
58946       resource-version:
58947         type: string
58948         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58949       speed-value:
58950         type: string
58951         description: Captures the numeric part of the speed
58952       speed-units:
58953         type: string
58954         description: Captures the units corresponding to the speed
58955       interface-id:
58956         type: string
58957         description: ID of interface
58958       interface-role:
58959         type: string
58960         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
58961       prov-status:
58962         type: string
58963         description: Trigger for operational monitoring of this resource by Service Assurance systems.
58964       relationship-list:
58965         type: array
58966         items:
58967           $ref: "#/getDefinitions/relationship"
58968       l-interfaces:
58969         type: array
58970         items:
58971           $ref: "#/getDefinitions/l-interface"
58972   lag-interfaces:
58973     description: |
58974       Collection of link aggregate interfaces.
58975     properties:
58976       lag-interface:
58977         type: array
58978         items:
58979           $ref: "#/getDefinitions/lag-interface"
58980   lag-link:
58981     description: |
58982       LAG links can connect lag-interfaces
58983       ###### Related Nodes
58984       - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
58985       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
58986     required:
58987     - link-name
58988     properties:
58989       link-name:
58990         type: string
58991         description: Alphabetical concatenation of lag-interface names
58992       resource-version:
58993         type: string
58994         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58995       relationship-list:
58996         type: array
58997         items:
58998           $ref: "#/getDefinitions/relationship"
58999   lag-links:
59000     description: |
59001       Collection of link aggregation connections
59002     properties:
59003       lag-link:
59004         type: array
59005         items:
59006           $ref: "#/getDefinitions/lag-link"
59007   license:
59008     description: |
59009       Metadata for license group.
59010       ###### Related Nodes
59011       - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
59012       - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
59013     required:
59014     - group-uuid
59015     - resource-uuid
59016     properties:
59017       group-uuid:
59018         type: string
59019         description: Unique ID for the license group the resource belongs to, should be uuid.
59020       resource-uuid:
59021         type: string
59022         description: Unique ID of a license resource.
59023       resource-version:
59024         type: string
59025         description: Concurrency value
59026       relationship-list:
59027         type: array
59028         items:
59029           $ref: "#/getDefinitions/relationship"
59030   licenses:
59031     description: |
59032       Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
59033     properties:
59034       license:
59035         type: array
59036         items:
59037           $ref: "#/getDefinitions/license"
59038   line-of-business:
59039     description: |
59040       describes a line-of-business
59041       ###### Related Nodes
59042       - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
59043     required:
59044     - line-of-business-name
59045     properties:
59046       line-of-business-name:
59047         type: string
59048         description: Name of the line-of-business (product)
59049       resource-version:
59050         type: string
59051         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59052       relationship-list:
59053         type: array
59054         items:
59055           $ref: "#/getDefinitions/relationship"
59056   lines-of-business:
59057     description: |
59058       Collection of lines-of-business
59059     properties:
59060       line-of-business:
59061         type: array
59062         items:
59063           $ref: "#/getDefinitions/line-of-business"
59064   logical-link:
59065     description: |
59066       Logical links generally connect l-interfaces but are used to express logical connectivity between two points
59067       ###### Related Nodes
59068       - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
59069       - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
59070       - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
59071       - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
59072       - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
59073       - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
59074       - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
59075       - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
59076       - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
59077       - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
59078       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
59079       - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
59080       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
59081     required:
59082     - link-name
59083     - link-type
59084     properties:
59085       link-name:
59086         type: string
59087         description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
59088       link-type:
59089         type: string
59090         description: Type of logical link, e.g., evc
59091       speed-value:
59092         type: string
59093         description: Captures the numeric part of the speed
59094       speed-units:
59095         type: string
59096         description: Captures the units corresponding to the speed
59097       ip-version:
59098         type: string
59099         description: v4, v6, or ds for dual stack
59100       routing-protocol:
59101         type: string
59102         description: For example, static or BGP
59103       resource-version:
59104         type: string
59105         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59106       persona-model-id:
59107         type: string
59108         description: the ASDC model id for this resource or service model.
59109       persona-model-version:
59110         type: string
59111         description: the ASDC model version for this resource or service model.
59112       model-version-id:
59113         type: string
59114         description: the ASDC model version for this resource or service model.
59115       widget-model-id:
59116         type: string
59117         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
59118       widget-model-version:
59119         type: string
59120         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
59121       operational-status:
59122         type: string
59123         description: Indication of operational status of the logical link.
59124       prov-status:
59125         type: string
59126         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
59127       link-role:
59128         type: string
59129         description: Indication of the network use of the logical link.
59130       link-name2:
59131         type: string
59132         description: Alias or alternate name (CLCI or D1 name).
59133       link-id:
59134         type: string
59135         description: UUID of the logical-link, SDNC generates this.
59136       circuit-id:
59137         type: string
59138         description: Circuit id
59139       purpose:
59140         type: string
59141         description: Reason for this entity, role it is playing
59142       relationship-list:
59143         type: array
59144         items:
59145           $ref: "#/getDefinitions/relationship"
59146   logical-links:
59147     description: |
59148       Collection of logical connections
59149     properties:
59150       logical-link:
59151         type: array
59152         items:
59153           $ref: "#/getDefinitions/logical-link"
59154   metadata:
59155     description: |
59156       Collection of metadatum (key/value pairs)
59157     properties:
59158       metadatum:
59159         type: array
59160         items:
59161           $ref: "#/getDefinitions/metadatum"
59162   metadatum:
59163     description: |
59164       Key/value pairs
59165       ###### Related Nodes
59166       - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
59167       - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
59168       - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
59169       - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
59170     required:
59171     - metaname
59172     - metaval
59173     properties:
59174       metaname:
59175         type: string
59176       metaval:
59177         type: string
59178       resource-version:
59179         type: string
59180         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59181   model:
59182     description: |
59183       Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
59184       ###### Related Nodes
59185       - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
59186       - FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
59187       - FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
59188       - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
59189       - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
59190       - MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
59191       - MODEL is DELETED when these are DELETED MODEL-VER
59192     required:
59193     - model-invariant-id
59194     - model-type
59195     properties:
59196       model-invariant-id:
59197         type: string
59198         description: Unique identifier corresponding to the main definition of a model in ASDC
59199       model-type:
59200         type: string
59201         description: Type of the model, e.g., service, resource, widget, etc.
59202       resource-version:
59203         type: string
59204         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59205       model-vers:
59206         type: array
59207         items:
59208           $ref: "#/getDefinitions/model-ver"
59209       relationship-list:
59210         type: array
59211         items:
59212           $ref: "#/getDefinitions/relationship"
59213   model-and-named-query-search:
59214     description: |
59215       ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
59216     properties:
59217       query-parameters:
59218         type: object
59219         $ref: "#/getDefinitions/query-parameters"
59220       instance-filters:
59221         type: object
59222         $ref: "#/getDefinitions/instance-filters"
59223       secondary-filts:
59224         type: object
59225         $ref: "#/getDefinitions/secondary-filts"
59226       top-node-type:
59227         type: string
59228       secondary-filter-cut-point:
59229         type: string
59230   model-constraint:
59231     description: |
59232       This is how we would capture constraints defining allowed sets of elements.
59233       ###### Related Nodes
59234       - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
59235       - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
59236       - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET
59237     required:
59238     - model-constraint-uuid
59239     - constrained-element-set-uuid-to-replace
59240     properties:
59241       model-constraint-uuid:
59242         type: string
59243       constrained-element-set-uuid-to-replace:
59244         type: string
59245       constrained-element-sets:
59246         type: array
59247         items:
59248           $ref: "#/getDefinitions/constrained-element-set"
59249       resource-version:
59250         type: string
59251         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59252   model-constraints:
59253     properties:
59254       model-constraint:
59255         type: array
59256         items:
59257           $ref: "#/getDefinitions/model-constraint"
59258   model-element:
59259     description: |
59260       Defines how other models combine to make up a higher-level model.
59261       ###### Related Nodes
59262       - TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
59263       - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
59264       - TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
59265       - TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
59266       - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
59267       - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
59268       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
59269       - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT
59270     required:
59271     - model-element-uuid
59272     - new-data-del-flag
59273     - cardinality
59274     properties:
59275       model-element-uuid:
59276         type: string
59277       new-data-del-flag:
59278         type: string
59279         description: Indicates whether this element was created as part of instantiation from this model
59280       cardinality:
59281         type: string
59282         description: How many of this type of element are required/allowed
59283       linkage-points:
59284         type: string
59285       resource-version:
59286         type: string
59287         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59288       model-elements:
59289         type: array
59290         items:
59291           $ref: "#/getDefinitions/model-element"
59292         description: Defines how other models combine to make up a higher-level model
59293       model-constraints:
59294         type: array
59295         items:
59296           $ref: "#/getDefinitions/model-constraint"
59297         description: Describes new constraints on this model element that are not part of that model's definition
59298       relationship-list:
59299         type: array
59300         items:
59301           $ref: "#/getDefinitions/relationship"
59302   model-elements:
59303     properties:
59304       model-element:
59305         type: array
59306         items:
59307           $ref: "#/getDefinitions/model-element"
59308   model-ver:
59309     description: |
59310       Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
59311       ###### Related Nodes
59312       - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
59313       - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
59314       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
59315       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
59316       - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT
59317       - MODEL-VER is DELETED when these are DELETED MODEL-ELEMENT,METADATUM
59318     required:
59319     - model-version-id
59320     - model-name
59321     - model-version
59322     properties:
59323       model-version-id:
59324         type: string
59325         description: Unique identifier corresponding to one version of a model in ASDC
59326       model-name:
59327         type: string
59328         description: Name of the model, which can change from version to version.
59329       model-version:
59330         type: string
59331         description: Version
59332       model-description:
59333         type: string
59334         description: Description
59335       resource-version:
59336         type: string
59337         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59338       model-elements:
59339         type: array
59340         items:
59341           $ref: "#/getDefinitions/model-element"
59342       metadata:
59343         type: array
59344         items:
59345           $ref: "#/getDefinitions/metadatum"
59346       relationship-list:
59347         type: array
59348         items:
59349           $ref: "#/getDefinitions/relationship"
59350   model-vers:
59351     properties:
59352       model-ver:
59353         type: array
59354         items:
59355           $ref: "#/getDefinitions/model-ver"
59356   models:
59357     description: |
59358       Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
59359     properties:
59360       model:
59361         type: array
59362         items:
59363           $ref: "#/getDefinitions/model"
59364   multicast-configuration:
59365     description: |
59366       ###### Related Nodes
59367       - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
59368     required:
59369     - multicast-configuration-id
59370     - multicast-protocol
59371     - rp-type
59372     properties:
59373       multicast-configuration-id:
59374         type: string
59375         description: Unique id of multicast configuration.
59376       multicast-protocol:
59377         type: string
59378         description: protocol of multicast configuration
59379       rp-type:
59380         type: string
59381         description: rp type of multicast configuration
59382       resource-version:
59383         type: string
59384         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59385       relationship-list:
59386         type: array
59387         items:
59388           $ref: "#/getDefinitions/relationship"
59389   multicast-configurations:
59390     description: |
59391       multicast configuration of generic-vnf ip-address
59392     properties:
59393       multicast-configuration:
59394         type: array
59395         items:
59396           $ref: "#/getDefinitions/multicast-configuration"
59397   named-queries:
59398     properties:
59399       named-query:
59400         type: array
59401         items:
59402           $ref: "#/getDefinitions/named-query"
59403   named-query:
59404     description: |
59405       TBD
59406       ###### Related Nodes
59407       - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
59408       - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
59409       - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
59410       - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT
59411     required:
59412     - named-query-uuid
59413     - named-query-name
59414     - named-query-version
59415     properties:
59416       named-query-uuid:
59417         type: string
59418       named-query-name:
59419         type: string
59420       named-query-version:
59421         type: string
59422       required-input-param:
59423         type: string
59424       description:
59425         type: string
59426       resource-version:
59427         type: string
59428       named-query-elements:
59429         type: array
59430         items:
59431           $ref: "#/getDefinitions/named-query-element"
59432       relationship-list:
59433         type: array
59434         items:
59435           $ref: "#/getDefinitions/relationship"
59436   named-query-element:
59437     description: |
59438       TBD
59439       ###### Related Nodes
59440       - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
59441       - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
59442       - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
59443       - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
59444       - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
59445       - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
59446       - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP
59447     required:
59448     - named-query-element-uuid
59449     properties:
59450       named-query-element-uuid:
59451         type: string
59452       property-collect-list:
59453         type: string
59454       resource-version:
59455         type: string
59456       property-limit-desc:
59457         type: string
59458       do-not-output:
59459         type: string
59460       named-query-elements:
59461         type: array
59462         items:
59463           $ref: "#/getDefinitions/named-query-element"
59464       related-lookups:
59465         type: array
59466         items:
59467           $ref: "#/getDefinitions/related-lookup"
59468       property-constraints:
59469         type: array
59470         items:
59471           $ref: "#/getDefinitions/property-constraint"
59472       relationship-list:
59473         type: array
59474         items:
59475           $ref: "#/getDefinitions/relationship"
59476   named-query-elements:
59477     properties:
59478       named-query-element:
59479         type: array
59480         items:
59481           $ref: "#/getDefinitions/named-query-element"
59482   network:
59483     description: |
59484       Namespace for network inventory resources.
59485     properties:
59486       logical-links:
59487         type: array
59488         items:
59489           $ref: "#/getDefinitions/logical-link"
59490       site-pair-sets:
59491         type: array
59492         items:
59493           $ref: "#/getDefinitions/site-pair-set"
59494       vpn-bindings:
59495         type: array
59496         items:
59497           $ref: "#/getDefinitions/vpn-binding"
59498       vpls-pes:
59499         type: array
59500         items:
59501           $ref: "#/getDefinitions/vpls-pe"
59502       multicast-configurations:
59503         type: array
59504         items:
59505           $ref: "#/getDefinitions/multicast-configuration"
59506       vces:
59507         type: array
59508         items:
59509           $ref: "#/getDefinitions/vce"
59510       vnfcs:
59511         type: array
59512         items:
59513           $ref: "#/getDefinitions/vnfc"
59514       l3-networks:
59515         type: array
59516         items:
59517           $ref: "#/getDefinitions/l3-network"
59518       network-policies:
59519         type: array
59520         items:
59521           $ref: "#/getDefinitions/network-policy"
59522       generic-vnfs:
59523         type: array
59524         items:
59525           $ref: "#/getDefinitions/generic-vnf"
59526       lag-links:
59527         type: array
59528         items:
59529           $ref: "#/getDefinitions/lag-link"
59530       newvces:
59531         type: array
59532         items:
59533           $ref: "#/getDefinitions/newvce"
59534       pnfs:
59535         type: array
59536         items:
59537           $ref: "#/getDefinitions/pnf"
59538       physical-links:
59539         type: array
59540         items:
59541           $ref: "#/getDefinitions/physical-link"
59542       ipsec-configurations:
59543         type: array
59544         items:
59545           $ref: "#/getDefinitions/ipsec-configuration"
59546       route-table-references:
59547         type: array
59548         items:
59549           $ref: "#/getDefinitions/route-table-reference"
59550       instance-groups:
59551         type: array
59552         items:
59553           $ref: "#/getDefinitions/instance-group"
59554       zones:
59555         type: array
59556         items:
59557           $ref: "#/getDefinitions/zone"
59558   network-policies:
59559     properties:
59560       network-policy:
59561         type: array
59562         items:
59563           $ref: "#/getDefinitions/network-policy"
59564   network-policy:
59565     description: |
59566       ###### Related Nodes
59567       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
59568     required:
59569     - network-policy-id
59570     properties:
59571       network-policy-id:
59572         type: string
59573         description: UUID representing unique key to this instance
59574       network-policy-fqdn:
59575         type: string
59576         description: Contrail FQDN for the policy
59577       heat-stack-id:
59578         type: string
59579         description: ID for the openStack Heat instance
59580       resource-version:
59581         type: string
59582         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59583       relationship-list:
59584         type: array
59585         items:
59586           $ref: "#/getDefinitions/relationship"
59587   network-profile:
59588     description: |
59589       Network profile populated by SDN-GP for SNMP
59590       ###### Related Nodes
59591       - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
59592     required:
59593     - nm-profile-name
59594     properties:
59595       nm-profile-name:
59596         type: string
59597         description: Unique name of network profile.
59598       community-string:
59599         type: string
59600         description: Encrypted SNMP community string
59601       resource-version:
59602         type: string
59603         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59604       relationship-list:
59605         type: array
59606         items:
59607           $ref: "#/getDefinitions/relationship"
59608   network-profiles:
59609     description: |
59610       Collection of network profiles
59611     properties:
59612       network-profile:
59613         type: array
59614         items:
59615           $ref: "#/getDefinitions/network-profile"
59616   newvce:
59617     description: |
59618       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
59619       ###### Related Nodes
59620       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
59621       - NEWVCE is DELETED when these are DELETED L-INTERFACE
59622     required:
59623     - vnf-id2
59624     - vnf-name
59625     - vnf-type
59626     properties:
59627       vnf-id2:
59628         type: string
59629         description: Unique id of VNF, can't use same attribute name right now until we promote this new object
59630       vnf-name:
59631         type: string
59632         description: Name of VNF.
59633       vnf-name2:
59634         type: string
59635         description: Alternate name of VNF.
59636       vnf-type:
59637         type: string
59638         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
59639       prov-status:
59640         type: string
59641         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
59642       operational-state:
59643         type: string
59644         description: Indicator for whether the resource is considered operational
59645       license-key:
59646         type: string
59647         description: OBSOLETE -  do not use
59648       ipv4-oam-address:
59649         type: string
59650         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by VPE (v4-loopback0-ip-address).
59651       equipment-role:
59652         type: string
59653         description: Client should send valid enumerated value.
59654       resource-version:
59655         type: string
59656         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59657       ipv4-loopback0-address:
59658         type: string
59659         description: v4 Loopback0 address
59660       orchestration-status:
59661         type: string
59662         description: Orchestration status of this VNF, mastered by MSO.
59663       heat-stack-id:
59664         type: string
59665         description: Heat stack id corresponding to this instance, managed by MSO
59666       mso-catalog-key:
59667         type: string
59668         description: Corresponds to the SDN-C catalog id used to configure this VCE
59669       relationship-list:
59670         type: array
59671         items:
59672           $ref: "#/getDefinitions/relationship"
59673       l-interfaces:
59674         type: array
59675         items:
59676           $ref: "#/getDefinitions/l-interface"
59677   newvces:
59678     description: |
59679       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
59680     properties:
59681       newvce:
59682         type: array
59683         items:
59684           $ref: "#/getDefinitions/newvce"
59685   notification-event:
59686     properties:
59687       cambria.partition:
59688         type: string
59689       notification-event-header:
59690         type: object
59691         $ref: "#/getDefinitions/notification-event-header"
59692   notification-event-header:
59693     properties:
59694       id:
59695         type: string
59696       timestamp:
59697         type: string
59698       source-name:
59699         type: string
59700       domain:
59701         type: string
59702       sequence-number:
59703         type: string
59704       severity:
59705         type: string
59706       event-type:
59707         type: string
59708       version:
59709         type: string
59710       action:
59711         type: string
59712       entity-type:
59713         type: string
59714       top-entity-type:
59715         type: string
59716       entity-link:
59717         type: string
59718       status:
59719         type: string
59720   notify:
59721     required:
59722     - event-id
59723     properties:
59724       event-id:
59725         type: string
59726       node-type:
59727         type: string
59728       event-trigger:
59729         type: string
59730       key-data:
59731         type: array
59732         items:
59733           $ref: "#/getDefinitions/key-data"
59734       selflink:
59735         type: string
59736   oam-network:
59737     description: |
59738       OAM network, to be deprecated shortly.  Do not use for new purposes.
59739       ###### Related Nodes
59740       - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
59741       - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
59742       - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
59743     required:
59744     - network-uuid
59745     - network-name
59746     - cvlan-tag
59747     properties:
59748       network-uuid:
59749         type: string
59750         description: UUID of the network. Unique across a cloud-region
59751       network-name:
59752         type: string
59753         description: Name of the network.
59754       cvlan-tag:
59755         type: integer
59756         format: int64
59757         description: cvlan-id
59758       ipv4-oam-gateway-address:
59759         type: string
59760         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
59761       ipv4-oam-gateway-address-prefix-length:
59762         type: integer
59763         format: int32
59764         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
59765       resource-version:
59766         type: string
59767         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59768       relationship-list:
59769         type: array
59770         items:
59771           $ref: "#/getDefinitions/relationship"
59772   oam-networks:
59773     description: |
59774       Collection of OAM networks, to be deprecated shortly.  Do not use for new purposes.
59775     properties:
59776       oam-network:
59777         type: array
59778         items:
59779           $ref: "#/getDefinitions/oam-network"
59780   operational-environment:
59781     description: |
59782       It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
59783       ###### Related Nodes
59784       - TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
59785       - FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
59786     required:
59787     - operational-environment-id
59788     - operational-environment-name
59789     - operational-environment-type
59790     - operational-environment-status
59791     - tenant-context
59792     - workload-context
59793     properties:
59794       operational-environment-id:
59795         type: string
59796         description: UUID of an operational environment
59797       operational-environment-name:
59798         type: string
59799         description: Operational Environment name
59800       operational-environment-type:
59801         type: string
59802         description: Operational Environment Type.
59803       operational-environment-status:
59804         type: string
59805         description: Status
59806       tenant-context:
59807         type: string
59808         description: Tenant Context.
59809       workload-context:
59810         type: string
59811         description: Workload Context.
59812       resource-version:
59813         type: string
59814         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59815       relationship-list:
59816         type: array
59817         items:
59818           $ref: "#/getDefinitions/relationship"
59819   operational-environments:
59820     description: |
59821       a logical partition of the cloud which allows to have multiple environments in the production AIC.
59822     properties:
59823       operational-environment:
59824         type: array
59825         items:
59826           $ref: "#/getDefinitions/operational-environment"
59827   overloaded-model:
59828     description: |
59829       Allows for legacy POST of old-style and new-style models
59830     required:
59831     - model-invariant-id
59832     - model-name-version-id
59833     - model-type
59834     - model-name
59835     - model-id
59836     - model-version
59837     properties:
59838       model-invariant-id:
59839         type: string
59840         description: Unique identifier corresponding to the main definition of a model in ASDC
59841       model-name-version-id:
59842         type: string
59843         description: Unique identifier corresponding to one version of a model in ASDC
59844       model-type:
59845         type: string
59846         description: Type of the model, e.g., service, resource, widget, etc.
59847       model-name:
59848         type: string
59849         description: Name of the model, which can change from version to version.
59850       model-id:
59851         type: string
59852         description: Invariant unique ID which does not change from version to version
59853       model-version:
59854         type: string
59855         description: Version
59856       model-description:
59857         type: string
59858         description: Description
59859       resource-version:
59860         type: string
59861         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59862       model-vers:
59863         type: object
59864         $ref: "#/getDefinitions/model-vers"
59865       relationship-list:
59866         type: object
59867         $ref: "#/getDefinitions/relationship-list"
59868   owning-entities:
59869     description: |
59870       Collection of owning-entities
59871     properties:
59872       owning-entity:
59873         type: array
59874         items:
59875           $ref: "#/getDefinitions/owning-entity"
59876   owning-entity:
59877     description: |
59878       describes an owning-entity
59879       ###### Related Nodes
59880       - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
59881     required:
59882     - owning-entity-id
59883     - owning-entity-name
59884     properties:
59885       owning-entity-id:
59886         type: string
59887         description: UUID of an owning entity
59888       owning-entity-name:
59889         type: string
59890         description: Owning entity name
59891       resource-version:
59892         type: string
59893         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59894       relationship-list:
59895         type: array
59896         items:
59897           $ref: "#/getDefinitions/relationship"
59898   p-interface:
59899     description: |
59900       Physical interface (e.g., nic)
59901       ###### Related Nodes
59902       - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
59903       - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
59904       - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
59905       - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
59906       - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
59907       - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
59908       - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
59909       - P-INTERFACE is DELETED when these are DELETED L-INTERFACE
59910       - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK
59911     required:
59912     - interface-name
59913     properties:
59914       interface-name:
59915         type: string
59916         description: Name that identifies the physical interface
59917       speed-value:
59918         type: string
59919         description: Captures the numeric part of the speed
59920       speed-units:
59921         type: string
59922         description: Captures the units corresponding to the speed
59923       port-description:
59924         type: string
59925         description: Nature of the services and connectivity on this port.
59926       equipment-identifier:
59927         type: string
59928         description: CLEI or other specification for p-interface hardware.
59929       interface-role:
59930         type: string
59931         description: Role specification for p-interface hardware.
59932       interface-type:
59933         type: string
59934         description: Indicates the physical properties of the interface.
59935       prov-status:
59936         type: string
59937         description: Trigger for operational monitoring of this resource by Service Assurance systems.
59938       resource-version:
59939         type: string
59940         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59941       relationship-list:
59942         type: array
59943         items:
59944           $ref: "#/getDefinitions/relationship"
59945       l-interfaces:
59946         type: array
59947         items:
59948           $ref: "#/getDefinitions/l-interface"
59949   p-interfaces:
59950     description: |
59951       Collection of physical interfaces.
59952     properties:
59953       p-interface:
59954         type: array
59955         items:
59956           $ref: "#/getDefinitions/p-interface"
59957   physical-link:
59958     description: |
59959       Collection of physical connections, typically between p-interfaces
59960       ###### Related Nodes
59961       - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
59962     required:
59963     - link-name
59964     properties:
59965       link-name:
59966         type: string
59967         description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
59968       speed-value:
59969         type: string
59970         description: Captures the numeric part of the speed
59971       speed-units:
59972         type: string
59973         description: Captures the units corresponding to the speed
59974       circuit-id:
59975         type: string
59976         description: Circuit it
59977       dual-mode:
59978         type: string
59979         description: Dual access mode (e.g., primary, secondary
59980       management-option:
59981         type: string
59982         description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
59983       service-provider-name:
59984         type: string
59985         description: Name of the service Provider on this link.
59986       resource-version:
59987         type: string
59988         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59989       relationship-list:
59990         type: array
59991         items:
59992           $ref: "#/getDefinitions/relationship"
59993   physical-links:
59994     description: |
59995       Collection of physical connections, typically between p-interfaces
59996     properties:
59997       physical-link:
59998         type: array
59999         items:
60000           $ref: "#/getDefinitions/physical-link"
60001   platform:
60002     description: |
60003       describes a platform
60004       ###### Related Nodes
60005       - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
60006     required:
60007     - platform-name
60008     properties:
60009       platform-name:
60010         type: string
60011         description: Name of the platform
60012       resource-version:
60013         type: string
60014         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60015       relationship-list:
60016         type: array
60017         items:
60018           $ref: "#/getDefinitions/relationship"
60019   platforms:
60020     description: |
60021       Collection of platforms
60022     properties:
60023       platform:
60024         type: array
60025         items:
60026           $ref: "#/getDefinitions/platform"
60027   pnf:
60028     description: |
60029       PNF represents a physical network function. typically equipment used in the D1 world.
60030       ###### Related Nodes
60031       - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
60032       - TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
60033       - TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
60034       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
60035       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
60036       - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
60037       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
60038       - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
60039     required:
60040     - pnf-name
60041     - in-maint
60042     properties:
60043       pnf-name:
60044         type: string
60045         description: unique name of Physical Network Function.
60046       pnf-name2:
60047         type: string
60048         description: name of Physical Network Function.
60049       pnf-name2-source:
60050         type: string
60051         description: source of name2
60052       pnf-id:
60053         type: string
60054         description: id of pnf
60055       equip-type:
60056         type: string
60057         description: Equipment type.  Source of truth should define valid values.
60058       equip-vendor:
60059         type: string
60060         description: Equipment vendor.  Source of truth should define valid values.
60061       equip-model:
60062         type: string
60063         description: Equipment model.  Source of truth should define valid values.
60064       management-option:
60065         type: string
60066         description: identifier of managed by company or customer
60067       ipaddress-v4-oam:
60068         type: string
60069         description: ipv4-oam-address with new naming convention for IP addresses
60070       sw-version:
60071         type: string
60072         description: sw-version is the version of SW for the hosted application on the PNF.
60073       in-maint:
60074         type: boolean
60075       frame-id:
60076         type: string
60077         description: ID of the physical frame (relay rack) where pnf is installed.
60078       serial-number:
60079         type: string
60080         description: Serial number of the device
60081       ipaddress-v4-loopback-0:
60082         type: string
60083         description: IPV4 Loopback 0 address
60084       ipaddress-v6-loopback-0:
60085         type: string
60086         description: IPV6 Loopback 0 address
60087       ipaddress-v4-aim:
60088         type: string
60089         description: IPV4 AIM address
60090       ipaddress-v6-aim:
60091         type: string
60092         description: IPV6 AIM address
60093       ipaddress-v6-oam:
60094         type: string
60095         description: IPV6 OAM address
60096       inv-status:
60097         type: string
60098         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
60099       resource-version:
60100         type: string
60101         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60102       prov-status:
60103         type: string
60104         description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
60105       nf-role:
60106         type: string
60107         description: Nf Role is the role performed by this instance in the network.
60108       relationship-list:
60109         type: array
60110         items:
60111           $ref: "#/getDefinitions/relationship"
60112       p-interfaces:
60113         type: array
60114         items:
60115           $ref: "#/getDefinitions/p-interface"
60116       lag-interfaces:
60117         type: array
60118         items:
60119           $ref: "#/getDefinitions/lag-interface"
60120   pnfs:
60121     description: |
60122       Collection of Physical Network Functions.
60123     properties:
60124       pnf:
60125         type: array
60126         items:
60127           $ref: "#/getDefinitions/pnf"
60128   port-group:
60129     description: |
60130       Used to capture the network interfaces of this VCE
60131       ###### Related Nodes
60132       - TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
60133       - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE)
60134       - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG
60135     required:
60136     - interface-id
60137     - orchestration-status
60138     properties:
60139       interface-id:
60140         type: string
60141         description: Unique ID of the interface
60142       neutron-network-id:
60143         type: string
60144         description: Neutron network id of this Interface
60145       neutron-network-name:
60146         type: string
60147         description: Neutron network name of this Interface
60148       interface-role:
60149         type: string
60150         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
60151       resource-version:
60152         type: string
60153         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60154       port-group-id:
60155         type: string
60156         description: Unique ID for port group in vmware
60157       port-group-name:
60158         type: string
60159         description: Likely to duplicate value of neutron network name
60160       switch-name:
60161         type: string
60162         description: DVS or standard switch name (should be non-null for port groups associated with DVS)
60163       orchestration-status:
60164         type: string
60165         description: Orchestration status of this VNF, mastered by MSO
60166       heat-stack-id:
60167         type: string
60168         description: Heat stack id corresponding to this instance, managed by MSO
60169       mso-catalog-key:
60170         type: string
60171         description: Corresponds to the SDN-C catalog id used to configure this VCE
60172       cvlan-tags:
60173         type: array
60174         items:
60175           $ref: "#/getDefinitions/cvlan-tag-entry"
60176       relationship-list:
60177         type: array
60178         items:
60179           $ref: "#/getDefinitions/relationship"
60180   port-groups:
60181     properties:
60182       port-group:
60183         type: array
60184         items:
60185           $ref: "#/getDefinitions/port-group"
60186   project:
60187     description: |
60188       describes the project
60189       ###### Related Nodes
60190       - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
60191     required:
60192     - project-name
60193     properties:
60194       project-name:
60195         type: string
60196         description: Name of the project deploying a service
60197       resource-version:
60198         type: string
60199         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60200       relationship-list:
60201         type: array
60202         items:
60203           $ref: "#/getDefinitions/relationship"
60204   projects:
60205     description: |
60206       Collection of projects
60207     properties:
60208       project:
60209         type: array
60210         items:
60211           $ref: "#/getDefinitions/project"
60212   properties:
60213     description: |
60214       Property holder for query properties or instance properties
60215     properties:
60216       property-name:
60217         type: string
60218       property-value:
60219         type: string
60220   property-constraint:
60221     description: |
60222       TBD
60223       ###### Related Nodes
60224       - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
60225     required:
60226     - property-constraint-uuid
60227     - constraint-type
60228     - property-name
60229     - property-value
60230     properties:
60231       property-constraint-uuid:
60232         type: string
60233       constraint-type:
60234         type: string
60235       property-name:
60236         type: string
60237       property-value:
60238         type: string
60239       resource-version:
60240         type: string
60241   property-constraints:
60242     properties:
60243       property-constraint:
60244         type: array
60245         items:
60246           $ref: "#/getDefinitions/property-constraint"
60247   pserver:
60248     description: |
60249       Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
60250       ###### Related Nodes
60251       - TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
60252       - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
60253       - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
60254       - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
60255       - TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
60256       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
60257       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
60258       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
60259       - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
60260       - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
60261       - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER
60262       - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
60263       - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT
60264     required:
60265     - hostname
60266     - in-maint
60267     properties:
60268       hostname:
60269         type: string
60270         description: Value from executing hostname on the compute node.
60271       ptnii-equip-name:
60272         type: string
60273         description: PTNII name
60274       number-of-cpus:
60275         type: integer
60276         format: int32
60277         description: Number of cpus
60278       disk-in-gigabytes:
60279         type: integer
60280         format: int32
60281         description: Disk size, in GBs
60282       ram-in-megabytes:
60283         type: integer
60284         format: int32
60285         description: RAM size, in MBs
60286       equip-type:
60287         type: string
60288         description: Equipment type.  Source of truth should define valid values.
60289       equip-vendor:
60290         type: string
60291         description: Equipment vendor.  Source of truth should define valid values.
60292       equip-model:
60293         type: string
60294         description: Equipment model.  Source of truth should define valid values.
60295       fqdn:
60296         type: string
60297         description: Fully-qualified domain name
60298       pserver-selflink:
60299         type: string
60300         description: URL to endpoint where AAI can get more details
60301       ipv4-oam-address:
60302         type: string
60303         description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
60304       serial-number:
60305         type: string
60306         description: Serial number, may be queried
60307       ipaddress-v4-loopback-0:
60308         type: string
60309         description: IPV4 Loopback 0 address
60310       ipaddress-v6-loopback-0:
60311         type: string
60312         description: IPV6 Loopback 0 address
60313       ipaddress-v4-aim:
60314         type: string
60315         description: IPV4 AIM address
60316       ipaddress-v6-aim:
60317         type: string
60318         description: IPV6 AIM address
60319       ipaddress-v6-oam:
60320         type: string
60321         description: IPV6 OAM address
60322       inv-status:
60323         type: string
60324         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
60325       pserver-id:
60326         type: string
60327         description: ID of Pserver
60328       internet-topology:
60329         type: string
60330         description: internet topology of Pserver
60331       in-maint:
60332         type: boolean
60333       resource-version:
60334         type: string
60335         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60336       pserver-name2:
60337         type: string
60338         description: alternative pserver name
60339       purpose:
60340         type: string
60341         description: purpose of pserver
60342       prov-status:
60343         type: string
60344         description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
60345       relationship-list:
60346         type: array
60347         items:
60348           $ref: "#/getDefinitions/relationship"
60349       p-interfaces:
60350         type: array
60351         items:
60352           $ref: "#/getDefinitions/p-interface"
60353       lag-interfaces:
60354         type: array
60355         items:
60356           $ref: "#/getDefinitions/lag-interface"
60357   pservers:
60358     description: |
60359       Collection of compute hosts.
60360     properties:
60361       pserver:
60362         type: array
60363         items:
60364           $ref: "#/getDefinitions/pserver"
60365   query-parameters:
60366     description: |
60367       QueryParameters for performing a named-query or model query
60368     properties:
60369       named-query:
60370         type: object
60371         $ref: "#/getDefinitions/named-query"
60372       overloaded-model:
60373         type: object
60374         $ref: "#/getDefinitions/overloaded-model"
60375   related-lookup:
60376     description: |
60377       TBD
60378       ###### Related Nodes
60379       - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
60380     required:
60381     - related-lookup-uuid
60382     - source-node-type
60383     - source-node-property
60384     - target-node-type
60385     - target-node-property
60386     properties:
60387       related-lookup-uuid:
60388         type: string
60389       source-node-type:
60390         type: string
60391       source-node-property:
60392         type: string
60393       target-node-type:
60394         type: string
60395       target-node-property:
60396         type: string
60397       property-collect-list:
60398         type: string
60399       resource-version:
60400         type: string
60401       relationship-list:
60402         type: array
60403         items:
60404           $ref: "#/getDefinitions/relationship"
60405   related-lookups:
60406     properties:
60407       related-lookup:
60408         type: array
60409         items:
60410           $ref: "#/getDefinitions/related-lookup"
60411   related-to-property:
60412     properties:
60413       property-key:
60414         type: string
60415         description: Key part of a key/value pair
60416       property-value:
60417         type: string
60418         description: Value part of a key/value pair
60419   relationship:
60420     properties:
60421       related-to:
60422         type: string
60423         description: A keyword provided by A&AI to indicate type of node.
60424       related-link:
60425         type: string
60426         description: URL to the object in A&AI.
60427       relationship-data:
60428         type: array
60429         items:
60430           $ref: "#/getDefinitions/relationship-data"
60431       related-to-property:
60432         type: array
60433         items:
60434           $ref: "#/getDefinitions/related-to-property"
60435   relationship-data:
60436     required:
60437     - relationship-key
60438     - relationship-value
60439     properties:
60440       relationship-key:
60441         type: string
60442         description: A keyword provided by A&AI to indicate an attribute.
60443       relationship-value:
60444         type: string
60445         description: Value of the attribute.
60446   relationship-list:
60447     properties:
60448       relationship:
60449         type: array
60450         items:
60451           $ref: "#/getDefinitions/relationship"
60452   reserved-prop-names:
60453     description: |
60454       Internal map to define some reserved properties of a vertex
60455     properties:
60456       last-mod-source-of-truth:
60457         type: string
60458       aai-node-type:
60459         type: string
60460       aai-created-ts:
60461         type: integer
60462         format: int64
60463       aai-unique-key:
60464         type: string
60465       aai-last-mod-ts:
60466         type: integer
60467         format: int64
60468       source-of-truth:
60469         type: string
60470       aai-uri:
60471         type: string
60472   response-list:
60473     description: |
60474       Response container for the results of a named-query or model query
60475     properties:
60476       inventory-response-items:
60477         type: object
60478         $ref: "#/getDefinitions/inventory-response-items"
60479   result-data:
60480     properties:
60481       resource-type:
60482         type: string
60483         description: The specific type of node in the A&AI graph
60484       resource-link:
60485         type: string
60486         description: The URL to the specific resource
60487   route-table-reference:
60488     description: |
60489       Openstack route table reference.
60490       ###### Related Nodes
60491       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
60492     required:
60493     - route-table-reference-id
60494     - route-table-reference-fqdn
60495     properties:
60496       route-table-reference-id:
60497         type: string
60498         description: Route Table Reference id, UUID assigned to this instance.
60499       route-table-reference-fqdn:
60500         type: string
60501         description: FQDN entry in the route table.
60502       resource-version:
60503         type: string
60504         description: Concurrency value
60505       relationship-list:
60506         type: array
60507         items:
60508           $ref: "#/getDefinitions/relationship"
60509   route-table-references:
60510     description: |
60511       Collection of openstack route table references
60512     properties:
60513       route-table-reference:
60514         type: array
60515         items:
60516           $ref: "#/getDefinitions/route-table-reference"
60517   route-target:
60518     description: |
60519       Route target information
60520       ###### Related Nodes
60521       - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
60522     required:
60523     - global-route-target
60524     - route-target-role
60525     properties:
60526       global-route-target:
60527         type: string
60528         description: Number used to identify an RT, globally unique in the network
60529       route-target-role:
60530         type: string
60531         description: Role assigned to this route target
60532       resource-version:
60533         type: string
60534         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60535       relationship-list:
60536         type: array
60537         items:
60538           $ref: "#/getDefinitions/relationship"
60539   route-targets:
60540     description: |
60541       Collection of route target information
60542     properties:
60543       route-target:
60544         type: array
60545         items:
60546           $ref: "#/getDefinitions/route-target"
60547   routing-instance:
60548     description: |
60549       ###### Related Nodes
60550       - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
60551       - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
60552       - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR
60553     required:
60554     - routing-instance-id
60555     properties:
60556       routing-instance-id:
60557         type: string
60558         description: Unique id of routing instance
60559       rpm-owner:
60560         type: string
60561         description: rpm owner
60562       resource-version:
60563         type: string
60564         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60565       site-pairs:
60566         type: array
60567         items:
60568           $ref: "#/getDefinitions/site-pair"
60569       relationship-list:
60570         type: array
60571         items:
60572           $ref: "#/getDefinitions/relationship"
60573   routing-instances:
60574     description: |
60575       set of probes related to generic-vnf routing instance
60576     properties:
60577       routing-instance:
60578         type: array
60579         items:
60580           $ref: "#/getDefinitions/routing-instance"
60581   sdn-zone-response:
60582     properties:
60583       oam-networks:
60584         type: object
60585         $ref: "#/getDefinitions/oam-networks"
60586       az-and-dvs-switches:
60587         type: array
60588         items:
60589           $ref: "#/getDefinitions/az-and-dvs-switches"
60590   search:
60591     properties:
60592       edge-tag-query-result:
60593         type: object
60594         $ref: "#/getDefinitions/edge-tag-query-result"
60595       edge-tag-query-request:
60596         type: object
60597         $ref: "#/getDefinitions/edge-tag-query-request"
60598       search-results:
60599         type: object
60600         $ref: "#/getDefinitions/search-results"
60601       sdn-zone-response:
60602         type: object
60603         $ref: "#/getDefinitions/sdn-zone-response"
60604   search-results:
60605     properties:
60606       result-data:
60607         type: array
60608         items:
60609           $ref: "#/getDefinitions/result-data"
60610   secondary-filt:
60611     description: |
60612       SecondaryFilt for performing a named-query or model query
60613   secondary-filter:
60614     properties:
60615       property-name:
60616         type: string
60617       filter-type:
60618         type: string
60619       property-value:
60620         type: string
60621   secondary-filts:
60622     description: |
60623       SecondaryFilts for performing a named-query or model query
60624     properties:
60625       secondary-filt:
60626         type: array
60627         items:
60628           $ref: "#/getDefinitions/secondary-filt"
60629   segmentation-assignment:
60630     description: |
60631       Openstack segmentation assignment.
60632       ###### Related Nodes
60633       - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
60634     required:
60635     - segmentation-id
60636     properties:
60637       segmentation-id:
60638         type: string
60639         description: Route Table Reference id, UUID assigned to this instance.
60640       resource-version:
60641         type: string
60642         description: Concurrency value
60643       relationship-list:
60644         type: array
60645         items:
60646           $ref: "#/getDefinitions/relationship"
60647   segmentation-assignments:
60648     description: |
60649       Collection of openstack segmentation assignments
60650     properties:
60651       segmentation-assignment:
60652         type: array
60653         items:
60654           $ref: "#/getDefinitions/segmentation-assignment"
60655   service:
60656     description: |
60657       Stand-in for service model definitions.  Likely to be deprecated in favor of models from ASDC.  Does not strictly map to ASDC services.
60658     required:
60659     - service-id
60660     - service-description
60661     properties:
60662       service-id:
60663         type: string
60664         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
60665       service-description:
60666         type: string
60667         description: Description of the service
60668       service-selflink:
60669         type: string
60670         description: URL to endpoint where AAI can get more details
60671       resource-version:
60672         type: string
60673         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60674       service-version:
60675         type: string
60676         description: service version
60677       relationship-list:
60678         type: array
60679         items:
60680           $ref: "#/getDefinitions/relationship"
60681   service-capabilities:
60682     description: |
60683       Collection of service capabilities.
60684     properties:
60685       service-capability:
60686         type: array
60687         items:
60688           $ref: "#/getDefinitions/service-capability"
60689   service-capability:
60690     description: |
60691       Early definition of server/resource pairings, likely to be replaced by models.  No new use should be made of this.
60692       ###### Related Nodes
60693       - FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
60694       - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
60695       - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK
60696     required:
60697     - service-type
60698     - vnf-type
60699     properties:
60700       service-type:
60701         type: string
60702         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
60703       vnf-type:
60704         type: string
60705         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
60706       resource-version:
60707         type: string
60708         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60709       relationship-list:
60710         type: array
60711         items:
60712           $ref: "#/getDefinitions/relationship"
60713   service-design-and-creation:
60714     description: |
60715       Namespace for objects managed by ASDC
60716     properties:
60717       vnf-images:
60718         type: array
60719         items:
60720           $ref: "#/getDefinitions/vnf-image"
60721       services:
60722         type: array
60723         items:
60724           $ref: "#/getDefinitions/service"
60725       service-capabilities:
60726         type: array
60727         items:
60728           $ref: "#/getDefinitions/service-capability"
60729       models:
60730         type: array
60731         items:
60732           $ref: "#/getDefinitions/model"
60733       named-queries:
60734         type: array
60735         items:
60736           $ref: "#/getDefinitions/named-query"
60737   service-instance:
60738     description: |
60739       Instance of a service
60740       ###### Related Nodes
60741       - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
60742       - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
60743       - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
60744       - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
60745       - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
60746       - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY)
60747       - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
60748       - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
60749       - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
60750       - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
60751       - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
60752       - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
60753       - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
60754       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
60755       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
60756       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
60757       - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM
60758       - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
60759     required:
60760     - service-instance-id
60761     properties:
60762       service-instance-id:
60763         type: string
60764         description: Uniquely identifies this instance of a service
60765       service-instance-name:
60766         type: string
60767         description: This field will store a name assigned to the service-instance.
60768       persona-model-id:
60769         type: string
60770         description: the ASDC model id for this resource or service model.
60771       persona-model-version:
60772         type: string
60773         description: the ASDC model version for this resource or service model.
60774       model-version-id:
60775         type: string
60776         description: the ASDC model version for this resource or service model.
60777       widget-model-id:
60778         type: string
60779         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
60780       widget-model-version:
60781         type: string
60782         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
60783       bandwidth-total:
60784         type: string
60785         description: Indicates the total bandwidth to be used for this service.
60786       bandwidth-up-wan1:
60787         type: string
60788         description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
60789       bandwidth-down-wan1:
60790         type: string
60791         description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
60792       bandwidth-up-wan2:
60793         type: string
60794         description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
60795       bandwidth-down-wan2:
60796         type: string
60797         description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
60798       vhn-portal-url:
60799         type: string
60800         description: URL customers will use to access the vHN Portal.
60801       service-instance-location-id:
60802         type: string
60803         description: An identifier that customers assign to the location where this service is being used.
60804       resource-version:
60805         type: string
60806         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60807       selflink:
60808         type: string
60809         description: Path to the controller object.
60810       orchestration-status:
60811         type: string
60812         description: Orchestration status of this service.
60813       relationship-list:
60814         type: array
60815         items:
60816           $ref: "#/getDefinitions/relationship"
60817       metadata:
60818         type: array
60819         items:
60820           $ref: "#/getDefinitions/metadatum"
60821       allotted-resources:
60822         type: array
60823         items:
60824           $ref: "#/getDefinitions/allotted-resource"
60825   service-instances:
60826     description: |
60827       Collection of service instances
60828     properties:
60829       service-instance:
60830         type: array
60831         items:
60832           $ref: "#/getDefinitions/service-instance"
60833   service-subscription:
60834     description: |
60835       Object that group service instances.
60836       ###### Related Nodes
60837       - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
60838       - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
60839       - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
60840       - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE
60841     required:
60842     - service-type
60843     properties:
60844       service-type:
60845         type: string
60846         description: Value defined by orchestration to identify this service across ECOMP.
60847       temp-ub-sub-account-id:
60848         type: string
60849         description: This property will be deleted from A&AI in the near future. Only stop gap solution.
60850       resource-version:
60851         type: string
60852         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60853       service-instances:
60854         type: array
60855         items:
60856           $ref: "#/getDefinitions/service-instance"
60857       relationship-list:
60858         type: array
60859         items:
60860           $ref: "#/getDefinitions/relationship"
60861   service-subscriptions:
60862     description: |
60863       Collection of objects that group service instances.
60864     properties:
60865       service-subscription:
60866         type: array
60867         items:
60868           $ref: "#/getDefinitions/service-subscription"
60869   services:
60870     description: |
60871       Collection of service model definitions.  Likely to be deprecated in favor of models from ASDC.
60872     properties:
60873       service:
60874         type: array
60875         items:
60876           $ref: "#/getDefinitions/service"
60877   site-pair:
60878     description: |
60879       ###### Related Nodes
60880       - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
60881       - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
60882       - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE
60883     required:
60884     - site-pair-id
60885     properties:
60886       site-pair-id:
60887         type: string
60888         description: unique identifier of probe
60889       source-ip:
60890         type: string
60891         description: Prefix address
60892       destination-ip:
60893         type: string
60894         description: Prefix address
60895       ip-version:
60896         type: string
60897         description: ip version, v4, v6
60898       destination-hostname:
60899         type: string
60900         description: Hostname of the destination equipment to which SLAs are measured against.
60901       destination-equip-type:
60902         type: string
60903         description: The type of destinatination equipment. Could be Router, etc.
60904       resource-version:
60905         type: string
60906         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60907       classes-of-service:
60908         type: array
60909         items:
60910           $ref: "#/getDefinitions/class-of-service"
60911       relationship-list:
60912         type: array
60913         items:
60914           $ref: "#/getDefinitions/relationship"
60915   site-pair-set:
60916     description: |
60917       Set of instances for probes used to measure service level agreements
60918       ###### Related Nodes
60919       - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
60920       - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
60921       - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE
60922     required:
60923     - site-pair-set-id
60924     properties:
60925       site-pair-set-id:
60926         type: string
60927         description: Unique id of site pair set.
60928       resource-version:
60929         type: string
60930         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60931       routing-instances:
60932         type: array
60933         items:
60934           $ref: "#/getDefinitions/routing-instance"
60935       relationship-list:
60936         type: array
60937         items:
60938           $ref: "#/getDefinitions/relationship"
60939   site-pair-sets:
60940     description: |
60941       Collection of sets of instances for probes related to generic-vnf
60942     properties:
60943       site-pair-set:
60944         type: array
60945         items:
60946           $ref: "#/getDefinitions/site-pair-set"
60947   site-pairs:
60948     description: |
60949       probe within a set
60950     properties:
60951       site-pair:
60952         type: array
60953         items:
60954           $ref: "#/getDefinitions/site-pair"
60955   snapshot:
60956     description: |
60957       Openstack snapshot
60958       ###### Related Nodes
60959       - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
60960       - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
60961     required:
60962     - snapshot-id
60963     properties:
60964       snapshot-id:
60965         type: string
60966         description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
60967       snapshot-name:
60968         type: string
60969         description: Snapshot name
60970       snapshot-architecture:
60971         type: string
60972         description: Operating system architecture
60973       snapshot-os-distro:
60974         type: string
60975         description: The common name of the operating system distribution in lowercase
60976       snapshot-os-version:
60977         type: string
60978         description: The operating system version as specified by the distributor.
60979       application:
60980         type: string
60981         description: The application that the image instantiates.
60982       application-vendor:
60983         type: string
60984         description: The vendor of the application.
60985       application-version:
60986         type: string
60987         description: The version of the application.
60988       snapshot-selflink:
60989         type: string
60990         description: URL to endpoint where AAI can get more details
60991       prev-snapshot-id:
60992         type: string
60993         description: This field contains the UUID of the previous snapshot (if any).
60994       resource-version:
60995         type: string
60996         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60997       relationship-list:
60998         type: array
60999         items:
61000           $ref: "#/getDefinitions/relationship"
61001   snapshots:
61002     description: |
61003       Collection of openstack snapshots
61004     properties:
61005       snapshot:
61006         type: array
61007         items:
61008           $ref: "#/getDefinitions/snapshot"
61009   sriov-pf:
61010     description: |
61011       SR-IOV Physical Function
61012       ###### Related Nodes
61013       - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
61014       - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
61015     required:
61016     - pf-pci-id
61017     properties:
61018       pf-pci-id:
61019         type: string
61020         description: Identifier for the sriov-pf
61021       resource-version:
61022         type: string
61023         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61024       relationship-list:
61025         type: array
61026         items:
61027           $ref: "#/getDefinitions/relationship"
61028   sriov-pfs:
61029     description: |
61030       Collection of SR-IOV Physical Functions.
61031     properties:
61032       sriov-pf:
61033         type: array
61034         items:
61035           $ref: "#/getDefinitions/sriov-pf"
61036   sriov-vf:
61037     description: |
61038       SR-IOV Virtual Function (not to be confused with virtual network function)
61039       ###### Related Nodes
61040       - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
61041     required:
61042     - pci-id
61043     properties:
61044       pci-id:
61045         type: string
61046         description: PCI ID used to identify the sriov-vf
61047       vf-vlan-filter:
61048         type: string
61049         description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
61050       vf-mac-filter:
61051         type: string
61052         description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
61053       vf-vlan-strip:
61054         type: boolean
61055         description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
61056       vf-vlan-anti-spoof-check:
61057         type: boolean
61058         description: This option ensures anti VLAN spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.
61059       vf-mac-anti-spoof-check:
61060         type: boolean
61061         description: This option ensures anti MAC spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.
61062       vf-mirrors:
61063         type: string
61064         description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
61065       vf-broadcast-allow:
61066         type: boolean
61067         description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
61068       vf-unknown-multicast-allow:
61069         type: boolean
61070         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
61071       vf-unknown-unicast-allow:
61072         type: boolean
61073         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
61074       vf-insert-stag:
61075         type: boolean
61076         description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
61077       vf-link-status:
61078         type: string
61079         description: This option is used to set the link status.  Valid values as of 1607 are on, off, and auto.
61080       resource-version:
61081         type: string
61082         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61083       neutron-network-id:
61084         type: string
61085         description: Neutron network id of the interface
61086       relationship-list:
61087         type: array
61088         items:
61089           $ref: "#/getDefinitions/relationship"
61090   sriov-vfs:
61091     description: |
61092       Collection of SR-IOV Virtual Functions.
61093     properties:
61094       sriov-vf:
61095         type: array
61096         items:
61097           $ref: "#/getDefinitions/sriov-vf"
61098   start-node-filter:
61099     properties:
61100       property-name:
61101         type: string
61102       property-value:
61103         type: string
61104   subnet:
61105     description: |
61106       ###### Related Nodes
61107       - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
61108       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
61109       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
61110       - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
61111     required:
61112     - subnet-id
61113     - dhcp-enabled
61114     properties:
61115       subnet-id:
61116         type: string
61117         description: Subnet ID, should be UUID.
61118       subnet-name:
61119         type: string
61120         description: Name associated with the subnet.
61121       neutron-subnet-id:
61122         type: string
61123         description: Neutron id of this subnet
61124       gateway-address:
61125         type: string
61126         description: gateway ip address
61127       network-start-address:
61128         type: string
61129         description: network start address
61130       cidr-mask:
61131         type: string
61132         description: cidr mask
61133       ip-version:
61134         type: string
61135         description: ip version
61136       orchestration-status:
61137         type: string
61138         description: Orchestration status of this VNF, mastered by MSO
61139       dhcp-enabled:
61140         type: boolean
61141       dhcp-start:
61142         type: string
61143         description: the start address reserved for use by dhcp
61144       dhcp-end:
61145         type: string
61146         description: the last address reserved for use by dhcp
61147       resource-version:
61148         type: string
61149         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61150       relationship-list:
61151         type: array
61152         items:
61153           $ref: "#/getDefinitions/relationship"
61154   subnets:
61155     properties:
61156       subnet:
61157         type: array
61158         items:
61159           $ref: "#/getDefinitions/subnet"
61160   tagged-inventory-item-list:
61161     properties:
61162       inventory-item:
61163         type: array
61164         items:
61165           $ref: "#/getDefinitions/inventory-item"
61166   tenant:
61167     description: |
61168       Openstack tenant
61169       ###### Related Nodes
61170       - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
61171       - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
61172       - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
61173       - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
61174       - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
61175       - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
61176       - TENANT cannot be deleted if linked to VSERVER
61177     required:
61178     - tenant-id
61179     - tenant-name
61180     properties:
61181       tenant-id:
61182         type: string
61183         description: Unique id relative to the cloud-region.
61184       tenant-name:
61185         type: string
61186         description: Readable name of tenant
61187       resource-version:
61188         type: string
61189         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61190       vservers:
61191         type: array
61192         items:
61193           $ref: "#/getDefinitions/vserver"
61194       relationship-list:
61195         type: array
61196         items:
61197           $ref: "#/getDefinitions/relationship"
61198   tenants:
61199     description: |
61200       Collection of openstack tenants.
61201     properties:
61202       tenant:
61203         type: array
61204         items:
61205           $ref: "#/getDefinitions/tenant"
61206   tunnel-xconnect:
61207     description: |
61208       Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
61209       ###### Related Nodes
61210       - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
61211     required:
61212     - id
61213     - bandwidth-up-wan1
61214     - bandwidth-down-wan1
61215     - bandwidth-up-wan2
61216     - bandwidth-down-wan2
61217     properties:
61218       id:
61219         type: string
61220         description: Allotted Resource id UUID assigned to this instance.
61221       bandwidth-up-wan1:
61222         type: string
61223         description: The WAN uplink bandwidth for WAN1
61224       bandwidth-down-wan1:
61225         type: string
61226         description: The WAN downlink bandwidth for WAN1
61227       bandwidth-up-wan2:
61228         type: string
61229         description: The WAN uplink bandwidth for WAN2
61230       bandwidth-down-wan2:
61231         type: string
61232         description: The WAN downlink bandwidth for WAN2
61233       resource-version:
61234         type: string
61235         description: Concurrency value
61236       relationship-list:
61237         type: array
61238         items:
61239           $ref: "#/getDefinitions/relationship"
61240   tunnel-xconnects:
61241     description: |
61242       This object is used to store the specific tunnel cross connect aspects of an allotted resource
61243     properties:
61244       tunnel-xconnect:
61245         type: array
61246         items:
61247           $ref: "#/getDefinitions/tunnel-xconnect"
61248   update:
61249     description: |
61250       Serves a PATCH like function.  Does not enforce concurrency control.  Clear each usage with AAI team.
61251     required:
61252     - update-node-type
61253     properties:
61254       update-node-type:
61255         type: string
61256       update-node-key:
61257         type: array
61258         items:
61259           $ref: "#/getDefinitions/update-node-key"
61260       update-node-uri:
61261         type: string
61262       action:
61263         type: array
61264         items:
61265           $ref: "#/getDefinitions/action"
61266   update-node-key:
61267     properties:
61268       key-name:
61269         type: string
61270       key-value:
61271         type: string
61272   vce:
61273     description: |
61274       Virtual Customer Edge Router, used specifically for Gamma.  This object is deprecated.
61275       ###### Related Nodes
61276       - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
61277       - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
61278       - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY)
61279       - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
61280       - FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
61281       - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
61282       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
61283       - VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP
61284     required:
61285     - vnf-id
61286     - vnf-name
61287     - vnf-type
61288     properties:
61289       vnf-id:
61290         type: string
61291         description: Unique id of VNF.  This is unique across the graph.
61292       vnf-name:
61293         type: string
61294         description: Name of VNF.
61295       vnf-name2:
61296         type: string
61297         description: Alternate name of VNF.
61298       vnf-type:
61299         type: string
61300         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
61301       service-id:
61302         type: string
61303         description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
61304       regional-resource-zone:
61305         type: string
61306         description: Regional way of organizing pservers, source of truth should define values
61307       prov-status:
61308         type: string
61309         description: Trigger for operational monitoring of this resource by Service Assurance systems.
61310       operational-state:
61311         type: string
61312         description: Indicator for whether the resource is considered operational
61313       license-key:
61314         type: string
61315         description: OBSOLETE -  do not use
61316       equipment-role:
61317         type: string
61318         description: Network role being played by this VNF
61319       orchestration-status:
61320         type: string
61321         description: Orchestration status of this VNF, mastered by MSO
61322       heat-stack-id:
61323         type: string
61324         description: Heat stack id corresponding to this instance, managed by MSO
61325       mso-catalog-key:
61326         type: string
61327         description: Corresponds to the SDN-C catalog id used to configure this VCE
61328       vpe-id:
61329         type: string
61330         description: Unique ID of VPE connected to this VCE.
61331       v6-vce-wan-address:
61332         type: string
61333         description: Valid v6 IP address for the WAN Link on this router.  Implied length of /64.
61334       ipv4-oam-address:
61335         type: string
61336         description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
61337       resource-version:
61338         type: string
61339         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61340       ipv4-loopback0-address:
61341         type: string
61342         description: Loopback0 address
61343       entitlement-resource-uuid:
61344         type: string
61345         description: OBSOLETE -  see child relationships
61346       port-groups:
61347         type: array
61348         items:
61349           $ref: "#/getDefinitions/port-group"
61350       licenses:
61351         type: array
61352         items:
61353           $ref: "#/getDefinitions/license"
61354       entitlements:
61355         type: array
61356         items:
61357           $ref: "#/getDefinitions/entitlement"
61358       relationship-list:
61359         type: array
61360         items:
61361           $ref: "#/getDefinitions/relationship"
61362   vces:
61363     description: |
61364       Collection of Virtual Customer Edge Routers, used specifically for Gamma.  This object is deprecated.
61365     properties:
61366       vce:
61367         type: array
61368         items:
61369           $ref: "#/getDefinitions/vce"
61370   vf-module:
61371     description: |
61372       a deployment unit of VNFCs
61373       ###### Related Nodes
61374       - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
61375       - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
61376       - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
61377       - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
61378       - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
61379       - VF-MODULE cannot be deleted if linked to VNFC
61380     required:
61381     - vf-module-id
61382     - is-base-vf-module
61383     properties:
61384       vf-module-id:
61385         type: string
61386         description: Unique ID of vf-module.
61387       vf-module-name:
61388         type: string
61389         description: Name of vf-module
61390       heat-stack-id:
61391         type: string
61392         description: Heat stack id corresponding to this instance.
61393       orchestration-status:
61394         type: string
61395         description: orchestration status of this vf-module, mastered by MSO
61396       is-base-vf-module:
61397         type: boolean
61398       resource-version:
61399         type: string
61400         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61401       persona-model-id:
61402         type: string
61403         description: the ASDC model id for this resource or service model.
61404       persona-model-version:
61405         type: string
61406         description: the ASDC model version for this resource or service model.
61407       model-version-id:
61408         type: string
61409         description: the ASDC model version for this resource or service model.
61410       persona-model-customization-id:
61411         type: string
61412         description: captures the id of all the configuration used to customize the resource for the service.
61413       widget-model-id:
61414         type: string
61415         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
61416       widget-model-version:
61417         type: string
61418         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
61419       contrail-service-instance-fqdn:
61420         type: string
61421         description: the Contrail unique ID for a service-instance
61422       module-index:
61423         type: integer
61424         format: int32
61425         description: the index will track the number of modules of a given type that have been deployed in a VNF, starting with 0, and always choosing the lowest available digit
61426       selflink:
61427         type: string
61428         description: Path to the controller object.
61429       relationship-list:
61430         type: array
61431         items:
61432           $ref: "#/getDefinitions/relationship"
61433   vf-modules:
61434     description: |
61435       Collection of vf-modules, a deployment unit of VNFCs
61436     properties:
61437       vf-module:
61438         type: array
61439         items:
61440           $ref: "#/getDefinitions/vf-module"
61441   vig-server:
61442     description: |
61443       vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
61444       ###### Related Nodes
61445       - TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
61446     required:
61447     - vig-address-type
61448     properties:
61449       vig-address-type:
61450         type: string
61451         description: indicates whether the VIG is for AVPN or INTERNET
61452       ipaddress-v4-vig:
61453         type: string
61454         description: v4 IP of the vig server
61455       ipaddress-v6-vig:
61456         type: string
61457         description: v6 IP of the vig server
61458       resource-version:
61459         type: string
61460         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61461       relationship-list:
61462         type: array
61463         items:
61464           $ref: "#/getDefinitions/relationship"
61465   vig-servers:
61466     properties:
61467       vig-server:
61468         type: array
61469         items:
61470           $ref: "#/getDefinitions/vig-server"
61471   vip-ipv4-address-list:
61472     description: |
61473       IPv4 Address Range
61474       ###### Related Nodes
61475       - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
61476       - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
61477       - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
61478       - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
61479     required:
61480     - vip-ipv4-address
61481     properties:
61482       vip-ipv4-address:
61483         type: string
61484         description: IP address
61485       vip-ipv4-prefix-length:
61486         type: integer
61487         format: int64
61488         description: Prefix length, 32 for single address
61489       vlan-id-inner:
61490         type: integer
61491         format: int64
61492         description: Inner VLAN tag
61493       vlan-id-outer:
61494         type: integer
61495         format: int64
61496         description: Outer VLAN tag
61497       is-floating:
61498         type: boolean
61499         description: Indicator of fixed or floating address
61500       resource-version:
61501         type: string
61502         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61503       neutron-network-id:
61504         type: string
61505         description: Neutron network id of the interface that address belongs to
61506       neutron-subnet-id:
61507         type: string
61508         description: Neutron id of subnet that address belongs to
61509       relationship-list:
61510         type: array
61511         items:
61512           $ref: "#/getDefinitions/relationship"
61513   vip-ipv6-address-list:
61514     description: |
61515       IPv6 Address Range
61516       ###### Related Nodes
61517       - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
61518       - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
61519       - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
61520       - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
61521     required:
61522     - vip-ipv6-address
61523     properties:
61524       vip-ipv6-address:
61525         type: string
61526         description: IP address
61527       vip-ipv6-prefix-length:
61528         type: integer
61529         format: int64
61530         description: Prefix length, 128 for single address
61531       vlan-id-inner:
61532         type: integer
61533         format: int64
61534         description: Inner VLAN tag
61535       vlan-id-outer:
61536         type: integer
61537         format: int64
61538         description: Outer VLAN tag
61539       is-floating:
61540         type: boolean
61541         description: Indicator of fixed or floating address
61542       resource-version:
61543         type: string
61544         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61545       neutron-network-id:
61546         type: string
61547         description: Neutron network id of the interface that address belongs to
61548       neutron-subnet-id:
61549         type: string
61550         description: Neutron id of subnet that address belongs to
61551       relationship-list:
61552         type: array
61553         items:
61554           $ref: "#/getDefinitions/relationship"
61555   virtual-data-center:
61556     description: |
61557       Virtual organization of cloud infrastructure elements in a data center context
61558       ###### Related Nodes
61559       - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
61560       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
61561       - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
61562     required:
61563     - vdc-id
61564     - vdc-name
61565     properties:
61566       vdc-id:
61567         type: string
61568         description: Unique ID of the vdc
61569       vdc-name:
61570         type: string
61571         description: Name of the virtual data center
61572       resource-version:
61573         type: string
61574         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61575       relationship-list:
61576         type: array
61577         items:
61578           $ref: "#/getDefinitions/relationship"
61579   virtual-data-centers:
61580     description: |
61581       Virtual organization of cloud infrastructure elements in a data center context
61582     properties:
61583       virtual-data-center:
61584         type: array
61585         items:
61586           $ref: "#/getDefinitions/virtual-data-center"
61587   vlan:
61588     description: |
61589       Definition of vlan
61590       ###### Related Nodes
61591       - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
61592       - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
61593       - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
61594       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
61595       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
61596       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
61597       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
61598       - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
61599       - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK
61600     required:
61601     - vlan-interface
61602     properties:
61603       vlan-interface:
61604         type: string
61605         description: String that identifies the interface
61606       vlan-id-inner:
61607         type: integer
61608         format: int64
61609         description: Inner VLAN tag
61610       vlan-id-outer:
61611         type: integer
61612         format: int64
61613         description: Outer VLAN tag
61614       resource-version:
61615         type: string
61616         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61617       speed-value:
61618         type: string
61619         description: Captures the numeric part of the speed
61620       speed-units:
61621         type: string
61622         description: Captures the units corresponding to the speed
61623       vlan-description:
61624         type: string
61625         description: Used to describe (the service associated with) the vlan
61626       backdoor-connection:
61627         type: string
61628         description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
61629       vpn-id:
61630         type: string
61631         description: This indicates the customers VPN ID associated with this vlan
61632       orchestration-status:
61633         type: string
61634         description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.
61635       relationship-list:
61636         type: array
61637         items:
61638           $ref: "#/getDefinitions/relationship"
61639       l3-interface-ipv4-address-list:
61640         type: array
61641         items:
61642           $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
61643       l3-interface-ipv6-address-list:
61644         type: array
61645         items:
61646           $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
61647   vlans:
61648     properties:
61649       vlan:
61650         type: array
61651         items:
61652           $ref: "#/getDefinitions/vlan"
61653   vnf:
61654     description: |
61655       Abstract vnf class
61656     required:
61657     - vnf-id
61658     properties:
61659       vnf-id:
61660         type: string
61661         description: Unique id of VNF.  This is unique across the graph.
61662   vnf-image:
61663     description: |
61664       Image object that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
61665       ###### Related Nodes
61666       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
61667       - VNF-IMAGE cannot be deleted if linked to GENERIC-VNF
61668     required:
61669     - vnf-image-uuid
61670     - application
61671     - application-vendor
61672     properties:
61673       vnf-image-uuid:
61674         type: string
61675         description: Unique ID of this asset
61676       application:
61677         type: string
61678         description: The application that the image instantiates.
61679       application-vendor:
61680         type: string
61681         description: The vendor of the application.
61682       application-version:
61683         type: string
61684         description: The version of the application.
61685       selflink:
61686         type: string
61687         description: URL to endpoint where AAI can get more details
61688       resource-version:
61689         type: string
61690         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61691       relationship-list:
61692         type: array
61693         items:
61694           $ref: "#/getDefinitions/relationship"
61695   vnf-images:
61696     description: |
61697       Collection of image objects that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
61698     properties:
61699       vnf-image:
61700         type: array
61701         items:
61702           $ref: "#/getDefinitions/vnf-image"
61703   vnfc:
61704     description: |
61705       ###### Related Nodes
61706       - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
61707       - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
61708       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
61709     required:
61710     - vnfc-name
61711     - vnfc-function-code
61712     - vnfc-type
61713     - in-maint
61714     - is-closed-loop-disabled
61715     properties:
61716       vnfc-name:
61717         type: string
61718         description: Unique ID of vnfc.
61719       vnfc-function-code:
61720         type: string
61721         description: function code
61722       vnfc-type:
61723         type: string
61724         description: type
61725       prov-status:
61726         type: string
61727         description: prov status of this vnfc
61728       orchestration-status:
61729         type: string
61730         description: Orchestration status of this VNF, mastered by APP-C
61731       ipaddress-v4-oam-vip:
61732         type: string
61733         description: Oam V4 vip address of this vnfc
61734       in-maint:
61735         type: boolean
61736       is-closed-loop-disabled:
61737         type: boolean
61738       group-notation:
61739         type: string
61740         description: Group notation of VNFC
61741       resource-version:
61742         type: string
61743         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61744       relationship-list:
61745         type: array
61746         items:
61747           $ref: "#/getDefinitions/relationship"
61748   vnfcs:
61749     description: |
61750       virtual network components associated with a vserver from application controller.
61751     properties:
61752       vnfc:
61753         type: array
61754         items:
61755           $ref: "#/getDefinitions/vnfc"
61756   volume:
61757     description: |
61758       Ephemeral Block storage volume.
61759       ###### Related Nodes
61760       - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume)
61761     required:
61762     - volume-id
61763     - volume-selflink
61764     properties:
61765       volume-id:
61766         type: string
61767         description: Unique ID of block storage volume relative to the vserver.
61768       volume-selflink:
61769         type: string
61770         description: URL to endpoint where AAI can get more details
61771       resource-version:
61772         type: string
61773         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61774       relationship-list:
61775         type: array
61776         items:
61777           $ref: "#/getDefinitions/relationship"
61778   volume-group:
61779     description: |
61780       Persistent block-level storage.
61781       ###### Related Nodes
61782       - TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
61783       - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
61784       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
61785       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
61786       - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
61787     required:
61788     - volume-group-id
61789     - volume-group-name
61790     - vnf-type
61791     properties:
61792       volume-group-id:
61793         type: string
61794         description: Unique ID of volume-group.
61795       volume-group-name:
61796         type: string
61797         description: Name of the volume group.
61798       heat-stack-id:
61799         type: string
61800         description: Heat stack id corresponding to this volume-group
61801       vnf-type:
61802         type: string
61803         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
61804       orchestration-status:
61805         type: string
61806         description: Orchestration status of this volume-group
61807       persona-model-customization-id:
61808         type: string
61809         description: captures the id of all the configuration used to customize the resource for the service.
61810       vf-module-persona-model-customization-id:
61811         type: string
61812         description: helps relate the volume group to the vf-module whose components will require the volume group
61813       resource-version:
61814         type: string
61815         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61816       relationship-list:
61817         type: array
61818         items:
61819           $ref: "#/getDefinitions/relationship"
61820   volume-groups:
61821     description: |
61822       Collection of persistent block-level storage.
61823     properties:
61824       volume-group:
61825         type: array
61826         items:
61827           $ref: "#/getDefinitions/volume-group"
61828   volumes:
61829     description: |
61830       Collection of ephemeral Block storage volumes.
61831     properties:
61832       volume:
61833         type: array
61834         items:
61835           $ref: "#/getDefinitions/volume"
61836   vpls-pe:
61837     description: |
61838       VPLS Provider Edge routers.
61839       ###### Related Nodes
61840       - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
61841       - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
61842       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
61843       - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
61844       - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
61845     required:
61846     - equipment-name
61847     properties:
61848       equipment-name:
61849         type: string
61850       prov-status:
61851         type: string
61852         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
61853       ipv4-oam-address:
61854         type: string
61855         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by VPE (v4-loopback0-ip-address).
61856       equipment-role:
61857         type: string
61858         description: Client should send valid enumerated value, e.g., VPLS-PE.
61859       vlan-id-outer:
61860         type: integer
61861         format: int64
61862         description: Temporary location for stag to get to VCE
61863       resource-version:
61864         type: string
61865         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61866       relationship-list:
61867         type: array
61868         items:
61869           $ref: "#/getDefinitions/relationship"
61870       p-interfaces:
61871         type: array
61872         items:
61873           $ref: "#/getDefinitions/p-interface"
61874       lag-interfaces:
61875         type: array
61876         items:
61877           $ref: "#/getDefinitions/lag-interface"
61878   vpls-pes:
61879     description: |
61880       Collection of VPLS Provider Edge routers
61881     properties:
61882       vpls-pe:
61883         type: array
61884         items:
61885           $ref: "#/getDefinitions/vpls-pe"
61886   vpn-binding:
61887     description: |
61888       VPN binding
61889       ###### Related Nodes
61890       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
61891       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
61892       - VPN-BINDING cannot be deleted if linked to L3-NETWORK,LOGICAL-LINK
61893     required:
61894     - vpn-id
61895     - vpn-name
61896     - global-route-target
61897     - route-target-role
61898     properties:
61899       vpn-id:
61900         type: string
61901         description: VPN ID, globally unique within A&AI
61902       vpn-name:
61903         type: string
61904         description: VPN Name
61905       global-route-target:
61906         type: string
61907         description: Number used to identify a VPN, globally unique in the network
61908       vpn-platform:
61909         type: string
61910         description: the platform associated with the VPN example AVPN, Mobility
61911       vpn-type:
61912         type: string
61913         description: Type of the vpn, should be taken from enumerated/valid values
61914       route-distinguisher:
61915         type: string
61916         description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
61917       route-target-role:
61918         type: string
61919         description: Role assigned to this route target
61920       resource-version:
61921         type: string
61922         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61923       relationship-list:
61924         type: array
61925         items:
61926           $ref: "#/getDefinitions/relationship"
61927         description: l3-networks relate to vpn-bindings
61928   vpn-bindings:
61929     properties:
61930       vpn-binding:
61931         type: array
61932         items:
61933           $ref: "#/getDefinitions/vpn-binding"
61934   vserver:
61935     description: |
61936       Virtual Servers, aka virtual machine or VM.
61937       ###### Related Nodes
61938       - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
61939       - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
61940       - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
61941       - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
61942       - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
61943       - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY)
61944       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
61945       - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY)
61946       - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
61947       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
61948       - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
61949       - VSERVER is DELETED when these are DELETED L-INTERFACE
61950       - VSERVER deletion means associated objects of these types are also DELETED:VOLUME
61951     required:
61952     - vserver-id
61953     - vserver-name
61954     - vserver-selflink
61955     - in-maint
61956     - is-closed-loop-disabled
61957     properties:
61958       vserver-id:
61959         type: string
61960         description: Unique identifier for this vserver relative to its tenant
61961       vserver-name:
61962         type: string
61963         description: Name of vserver
61964       vserver-name2:
61965         type: string
61966         description: Alternative name of vserver
61967       prov-status:
61968         type: string
61969         description: Trigger for operational monitoring of this resource by Service Assurance systems.
61970       vserver-selflink:
61971         type: string
61972         description: URL to endpoint where AAI can get more details
61973       in-maint:
61974         type: boolean
61975       is-closed-loop-disabled:
61976         type: boolean
61977       resource-version:
61978         type: string
61979         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61980       volumes:
61981         type: array
61982         items:
61983           $ref: "#/getDefinitions/volume"
61984       relationship-list:
61985         type: array
61986         items:
61987           $ref: "#/getDefinitions/relationship"
61988       l-interfaces:
61989         type: array
61990         items:
61991           $ref: "#/getDefinitions/l-interface"
61992   vservers:
61993     description: |
61994       Collection of virtual Servers, aka virtual machines or VMs.
61995     properties:
61996       vserver:
61997         type: array
61998         items:
61999           $ref: "#/getDefinitions/vserver"
62000   zone:
62001     description: |
62002       A zone is a grouping of assets in a location homing to the same connections into the CBB
62003       ###### Related Nodes
62004       - TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
62005       - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
62006       - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
62007       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
62008     required:
62009     - zone-id
62010     - zone-name
62011     - design-type
62012     - zone-context
62013     properties:
62014       zone-id:
62015         type: string
62016         description: Code assigned by AIC to the zone
62017       zone-name:
62018         type: string
62019         description: English name associated with the zone
62020       design-type:
62021         type: string
62022         description: Design of zone [Medium/Large?]
62023       zone-context:
62024         type: string
62025         description: Context of zone [production/test]
62026       status:
62027         type: string
62028         description: Status of a zone.
62029       resource-version:
62030         type: string
62031         description: Concurrency value
62032       relationship-list:
62033         type: array
62034         items:
62035           $ref: "#/getDefinitions/relationship"
62036   zones:
62037     description: |
62038       Collection of zones
62039     properties:
62040       zone:
62041         type: array
62042         items:
62043           $ref: "#/getDefinitions/zone"